Docs for cache.call

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

Description


        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

Attributes


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

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

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

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

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

cache.__call__.__func__	<type 'function'> belongs to class <type 'function'> 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.__call__.__get__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> descr.__get__(obj[, type]) -> value

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

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

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

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

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

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

cache.__call__.__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.__call__.__setattr__	<type 'method-wrapper'> belongs to class <type 'method-wrapper'> x.__setattr__('name', value) <==> x.name = value

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

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

cache.__call__.__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.__call__.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.__call__.im_func	<type 'function'> belongs to class <type 'function'> 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.__call__.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

Docs for cache.__call__

Description

Attributes

Docs for cache.call