orionis.cache.contracts.ICacheManager

ORIONIS API REFERENCE

Modules Classes Names

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 ICacheManager(ABC): (source)

Known subclasses: orionis.cache.CacheManager

View In Hierarchy

Undocumented

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 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 in the default store.
Async Method	`increment`	Increment the integer at key in the default store.
Async Method	`pull`	Return and immediately delete key from the default store.
Async Method	`remember`	Return the cached value; resolve and cache if absent.
Async Method	`rememberForever`	Return the cached value; 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 repository for the named (or default) store.

@abstractmethod

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

overridden in orionis.cache.CacheManager

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.

@abstractmethod

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

overridden in orionis.cache.CacheManager

Remove all entries from the default store.

Returns
`bool`	`True` on success.

@abstractmethod

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

overridden in orionis.cache.CacheManager

Decrement the integer at key in the default store.

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

Returns
`int`	New value after decrement.

@abstractmethod

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

overridden in orionis.cache.CacheManager

Remove key from the default store.

Parameters
key:`str`	Cache key.

Returns
`bool`	`True` if the key existed.

@abstractmethod

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

overridden in orionis.cache.CacheManager

Retrieve the value for key from the default store.

Parameters
key:`str`	Cache key.

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

@abstractmethod

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

overridden in orionis.cache.CacheManager

Retrieve multiple values from the default store.

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

Returns
`dict[str, Any]`	Mapping of key → value.

@abstractmethod

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

overridden in orionis.cache.CacheManager

Check whether key exists in the default store.

Parameters
key:`str`	Cache key.

Returns
`bool`	`True` if present and valid.

@abstractmethod

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

overridden in orionis.cache.CacheManager

Increment the integer at key in the default store.

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

Returns
`int`	New value after increment.

@abstractmethod

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

overridden in orionis.cache.CacheManager

Return and immediately delete key from the default store.

Parameters
key:`str`	Cache key.

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

@abstractmethod

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

overridden in orionis.cache.CacheManager

Return the cached value; 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.

@abstractmethod

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

overridden in orionis.cache.CacheManager

Return the cached value; 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.

@abstractmethod

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

overridden in orionis.cache.CacheManager

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.

@abstractmethod

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

overridden in orionis.cache.CacheManager

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.

@abstractmethod

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

overridden in orionis.cache.CacheManager

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

Parameters
name:`str \| None`	Store name. `None` selects the configured default.

Returns
`ICacheRepository`	Repository bound to the requested store.