Docs for cache.action

[ Python Tutorial ] [ Python Libraries ] [ web2py epydoc ]

Description

Better fit for caching an action

        Warning:
            Experimental!

        Currently only HTTP 1.1 compliant
        reference : http://code.google.com/p/doctype-mirror/wiki/ArticleHttpCaching

        Args:
            time_expire(int): same as @cache
            cache_model(str): same as @cache
            prefix(str): add a prefix to the calculated key
            session(bool): adds response.session_id to the key
            vars(bool): adds request.env.query_string
            lang(bool): adds T.accepted_language
            user_agent(bool or dict): if True, adds is_mobile and is_tablet to the key.
                Pass a dict to use all the needed values (uses str(.items()))
                (e.g. user_agent=request.user_agent()). Used only if session is
                not True
            public(bool): if False forces the Cache-Control to be 'private'
            valid_statuses: by default only status codes starting with 1,2,3 will be cached.
                pass an explicit list of statuses on which turn the cache on
            quick: Session,Vars,Lang,User-agent,Public:
                fast overrides with initials, e.g. 'SVLP' or 'VLP', or 'VLP'

Attributes


cache.action.__call__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__call__(...) <==> x(...)

cache.action.__class__	<type 'type'> extends (<type 'object'>,) belongs to class <type 'type'> instancemethod(function, instance, class) Create an instance method object.

cache.action.__cmp__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__cmp__(y) <==> cmp(x,y)

cache.action.__delattr__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__delattr__('name') <==> del x.name

cache.action.__doc__	<type 'str'> belongs to class <type 'str'> str(object='') -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

cache.action.__format__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> default object formatter

cache.action.__func__	<type 'function'> belongs to class <type 'function'> Better fit for caching an action Warning: Experimental! Currently only HTTP 1.1 compliant reference : http://code.google.com/p/doctype-mirror/wiki/ArticleHttpCaching Args: time_expire(int): same as @cache cache_model(str): same as @cache prefix(str): add a prefix to the calculated key session(bool): adds response.session_id to the key vars(bool): adds request.env.query_string lang(bool): adds T.accepted_language user_agent(bool or dict): if True, adds is_mobile and is_tablet to the key. Pass a dict to use all the needed values (uses str(.items())) (e.g. user_agent=request.user_agent()). Used only if session is not True public(bool): if False forces the Cache-Control to be 'private' valid_statuses: by default only status codes starting with 1,2,3 will be cached. pass an explicit list of statuses on which turn the cache on quick: Session,Vars,Lang,User-agent,Public: fast overrides with initials, e.g. 'SVLP' or 'VLP', or 'VLP'

cache.action.__get__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> descr.__get__(obj[, type]) -> value

cache.action.__getattribute__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__getattribute__('name') <==> x.name

cache.action.__hash__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__hash__() <==> hash(x)

cache.action.__init__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__init__(...) initializes x; see help(type(x)) for signature

cache.action.__new__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> T.__new__(S, ...) -> a new object with type S, a subtype of T

cache.action.__reduce__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> helper for pickle

cache.action.__reduce_ex__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> helper for pickle

cache.action.__repr__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__repr__() <==> repr(x)

cache.action.__self__	<class 'gluon.cache.Cache'> belongs to class <class 'gluon.cache.Cache'> Sets up generic caching, creating an instance of both CacheInRam and CacheOnDisk. In case of GAE will make use of gluon.contrib.gae_memcache. - self.ram is an instance of CacheInRam - self.disk is an instance of CacheOnDisk

cache.action.__setattr__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__setattr__('name', value) <==> x.name = value

cache.action.__sizeof__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> __sizeof__() -> int size of object in memory, in bytes

cache.action.__str__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__str__() <==> str(x)

cache.action.__subclasshook__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> Abstract classes can override this to customize issubclass(). This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

cache.action.im_class	<type 'type'> extends (<type 'object'>,) belongs to class <type 'type'> Sets up generic caching, creating an instance of both CacheInRam and CacheOnDisk. In case of GAE will make use of gluon.contrib.gae_memcache. - self.ram is an instance of CacheInRam - self.disk is an instance of CacheOnDisk

cache.action.im_func	<type 'function'> belongs to class <type 'function'> Better fit for caching an action Warning: Experimental! Currently only HTTP 1.1 compliant reference : http://code.google.com/p/doctype-mirror/wiki/ArticleHttpCaching Args: time_expire(int): same as @cache cache_model(str): same as @cache prefix(str): add a prefix to the calculated key session(bool): adds response.session_id to the key vars(bool): adds request.env.query_string lang(bool): adds T.accepted_language user_agent(bool or dict): if True, adds is_mobile and is_tablet to the key. Pass a dict to use all the needed values (uses str(.items())) (e.g. user_agent=request.user_agent()). Used only if session is not True public(bool): if False forces the Cache-Control to be 'private' valid_statuses: by default only status codes starting with 1,2,3 will be cached. pass an explicit list of statuses on which turn the cache on quick: Session,Vars,Lang,User-agent,Public: fast overrides with initials, e.g. 'SVLP' or 'VLP', or 'VLP'

cache.action.im_self	<class 'gluon.cache.Cache'> belongs to class <class 'gluon.cache.Cache'> Sets up generic caching, creating an instance of both CacheInRam and CacheOnDisk. In case of GAE will make use of gluon.contrib.gae_memcache. - self.ram is an instance of CacheInRam - self.disk is an instance of CacheOnDisk