orionis.cache.CacheManager

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

class documentation

class CacheManager(ICacheManager): (source)

Constructor: CacheManager(app)

View In Hierarchy

Undocumented

Method	`__init__`	Initialize the manager and resolve the active cache configuration.
Method	`_buildBackend`	Instantiate and return the raw backend for name.
Method	`_buildDatabaseBackend`	Instantiate and return the database cache backend.
Async Method	`add`	Store value only if key is absent in the default store.
Async Method	`clear`	Remove all entries from the default store.
Async Method	`decrement`	Decrement the integer at key by amount in the default store.
Async Method	`delete`	Remove key from the default store.
Async Method	`get`	Retrieve the value for key from the default store.
Async Method	`getMany`	Retrieve multiple values from the default store.
Async Method	`has`	Check whether key exists and has not expired in the default store.
Async Method	`increment`	Increment the integer at key by amount in the default store.
Method	`lock`	Return an async context-manager lock for key on the default store.
Async Method	`pull`	Return and immediately delete key from the default store.
Async Method	`remember`	Return the cached value for key; resolve and cache if absent.
Async Method	`rememberForever`	Return the cached value for key; resolve and cache forever if absent.
Async Method	`set`	Store value under key in the default store.
Async Method	`setMany`	Store multiple key/value pairs in the default store.
Method	`store`	Return the `CacheRepository` for the named (or default) store.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_app`	Undocumented
Instance Variable	`_base_path`	Undocumented
Instance Variable	`_config`	Undocumented
Instance Variable	`_default`	Undocumented
Instance Variable	`_prefix`	Undocumented
Instance Variable	`_repositories`	Undocumented

def __init__(self, app: IApplication): (source) ¶

Initialize the manager and resolve the active cache configuration.

Parameters
app:`IApplication`	Application container used to read config and the base path.

Returns
`None`	Complete the documented operation without returning a value.

def _buildBackend(self, name: str) -> Any: (source) ¶

Instantiate and return the raw backend for name.

Parameters
name:`str`	Driver name (`'file'`, `'memory'`, `'redis'`, `'memcached'`).

Returns
`Any`	Configured backend instance.

Raises
`CacheStoreException`	When name is `'redis'` or `'memcached'` but the store is not configured.

def _buildDatabaseBackend(self) -> Any: (source) ¶

Instantiate and return the database cache backend.

Returns
`Any`	Configured `DatabaseCacheBackend` instance.

Raises
`CacheStoreException`	When the database store is not configured.

async def add(self, key: str, value: Any, ttl: float | None = None) -> bool: (source) ¶

overrides orionis.cache.contracts.ICacheManager.add

Store value only if key is absent in the default store.

Parameters
key:`str`	Cache key.
value:`Any`	Value to store.
ttl:`float \| None`	Optional TTL in seconds.

Returns
`bool`	`True` on success, `False` when the key already exists.

async def clear(self) -> bool: (source) ¶

overrides orionis.cache.contracts.ICacheManager.clear

Remove all entries from the default store.

Returns
`bool`	`True` on success.

async def decrement(self, key: str, amount: int = 1) -> int: (source) ¶

overrides orionis.cache.contracts.ICacheManager.decrement

Decrement the integer at key by amount in the default store.

Parameters
key:`str`	Cache key.
amount:`int`	Amount to subtract.

Returns
`int`	New value after decrement.

async def delete(self, key: str) -> bool: (source) ¶

overrides orionis.cache.contracts.ICacheManager.delete

Remove key from the default store.

Parameters
key:`str`	Cache key.

Returns
`bool`	`True` if the key existed, `False` otherwise.

async def get(self, key: str) -> Any: (source) ¶

overrides orionis.cache.contracts.ICacheManager.get

Retrieve the value for key from the default store.

Parameters
key:`str`	Cache key.

Returns
`Any`	Cached value, or `None` when absent.

async def getMany(self, keys: list[str]) -> dict[str, Any]: (source) ¶

overrides orionis.cache.contracts.ICacheManager.getMany

Retrieve multiple values from the default store.

Parameters
keys:`list[str]`	Cache keys to fetch.

Returns
`dict[str, Any]`	Mapping of key → value; missing keys map to `None`.

async def has(self, key: str) -> bool: (source) ¶

overrides orionis.cache.contracts.ICacheManager.has

Check whether key exists and has not expired in the default store.

Parameters
key:`str`	Cache key.

Returns
`bool`	`True` if the key is present and valid.

async def increment(self, key: str, amount: int = 1) -> int: (source) ¶

overrides orionis.cache.contracts.ICacheManager.increment

Increment the integer at key by amount in the default store.

Parameters
key:`str`	Cache key.
amount:`int`	Amount to add.

Returns
`int`	New value after increment.

def lock(self, key: str, timeout: float | None = None) -> Any: (source) ¶

Return an async context-manager lock for key on the default store.

Parameters
key:`str`	Resource key to lock.
timeout:`float \| None`	Maximum lock duration in seconds.

Returns
`CacheLock`	Async context manager.

async def pull(self, key: str) -> Any: (source) ¶

overrides orionis.cache.contracts.ICacheManager.pull

Return and immediately delete key from the default store.

Parameters
key:`str`	Cache key.

Returns
`Any`	Cached value, or `None` when absent.

async def remember(self, key: str, ttl: float | None, resolver: Callable) -> Any: (source) ¶

overrides orionis.cache.contracts.ICacheManager.remember

Return the cached value for key; resolve and cache if absent.

Parameters
key:`str`	Cache key.
ttl:`float \| None`	TTL applied when caching the resolved value.
resolver:`Callable`	Zero-argument callable (sync or async) producing the value.

Returns
`Any`	Cached or freshly computed value.

async def rememberForever(self, key: str, resolver: Callable) -> Any: (source) ¶

overrides orionis.cache.contracts.ICacheManager.rememberForever

Return the cached value for key; resolve and cache forever if absent.

Parameters
key:`str`	Cache key.
resolver:`Callable`	Zero-argument callable (sync or async) producing the value.

Returns
`Any`	Cached or freshly computed value.

async def set(self, key: str, value: Any, ttl: float | None = None) -> bool: (source) ¶

overrides orionis.cache.contracts.ICacheManager.set

Store value under key in the default store.

Parameters
key:`str`	Cache key.
value:`Any`	Value to cache.
ttl:`float \| None`	Time-to-live in seconds. `None` means no expiry.

Returns
`bool`	`True` on success.

async def setMany(self, values: dict[str, Any], ttl: float | None = None) -> bool: (source) ¶

overrides orionis.cache.contracts.ICacheManager.setMany

Store multiple key/value pairs in the default store.

Parameters
values:`dict[str, Any]`	Mapping of key → value.
ttl:`float \| None`	Shared TTL in seconds.

Returns
`bool`	`True` on success.

def store(self, name: str | None = None) -> CacheRepository: (source) ¶

overrides orionis.cache.contracts.ICacheManager.store

Return the CacheRepository for the named (or default) store.

The repository is created on first access and cached for reuse.

Parameters
name:`str \| None`	Store name (`'file'`, `'memory'`, `'redis'`, `'memcached'`). Defaults to the configured default store.

Returns
`CacheRepository`	Repository for the selected backend.

Raises
`CacheStoreException`	When the requested store is not configured.

__slots__: tuple[str, ...] = (source) ¶

Undocumented

_app = (source) ¶

Undocumented

_base_path: Path = (source) ¶

Undocumented

_config = (source) ¶

Undocumented

_default: str = (source) ¶

Undocumented

_prefix: str = (source) ¶

Undocumented

_repositories: dict[str, CacheRepository] = (source) ¶

Undocumented