Cement core cache module.
Cache handler implementation.
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
CacheHandlerbase class as a starting point.
The string identifier of the interface.
Deletes a key/value from the cache.
Parameters: key – The key in the cache to delete Returns:
Trueif the key is successfully deleted,
Return type: bool
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
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
Return type: Unknown
Clears all data from the cache.
set(key, value, time=None)¶
Set the key/value in the cache for a set amount of
- key (str) – The key of the value to store in cache
- value (unknown) – The value of that key to store in cache
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).