Persistent cache for aiohttp requests
Project description
aiohttp-client-cache
aiohttp-client-cache is an async persistent cache for aiohttp client requests, based on requests-cache.
Features
- Ease of use: Use as a drop-in replacement
for
aiohttp.ClientSession
- Customization: Works out of the box with little to no config, but with plenty of options available for customizing cache expiration and other behavior
- Persistence: Includes several storage backends: SQLite, DynamoDB, MongoDB, DragonflyDB and Redis.
Quickstart
First, install with pip (python 3.8+ required):
pip install aiohttp-client-cache[all]
Note:
Adding [all]
will install optional dependencies for all supported backends. When adding this
library to your application, you can include only the dependencies you actually need; see individual
backend docs and pyproject.toml
for details.
Basic Usage
Next, use aiohttp_client_cache.CachedSession in place of aiohttp.ClientSession. To briefly demonstrate how to use it:
Replace this:
from aiohttp import ClientSession
async with ClientSession() as session:
await session.get('http://httpbin.org/delay/1')
With this:
from aiohttp_client_cache import CachedSession, SQLiteBackend
async with CachedSession(cache=SQLiteBackend('demo_cache')) as session:
await session.get('http://httpbin.org/delay/1')
The URL in this example adds a delay of 1 second, simulating a slow or rate-limited website.
With caching, the response will be fetched once, saved to demo_cache.sqlite
, and subsequent
requests will return the cached response near-instantly.
Configuration
Several options are available to customize caching behavior. This example demonstrates a few of them:
# fmt: off
from aiohttp_client_cache import SQLiteBackend
cache = SQLiteBackend(
cache_name='~/.cache/aiohttp-requests.db', # For SQLite, this will be used as the filename
expire_after=60*60, # By default, cached responses expire in an hour
urls_expire_after={'*.fillmurray.com': -1}, # Requests for any subdomain on this site will never expire
allowed_codes=(200, 418), # Cache responses with these status codes
allowed_methods=['GET', 'POST'], # Cache requests with these HTTP methods
include_headers=True, # Cache requests with different headers separately
ignored_params=['auth_token'], # Keep using the cached response even if this param changes
timeout=2.5, # Connection timeout for SQLite backend
)
More Info
To learn more, see:
Feedback
If there is a feature you want, if you've discovered a bug, or if you have other general feedback, please create an issue for it!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aiohttp_client_cache-0.12.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 221d9c9f3396f09368e331f7439f95bb0a5affd3aeb7d12ff7dae6edbe5bd5ee |
|
MD5 | 60dedd577a9192fe909e608a11ba9a32 |
|
BLAKE2b-256 | 9790e1294feb2518bcb43db8abfd19ed0627b71d2e328f394424e9559ce40110 |
Hashes for aiohttp_client_cache-0.12.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a3ec018bec9ef2ff2d1095f10abc964395d45caa4f276bf6bf96004b6e3707a |
|
MD5 | 5191368a925209be31f906099f32e801 |
|
BLAKE2b-256 | 1d1fe68864a24a1d356790ad7aa97e2cd09cd77e5f643bc26b1721299297b56a |