werkzeug.datastructures.Accept

class documentation

class Accept(ImmutableList): (source)

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

View In Hierarchy

An :class:`Accept` object is just a list subclass for lists of ``(value, quality)`` tuples. It is automatically sorted by specificity and quality. All :class:`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 .. versionchanged:: 0.5 :class:`Accept` objects are forced immutable now. .. versionchanged:: 1.0.0 :class:`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 :exc:`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): (source)

Undocumented

def __getitem__(self, key): (source)

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=()): (source)

Undocumented

def __repr__(self): (source)
overrides werkzeug.datastructures.ImmutableList.__repr__

Undocumented

def __str__(self): (source)

Undocumented

def best_match(self, matches, default=None): (source)
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. :param matches: a list of matches to check for :param default: the value that is returned if none match

def find(self, key): (source)

Get the position of an entry or return -1. :param key: The key to be looked up.

def index(self, key): (source)

Get the position of an entry or raise :exc:`ValueError`. :param key: The key to be looked up. .. versionchanged:: 0.5 This used to raise :exc:`IndexError`, which was inconsistent with the list API.

def quality(self, key): (source)

Returns the quality of the key. .. versionadded:: 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): (source)

Convert the header set into an HTTP header string.

def values(self): (source)

Iterate over all values.

provided: bool = (source)

Undocumented

@property
best = (source)

The best match as value.

def _best_single_match(self, match): (source)

Undocumented

def _specificity(self, value): (source)
overridden in werkzeug.datastructures.MIMEAccept

Returns a tuple describing the value's specificity.

def _value_matches(self, value, item): (source)
overridden in werkzeug.datastructures.CharsetAccept, werkzeug.datastructures.LanguageAccept, werkzeug.datastructures.MIMEAccept

Check if a value matches a given accept item.