aries_cloudagent.cache package

Subpackages

• aries_cloudagent.cache.tests package
  • Submodules
  • aries_cloudagent.cache.tests.test_basic_cache module

Submodules

aries_cloudagent.cache.base module

Abstract base classes for cache.

class aries_cloudagent.cache.base.BaseCache

Bases: abc.ABC

Abstract cache interface.

clear(key: str)

Remove an item from the cache, if present.

Parameters:key – the key to remove

flush()

Remove all items from the cache.

get(key: str)

Get an item from the cache.

Parameters:key – the key to retrieve an item for Returns:The record found or None

set(key: str, value: Any, ttl: int)

Add an item to the cache with an optional ttl.

Parameters:

• key – the key to set an item for
• value – the value to store in the cache
• ttl – number of second that the record should persist

aries_cloudagent.cache.basic module

Basic in-memory cache implementation.

class aries_cloudagent.cache.basic.BasicCache

Bases: aries_cloudagent.cache.base.BaseCache

Basic in-memory cache class.

clear(key: str)

Remove an item from the cache, if present.

Parameters:key – the key to remove

flush()

Remove all items from the cache.

get(key: str)

Get an item from the cache.

Parameters:key – the key to retrieve an item for Returns:The record found or None

set(key: str, value: Any, ttl: int = None)

Add an item to the cache with an optional ttl.

Overwrites existing cache entries.

Parameters:

• key – the key to set an item for
• value – the value to store in the cache
• ttl – number of seconds that the record should persist