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, and Redis.
Quickstart
First, install with pip (python 3.7+ 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.9.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73be39af4dafb240d11dddd514d4b383ece0cd4c37da8a5bbfd76b149c09560c |
|
MD5 | eda6f39289f3fe880f52712d4bbe3a3b |
|
BLAKE2b-256 | f96e68db3e736c04b9c736873b2e2b61e593e97d05f4beba055d418b8283fedd |
Hashes for aiohttp_client_cache-0.9.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba036aac8042c076e5871971884502479fe01fa36c087a28da9235617a8bf3ef |
|
MD5 | 53743c6b8a95e25f2d256e730fc44fbe |
|
BLAKE2b-256 | e60d0d8eda121bfe63c3ed305875682be66c97781ff81e30218f1b92a13e1c75 |