Cache Backends

Backend Classes

Several cache backends are included, which can be selected using the cache parameter for CachedSession:

aiohttp_client_cache.backends.base.CacheBackend

Base class for cache backends; includes a non-persistent, in-memory cache.

aiohttp_client_cache.backends.dynamodb.DynamoDBBackend

Async cache backend for DynamoDB (requires aioboto3)

aiohttp_client_cache.backends.mongo.MongoDBBackend

Async cache backend for MongoDB (requires motor)

aiohttp_client_cache.backends.redis.RedisBackend

Async cache backend for Redis (requires aioredis)

aiohttp_client_cache.backends.sqlite.SQLiteBackend

Async cache backend for SQLite (requires aiosqlite)

Usage example:

>>> from aiohttp_client_cache import CachedSession, RedisCache
>>>
>>> async with CachedSession(cache=RedisCache()) as session:
...      await session.get('http://httpbin.org/get')

See API Reference for backend-specific usage details.

Backend Cache Name

The cache_name parameter will be used as follows depending on the backend:

  • DynamoDb: Table name

  • MongoDb: Database name

  • Redis: Namespace, meaning all keys will be prefixed with '<cache_name>:'

  • SQLite: Database path; user paths are allowed, e.g ~/.cache/my_cache.sqlite

Backend-Specific Arguments

When initializing a CacheBackend, you can provide any valid keyword arguments for the backend’s internal connection class or function.

For example, with SQLiteBackend, you can pass arguments accepted by sqlite3.connect():

>>> cache = SQLiteBackend(
...     timeout=2.5,
...     uri='file://home/user/.cache/aiohttp-cache.db?mode=ro&cache=private',
... )

Custom Backends

If the built-in backends don’t suit your needs, you can create your own by making subclasses of CacheBackend and BaseCache:

>>> from aiohttp_client_cache import CachedSession
>>> from aiohttp_client_cache.backends import BaseCache, BaseStorage

>>> class CustomCache(BaseCache):
...     """Wrapper for higher-level cache operations. In most cases, the only thing you need
...     to specify here is which storage class(es) to use.
...     """
...     def __init__(self, **kwargs):
...         super().__init__(**kwargs)
...         self.redirects = CustomStorage(**kwargs)
...         self.responses = CustomStorage(**kwargs)

>>> class CustomStorage(BaseStorage):
...     """interface for lower-level backend storage operations"""
...     def __init__(self, **kwargs):
...         super().__init__(**kwargs)
...
...     async def contains(self, key: str) -> bool:
...         """Check if a key is stored in the cache"""
...
...     async def clear(self):
...         """Delete all items from the cache"""
...
...     async def delete(self, key: str):
...         """Delete an item from the cache"""
...
...     async def keys(self) -> AsyncIterable[str]:
...         """Get all keys stored in the cache"""
...
...     async def read(self, key: str) -> ResponseOrKey:
...         """Read anitem from the cache"""
...
...     async def size(self) -> int:
...         """Get the number of items in the cache"""
...
...     def values(self) -> AsyncIterable[ResponseOrKey]:
...         """Get all values stored in the cache"""
...
...     async def write(self, key: str, item: ResponseOrKey):
...         """Write an item to the cache"""

You can then use your custom backend in a CachedSession with the cache parameter:

>>> session = CachedSession(cache=CustomCache())