charset_normalizer.models.CharsetMatches Class Reference

Public Member Functions
	__init__ (self, list[CharsetMatch]|None results=None)
Iterator[CharsetMatch]	__iter__ (self)
CharsetMatch	__getitem__ (self, int|str item)
int	__len__ (self)
bool	__bool__ (self)
None	append (self, CharsetMatch item)
CharsetMatch|None	best (self)
CharsetMatch|None	first (self)

Protected Attributes
	_results

Detailed Description

Container with every CharsetMatch items ordered by default from most probable to the less one.
Act like a list(iterable) but does not implements all related methods.

Member Function Documentation

__getitem__()

CharsetMatch charset_normalizer.models.CharsetMatches.__getitem__	(		self,
		int | str	item
	)

Retrieve a single item either by its position or encoding name (alias may be used here).
Raise KeyError upon invalid index or encoding not present in results.

append()

None charset_normalizer.models.CharsetMatches.append	(		self,
		CharsetMatch	item
	)

Insert a single match. Will be inserted accordingly to preserve sort.
Can be inserted as a submatch.

best()

CharsetMatch | None charset_normalizer.models.CharsetMatches.best

(

self

)

Simply return the first match. Strict equivalent to matches[0].

first()

CharsetMatch | None charset_normalizer.models.CharsetMatches.first

(

self

)

Redundant method, call the method best(). Kept for BC reasons.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/charset_normalizer/models.py