Docs for cache.__sizeof__.__self__

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

Description


<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


Attributes


cache.__sizeof__.__self__.__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.__sizeof__.__self__.__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.__sizeof__.__self__.__delattr__ <type 'method-wrapper'> belongs to class <type 'method-wrapper'>
x.__delattr__('name') <==> del x.name

cache.__sizeof__.__self__.__dict__ <type 'dict'> belongs to class <type 'dict'>
dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

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

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

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

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

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

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

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

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

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

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

cache.__sizeof__.__self__.__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.__sizeof__.__self__.__weakref__ <type 'NoneType'> belongs to class <type 'NoneType'>

cache.__sizeof__.__self__.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.__sizeof__.__self__.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.__sizeof__.__self__.disk <class 'gluon.cache.CacheOnDisk'> belongs to class <class 'gluon.cache.CacheOnDisk'>
Disk based cache This is implemented as a key value store where each key corresponds to a single file in disk which is replaced when the value changes. Disk cache provides persistance when web2py is started/stopped but it is slower than `CacheInRam` Values stored in disk cache must be pickable.

cache.__sizeof__.__self__.ram <class 'gluon.cache.CacheInRam'> belongs to class <class 'gluon.cache.CacheInRam'>
Ram based caching This is implemented as global (per process, shared by all threads) dictionary. A mutex-lock mechanism avoid conflicts.

cache.__sizeof__.__self__.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.