werkzeug.datastructures

module documentation

Undocumented

Class ​Accept An Accept object is just a list subclass for lists of (value, quality) tuples. It is automatically sorted by specificity and quality.
Class ​Authorization Represents an Authorization header sent by the client.
Class ​Callback​Dict A dict that calls a function passed every time something is changed. The function is passed the dict instance.
Class ​Charset​Accept Like Accept but with normalization for charsets.
Class ​Combined​Multi​Dict A read only MultiDict that you can pass multiple MultiDict instances as sequence and it will combine the return values of all wrapped dicts:
Class ​Content​Range Represents the content range header.
Class ​Content​Security​Policy Subclass of a dict that stores values for a Content Security Policy header. It has accessors for all the level 3 policies.
Class ​Environ​Headers Read only version of the headers from a WSGI environment. This provides the same interface as Headers and is constructed from a WSGI environment.
Class ​ETags A set that can be used to check if one etag is present in a collection of etags.
Class ​File​Multi​Dict A special MultiDict that has convenience methods to add files to it. This is used for EnvironBuilder and generally useful for unittesting.
Class ​File​Storage No summary
Class ​Headers An object that stores some headers. It has a dict-like interface, but is ordered, can store the same key multiple times, and iterating yields (key, value) pairs instead of only keys.
Class ​Header​Set Similar to the ETags class this implements a set-like structure. Unlike ETags this is case insensitive and used for vary, allow, and content-language headers.
Class ​If​Range Very simple object that represents the If-Range header in parsed form. It will either have neither a etag or date or one of either but never both.
Class ​Immutable​Dict An immutable dict.
Class ​Immutable​Dict​Mixin Makes a dict immutable.
Class ​Immutable​Headers​Mixin Makes a Headers immutable. We do not mark them as hashable though since the only usecase for this datastructure in Werkzeug is a view on a mutable structure.
Class ​Immutable​List An immutable list.
Class ​Immutable​List​Mixin Makes a list immutable.
Class ​Immutable​Multi​Dict An immutable MultiDict.
Class ​Immutable​Multi​Dict​Mixin Makes a MultiDict immutable.
Class ​Immutable​Ordered​Multi​Dict An immutable OrderedMultiDict.
Class ​Immutable​Type​Conversion​Dict Works like a TypeConversionDict but does not support modifications.
Class ​Language​Accept Like Accept but with normalization for language tags.
Class ​MIMEAccept Like Accept but with special methods and behavior for mimetypes.
Class ​Multi​Dict No summary
Class ​Ordered​Multi​Dict Works like a regular MultiDict but preserves the order of the fields. To convert the ordered multi dict into a list you can use the items method and pass it multi=True.
Class ​Range Represents a Range header. All methods only support only bytes as the unit. Stores a list of ranges if given, but the methods only work if only one range is provided.
Class ​Request​Cache​Control A cache control for requests. This is immutable and gives access to all the request-relevant cache control headers.
Class ​Response​Cache​Control A cache control for responses. Unlike RequestCacheControl this is mutable and gives access to response-relevant cache control headers.
Class ​Type​Conversion​Dict Works like a regular dict but the get method can perform type conversions. MultiDict and CombinedMultiDict are subclasses of this class and provide the same feature.
Class ​Update​Dict​Mixin Makes dicts call self.on_update on modifications.
Class ​WWWAuthenticate Provides simple access to WWW-Authenticate headers.
Function auth​_property A static helper function for Authentication subclasses to add extra authentication system properties onto a class:
Function cache​_control​_property Return a new property object for a cache header. Useful if you want to add support for a cache extension in a subclass.
Function cache​_property Undocumented
Function csp​_property Return a new property object for a content security policy header. Useful if you want to add support for a csp extension in a subclass.
Function is​_immutable Undocumented
Function iter​_multi​_items Iterates over the items of a mapping yielding keys and values without dropping any from more complex structures.
Class _​Cache​Control Subclass of a dict that stores values for a Cache-Control header. It has accessors for all the cache-control directives specified in RFC 2616. The class does not differentiate between request and response directives.
Class ​_omd​_bucket No summary
Function ​_callback​_property Undocumented
Function ​_calls​_update Undocumented
Function ​_normalize​_lang Process a language tag for matching.
Function ​_normalize​_mime Undocumented
Function ​_options​_header​_vkw Undocumented
Function ​_set​_property Undocumented
Function ​_unicodify​_header​_value Undocumented
Variable ​_locale​_delim​_re Undocumented
Variable ​_mime​_split​_re Undocumented
def auth_property(name, doc=None):

A static helper function for Authentication subclasses to add extra authentication system properties onto a class:

class FooAuthenticate(WWWAuthenticate):
    special_realm = auth_property('special_realm')

For more information have a look at the sourcecode to see how the regular properties (realm etc.) are implemented.

def cache_control_property(key, empty, type):

Return a new property object for a cache header. Useful if you want to add support for a cache extension in a subclass.

Changed in version 2.0: Renamed from cache_property.
def cache_property(key, empty, type):

Undocumented

def csp_property(key):
Return a new property object for a content security policy header. Useful if you want to add support for a csp extension in a subclass.
def is_immutable(self):

Undocumented

def iter_multi_items(mapping):
Iterates over the items of a mapping yielding keys and values without dropping any from more complex structures.
def _callback_property(name):

Undocumented

def _calls_update(name):

Undocumented

def _normalize_lang(value):
Process a language tag for matching.
def _normalize_mime(value):

Undocumented

def _options_header_vkw(value, kw):

Undocumented

def _set_property(name, doc=None):

Undocumented

def _unicodify_header_value(value):

Undocumented

_locale_delim_re =

Undocumented

_mime_split_re =

Undocumented