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.11.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0766fff4eda05498c7525374a587810dcc2ccb7b256809dde52ae8790a8453eb |
|
MD5 | 6d9d3f9510a16eec86e4a1a548d2ce0d |
|
BLAKE2b-256 | 913e6c302a45c23c746afc86d1f35d85125815df9273b17cfb3035f3dfe69971 |
Hashes for aiohttp_client_cache-0.11.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b6217bc26a7b3f5f939809b63a66b67658b660809cd38869d7d45066a26d079 |
|
MD5 | 728258d7c525953fc4c297da7374554f |
|
BLAKE2b-256 | a32c2203bdced6b17aef522775521f0fbebc18a62b766b10f419f6ae5c815a2d |