cement.core.cache

Cement core cache module.

class cement.core.cache.CacheHandler(**kw: Any)

Bases: CacheInterface, Handler

Cache handler implementation.

class Meta

Bases: Meta

class cement.core.cache.CacheInterface(**kw: Any)

Bases: Interface

This class defines the Cache Interface. Handlers that implement this interface must provide the methods and attributes defined below. In general, most implementations should sub-class from the provided CacheHandler base class as a starting point.

class Meta

Bases: Meta

Handler meta-data.

interface: str = 'cache'

The string identifier of the interface.

abstractmethod delete(key: str) → bool

Deletes a key/value from the cache.

Parameters:

key – The key in the cache to delete

Returns:

True if the key is successfully deleted, False otherwise

Return type:

bool

abstractmethod get(key: str, fallback: Any = None) → Any

Get the value for a key in the cache.

If the key does not exist or the key/value in cache is expired, this functions must return fallback (which in turn must default to None).

Parameters:

key (str) – The key of the value stored in cache

Keyword Arguments:

fallback – Optional value that is returned if the cache is expired or the key does not exist.

Returns:

Whatever the value is in the cache, or the fallback

Return type:

Unknown

abstractmethod purge() → None

Clears all data from the cache.

abstractmethod set(key: str, value: Any, time: int | None = None) → None

Set the key/value in the cache for a set amount of time.

Parameters:

• key (str) – The key of the value to store in cache

• value (unknown) – The value of that key to store in cache

Keyword Arguments:

time (int) – A one-off expire time in seconds (or None. If no time is given, then a default value is used (determined by the implementation).

Returns: None