Docs for cache.class

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

Description

<type 'type'> extends (<type 'object'>,)


    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

Attributes


cache.__class__.__call__	<type 'instancemethod'> belongs to class <type 'instancemethod'> Decorator function that can be used to cache any function/method. Args: key(str) : the key of the object to be store or retrieved time_expire(int) : expiration of the cache in seconds `time_expire` is used to compare the current time with the time when the requested object was last saved in cache. It does not affect future requests. Setting `time_expire` to 0 or negative value forces the cache to refresh. cache_model(str): can be "ram", "disk" or other (like "memcache"). Defaults to "ram" When the function `f` is called, web2py tries to retrieve the value corresponding to `key` from the cache if the object exists and if it did not expire, else it calles the function `f` and stores the output in the cache corresponding to `key`. In the case the output of the function is returned. Example: :: @cache('key', 5000, cache.ram) def f(): return time.ctime() Note: If the function `f` is an action, we suggest using @cache.action instead

cache.__class__.__class__	<type 'type'> extends (<type 'object'>,) belongs to class <type 'type'> type(object) -> the object's type type(name, bases, dict) -> a new type

cache.__class__.__delattr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__delattr__('name') <==> del x.name

cache.__class__.__dict__	<type 'dictproxy'> belongs to class <type 'dictproxy'>

cache.__class__.__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.__class__.__format__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> default object formatter

cache.__class__.__getattribute__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__getattribute__('name') <==> x.name

cache.__class__.__hash__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__hash__() <==> hash(x)

cache.__class__.__init__	<type 'instancemethod'> belongs to class <type 'instancemethod'> Args: request: the global request object

cache.__class__.__module__	<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.__class__.__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.__class__.__reduce__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> helper for pickle

cache.__class__.__reduce_ex__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> helper for pickle

cache.__class__.__repr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__repr__() <==> repr(x)

cache.__class__.__setattr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__setattr__('name', value) <==> x.name = value

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

cache.__class__.__str__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__str__() <==> str(x)

cache.__class__.__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.__class__.__weakref__	<type 'getset_descriptor'> belongs to class <type 'getset_descriptor'> list of weak references to the object (if defined)

cache.__class__.action	<type 'instancemethod'> belongs to class <type 'instancemethod'> 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.__class__.autokey	<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.__class__.with_prefix	<type 'function'> belongs to class <type 'function'> allow replacing cache.ram with cache.with_prefix(cache.ram,'prefix') it will add prefix to all the cache keys used.

Docs for cache.__class__

Description

Attributes

Docs for cache.class