Skip to main content

Persistent cache for aiohttp requests

Project description

aiohttp-client-cache

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

Documentation Status

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.

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

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]"

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:

  • sqlite: SQLite database (default)
  • 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
  • memory: Not persistent, simply stores all data in Python dict 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()

History

0.1.0

  • Initial PyPI release
  • First pass at a general refactor and conversion from requests to aiohttp

requests-cache

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aiohttp-client-cache, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size aiohttp_client_cache-0.1.0-py3-none-any.whl (26.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size aiohttp-client-cache-0.1.0.tar.gz (23.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page