mako.cache.CacheImpl

class documentation

class CacheImpl: (source)

Known subclasses: mako.ext.beaker_cache.BeakerCacheImpl, mako.testing.fixtures.PlainCacheImpl

View In Hierarchy

Provide a cache implementation for use by :class:`.Cache`.

Method __init__ Undocumented
Method get Retrieve a value from the cache.
Method get_or_create Retrieve a value from the cache, using the given creation function to generate a new value.
Method invalidate Invalidate a value in the cache.
Method set Place a value in the cache.
Class Variable pass_context If ``True``, the :class:`.Context` will be passed to :meth:`get_or_create <.CacheImpl.get_or_create>` as the name ``'context'``.
Instance Variable cache Undocumented
def __init__(self, cache): (source)
overridden in mako.ext.beaker_cache.BeakerCacheImpl, mako.testing.fixtures.PlainCacheImpl

Undocumented

def get(self, key, **kw): (source)
overridden in mako.ext.beaker_cache.BeakerCacheImpl, mako.testing.fixtures.PlainCacheImpl

Retrieve a value from the cache. :param key: the value's key. :param \**kw: cache configuration arguments.

def get_or_create(self, key, creation_function, **kw): (source)
overridden in mako.ext.beaker_cache.BeakerCacheImpl, mako.testing.fixtures.PlainCacheImpl

Retrieve a value from the cache, using the given creation function to generate a new value. This function *must* return a value, either from the cache, or via the given creation function. If the creation function is called, the newly created value should be populated into the cache under the given key before being returned. :param key: the value's key. :param creation_function: function that when called generates a new value. :param \**kw: cache configuration arguments.

def invalidate(self, key, **kw): (source)
overridden in mako.ext.beaker_cache.BeakerCacheImpl, mako.testing.fixtures.PlainCacheImpl

Invalidate a value in the cache. :param key: the value's key. :param \**kw: cache configuration arguments.

def set(self, key, value, **kw): (source)

Place a value in the cache. :param key: the value's key. :param value: the value. :param \**kw: cache configuration arguments.

pass_context: bool = (source)

If ``True``, the :class:`.Context` will be passed to :meth:`get_or_create <.CacheImpl.get_or_create>` as the name ``'context'``.

cache = (source)
overridden in mako.testing.fixtures.PlainCacheImpl

Undocumented