acapy_agent.cache package

Submodules

acapy_agent.cache.base module

Abstract base classes for cache.

class acapy_agent.cache.base.BaseCache

Bases: ABC

Abstract cache interface.

acquire(key: str)

Acquire a lock on a given cache key.

abstractmethod async clear(key: str)

Remove an item from the cache, if present.

Parameters:

key – the key to remove

abstractmethod async flush()

Remove all items from the cache.

abstractmethod async get(key: str)

Get an item from the cache.

Parameters:

key – the key to retrieve an item for

Returns:

The record found or None

release(key: str)

Release the lock on a given cache key.

abstractmethod async set(keys: str | Sequence[str], value: Any, ttl: int | None = None)

Add an item to the cache with an optional ttl.

Parameters:

• keys – the key or keys for which to set an item

• value – the value to store in the cache

• ttl – number of second that the record should persist

exception acapy_agent.cache.base.CacheError(*args, error_code: str | None = None, **kwargs)

Bases: BaseError

Base class for cache-related errors.

class acapy_agent.cache.base.CacheKeyLock(cache: BaseCache, key: str)

Bases: object

A lock on a particular cache key.

Used to prevent multiple async threads from generating or querying the same semi-expensive data. Not thread safe.

property done: bool

Accessor for the done state.

property future: Future

Fetch the result in the form of an awaitable future.

property parent: CacheKeyLock

Accessor for the parent key lock, if any.

release()

Release the cache lock.

property result: Any

Fetch the current result, if any.

async set_result(value: Any, ttl: int | None = None)

Set the result, updating the cache and any waiters.

acapy_agent.cache.in_memory module

Basic in-memory cache implementation.

class acapy_agent.cache.in_memory.InMemoryCache

Bases: BaseCache

Basic in-memory cache class.

async clear(key: str)

Remove an item from the cache, if present.

Parameters:

key – the key to remove

async flush()

Remove all items from the cache.

async get(key: str)

Get an item from the cache.

Parameters:

key – the key to retrieve an item for

Returns:

The record found or None

async set(keys: str | Sequence[str], value: Any, ttl: int | None = None)

Add an item to the cache with an optional ttl.

Overwrites existing cache entries.

Parameters:

• keys – the key or keys for which to set an item

• value – the value to store in the cache

• ttl – number of seconds that the record should persist