aiohttp-client-cache 0.1.2

Persistent cache for aiohttp requests

aiohttp-client-cache

See full documentation at https://aiohttp-client-cache.readthedocs.io

aiohttp-client-cache is an async persistent cache for aiohttp requests, based on requests-cache.

Not to be confused with aiohttp-cache, which is a cache for the aiohttp web server. This package is, as you might guess, specifically for the aiohttp client.

Development Status

This is an early work in progress and not yet fully functional!

The current state is a mostly working drop-in replacement for aiohttp.ClientSession. However, the cache operations are still synchronous, with minimal testing and likely lots of bugs.

Installation

Requires python 3.7+

Install the latest stable version with pip:

pip install aiohttp-client-cache

To set up for local development:

$ git clone https://github.com/JWCook/aiohttp-client-cache
$ cd aiohttp-client-cache
$ pip install -Ue ".[dev]"
$ # Optional but recommended:
$ pre-commit install --config .github/pre-commit.yml

Usage example

from aiohttp_client_cache import CachedSession
session = CachedSession('demo_cache', backend='sqlite')
response = await session.get('http://httpbin.org/get')

Afterward, all responses with headers and cookies will be transparently cached to a database named demo_cache.sqlite. For example, following code will take only 1-2 seconds instead of 10, and will run instantly on next launch:

for i in range(10):
    await session.get('http://httpbin.org/delay/1')

Cache Backends

Several backends are available. The default backend is sqlite, if installed; otherwise it falls back to memory.

• sqlite : SQLite database (requires aiosqlite)
• redis : Stores all data in a redis cache (requires redis-py)
• mongodb : MongoDB database (requires pymongo)
  • gridfs : MongoDB GridFS enables storage of documents greater than 16MB (requires pymongo)
• memory : Not persistent, simply stores all data in memory

You can also provide your own backend by subclassing aiohttp_client_cache.backends.BaseCache.

Expiration

If you are using the expire_after parameter , responses are removed from the storage the next time the same request is made. If you want to manually purge all expired items, you can use CachedSession.delete_expired_responses. Example:

session = CachedSession(expire_after=1)
await session.remove_expired_responses()

Credits

Thanks to Roman Haritonov and contributors for the original requests-cache!

This project is licensed under the MIT license, with the exception of portions reused from requests-cache (primarily its storage backends), which is licensed under the BSD license (copy included).

History

0.1.0 (2020-11-14)

• Initial PyPI release
• First pass at a general refactor and conversion from requests to aiohttp
• Basic features are functional, but some backends do not actually operate asynchronously

requests-cache

See requests-cache development history for details on prior changes.