werkzeug.datastructures.Accept

class documentation

class Accept(ImmutableList):

Known subclasses: werkzeug.datastructures.CharsetAccept, werkzeug.datastructures.LanguageAccept, werkzeug.datastructures.MIMEAccept

View In Hierarchy

An Accept object is just a list subclass for lists of (value, quality) tuples. It is automatically sorted by specificity and quality.

All Accept objects work similar to a list but provide extra functionality for working with the data. Containment checks are normalized to the rules of that header:

>>> a = CharsetAccept([('ISO-8859-1', 1), ('utf-8', 0.7)])
>>> a.best
'ISO-8859-1'
>>> 'iso-8859-1' in a
True
>>> 'UTF8' in a
True
>>> 'utf7' in a
False

To get the quality for an item you can use normal item lookup:

>>> print a['utf-8']
0.7
>>> a['utf7']
0

Changed in version 0.5: Accept objects are forced immutable now.

Changed in version 1.0.0: Accept internal values are no longer ordered alphabetically for equal quality tags. Instead the initial order is preserved.

Method	`__contains__`	Undocumented
Method	`__getitem__`	Besides index lookup (getting item n) you can also pass it a string to get the quality for the item. If the item is not in the list, the returned quality is `0`.
Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`best_match`	Returns the best match from a list of possible matches based on the specificity and quality of the client. If two items have the same quality and specificity, the one is returned that comes first.
Method	`find`	Get the position of an entry or return -1.
Method	`index`	Get the position of an entry or raise `ValueError`.
Method	`quality`	Returns the quality of the key.
Method	`to_header`	Convert the header set into an HTTP header string.
Method	`values`	Iterate over all values.
Instance Variable	`provided`	Undocumented
Property	`best`	The best match as value.
Method	`_best_single_match`	Undocumented
Method	`_specificity`	Returns a tuple describing the value's specificity.
Method	`_value_matches`	Check if a value matches a given accept item.

Inherited from ImmutableListMixin (via ImmutableList):

Method	`__delitem__`	Undocumented
Method	`__hash__`	Undocumented
Method	`__iadd__`	Undocumented
Method	`__imul__`	Undocumented
Method	`__reduce_ex__`	Undocumented
Method	`__setitem__`	Undocumented
Method	`append`	Undocumented
Method	`extend`	Undocumented
Method	`insert`	Undocumented
Method	`pop`	Undocumented
Method	`remove`	Undocumented
Method	`reverse`	Undocumented
Method	`sort`	Undocumented
Instance Variable	`_hash_cache`	Undocumented

def __contains__(self, value):

Undocumented

def __getitem__(self, key):

Besides index lookup (getting item n) you can also pass it a string to get the quality for the item. If the item is not in the list, the returned quality is 0.

def __init__(self, values=()):

Undocumented

def __repr__(self):

overrides werkzeug.datastructures.ImmutableList.__repr__

Undocumented

def __str__(self):

Undocumented

def best_match(self, matches, default=None):

overridden in werkzeug.datastructures.LanguageAccept

Returns the best match from a list of possible matches based on the specificity and quality of the client. If two items have the same quality and specificity, the one is returned that comes first.

Parameters
matches	a list of matches to check for
default	the value that is returned if none match

def find(self, key):

Get the position of an entry or return -1.

Parameters
key	The key to be looked up.

def index(self, key):

Get the position of an entry or raise ValueError.

Changed in version 0.5: This used to raise IndexError, which was inconsistent with the list API.

Parameters
key	The key to be looked up.

def quality(self, key):

Returns the quality of the key.

New in version 0.6: In previous versions you had to use the item-lookup syntax (eg: obj[key] instead of obj.quality(key))

def to_header(self):

Convert the header set into an HTTP header string.

def values(self):

Iterate over all values.

provided: bool =

Undocumented

@property
best =

The best match as value.

def _best_single_match(self, match):

Undocumented

def _specificity(self, value):

overridden in werkzeug.datastructures.MIMEAccept

Returns a tuple describing the value's specificity.

def _value_matches(self, value, item):

overridden in werkzeug.datastructures.CharsetAccept, werkzeug.datastructures.LanguageAccept, werkzeug.datastructures.MIMEAccept

Check if a value matches a given accept item.