werkzeug.datastructures._CacheControl

class documentation

class _CacheControl(UpdateDictMixin, dict): (source)

Known subclasses: werkzeug.datastructures.RequestCacheControl, werkzeug.datastructures.ResponseCacheControl

View In Hierarchy

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. Because the cache-control directives in the HTTP header use dashes the python descriptors use underscores for that. To get a header of the :class:`CacheControl` object again you can convert the object into a string or call the :meth:`to_header` method. If you plan to subclass it and add your own items have a look at the sourcecode for that class. .. versionchanged:: 2.1.0 Setting int properties such as ``max_age`` will convert the value to an int. .. versionchanged:: 0.4 Setting `no_cache` or `private` to boolean `True` will set the implicit none-value which is ``*``: >>> cc = ResponseCacheControl() >>> cc.no_cache = True >>> cc <ResponseCacheControl 'no-cache'> >>> cc.no_cache '*' >>> cc.no_cache = None >>> cc <ResponseCacheControl ''> In versions before 0.5 the behavior documented here affected the now no longer existing `CacheControl` class.

Method __init__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method to_header Convert the stored values into a cache control header.
Class Variable cache_property Undocumented
Class Variable max_age Undocumented
Class Variable no_cache Undocumented
Class Variable no_store Undocumented
Class Variable no_transform Undocumented
Instance Variable on_update Undocumented
Instance Variable provided Undocumented
Method _del_cache_value Used internally by the accessor properties.
Method _get_cache_value Used internally by the accessor properties.
Method _set_cache_value Used internally by the accessor properties.

Inherited from UpdateDictMixin:

Method pop Undocumented
Method setdefault Undocumented
Class Variable __delitem__ Undocumented
Class Variable __setitem__ Undocumented
Class Variable clear Undocumented
Class Variable popitem Undocumented
Class Variable update Undocumented
def __init__(self, values=(), on_update=None): (source)

Undocumented

def __repr__(self): (source)

Undocumented

def __str__(self): (source)

Undocumented

def to_header(self): (source)

Convert the stored values into a cache control header.

cache_property = (source)

Undocumented

max_age = (source)

Undocumented

no_cache = (source)

Undocumented

no_store = (source)

Undocumented

no_transform = (source)

Undocumented

on_update = (source)
overrides werkzeug.datastructures.UpdateDictMixin.on_update

Undocumented

provided = (source)

Undocumented

def _del_cache_value(self, key): (source)

Used internally by the accessor properties.

def _get_cache_value(self, key, empty, type): (source)

Used internally by the accessor properties.

def _set_cache_value(self, key, value, type): (source)

Used internally by the accessor properties.