duck.utils.caching

Caching module which leverages the use of diskcache python library. Essential methods mandatory to any Cache class: [set, get, delete, clear]

Package Contents

Classes

CacheBase	Base class for caching
CacheSpeedTest	This class performs speed test of Cache classes.
DynamicFileCache	Manages a cache of files, dynamically creating new files when existing ones reach a size limit.
InMemoryCache	InMemoryCache with LRU eviction.
KeyAsFolderCache	Caching which stores cache data in folders with the name of cache keys.
PersistentFileCache	Implementation of caching using the diskcache library

API

class duck.utils.caching.CacheBase

Base class for caching

abstractmethod clear()

Clear all values from the cache.

abstractmethod delete(key: str)

Delete a value from the cache.

abstractmethod get(key: str) → Any

Get a value from the cache. Returns None if the key is not found.

save()

abstractmethod set(key: str, value: Any, expiry: int | float = None)

Set a value in the cache.

class duck.utils.caching.CacheSpeedTest(repeat: int = 1)

This class performs speed test of Cache classes.

Initialization

compare_performance()

execute_all()

static generate_random_string(length)

instances

None

print_summary()

run_test(instance)

test_clear(instance)

test_create(instance)

test_del(instance)

test_get(instance)

test_set(instance)

class duck.utils.caching.DynamicFileCache(cache_dir: str, cache_limit=1000000000.0, cached_objs_limit: int = 128)

Bases: duck.utils.caching.CacheBase

Manages a cache of files, dynamically creating new files when existing ones reach a size limit.

Initialization

_create_new_cache_path()

This retrieves new cache path with a unique name using uuid module.

_get_cache_path() → str

Returns the path to a cache dir that is not at the size limit.

_reload_cache_files()

This reloads existing cache files in a directory.

property cache_obj

Returns the Cache object for the current cache file that is not at its limit.

clear()

Clears all data from the cache.

close()

Close the cache.

delete(key: str)

Delete a key pair from the cache.

get(key: str) → Any

Retrieve cache data.

static get_cache_obj(path: str) → duck.utils.caching.PersistentFileCache

set(key: str, data: Any, expiry: float | int = None)

Set cache data with persistence.

class duck.utils.caching.InMemoryCache(maxkeys=None, *_)

Bases: duck.utils.caching.CacheBase

InMemoryCache with LRU eviction.

Initialization

clear()

close()

delete(key: str)

get(key: str, default: Any = None, pop: bool = False) → Any

Get a value from the cache.

has(key: str)

set(key: str, value: Any, expiry=None)

Set a value in the cache.

class duck.utils.caching.KeyAsFolderCache(cache_dir: str)

Bases: duck.utils.caching.CacheBase

Caching which stores cache data in folders with the name of cache keys.

Initialization

clear()

Clear all data from the cache.

close()

Closes the cache.

delete(key: str)

Delete a key pair from the cache.

get(key: str) → Any

This lookup for a folder in cache_dir with the name of the parsed key and returns the cache data.

static get_cache_files(d: str)

This gets the directories in cache_dir.

static get_cache_obj(path: str) → duck.utils.caching.PersistentFileCache

set(key: str, data: Any, expiry: int | float = None)

Set some cache data.

class duck.utils.caching.PersistentFileCache(path: str, cache_size: int = None)

Bases: duck.utils.caching.CacheBase

Implementation of caching using the diskcache library

Initialization

clear()

Clears all data from the cache.

close()

This closes the cache.

property closed

Checks whether the cache is closed.

delete(key: str)

Delete a key from the cache.

get(key: str)

Retrieves the key value from cache.

set(key: str, _obj: Any, expiry: int | float = None)

Sets the cache with an optional expiry in seconds.