Contributing¶
Installation¶
To set up for local development:
$ git clone https://github.com/JWCook/aiohttp-client-cache
$ cd aiohttp-client-cache
$ pip install -Ue ".[dev]"
Pre-commit hooks¶
Pre-commit config is uncluded to run the same checks locally that are run in CI jobs by GitHub Actions. This is optional but recommended.
$ pre-commit install --config .github/pre-commit.yml
To uninstall:
$ pre-commit uninstall
Integration Tests¶
Local databases are required to run integration tests, and docker-compose config is included to make this easier. First, install docker and install docker-compose.
Then, run:
$ docker-compose up -d
pytest test/integration
Documentation¶
Sphinx is used to generate documentation.
To build the docs locally:
$ make -C docs html
To preview:
# MacOS:
$ open docs/_build/index.html
# Linux:
$ xdg-open docs/_build/index.html
Documentation is automatically built by ReadTheDocs whenever code is merged into the main
branch.
Releases¶
Releases are built and published to pypi based on git tags. Milestones will be used to track progress on major and minor releases.
Code Layout¶
Here is a brief overview of the main classes and modules:
session.CacheMixin
,session.CachedSession
: A mixin and wrapper class, respectively, foraiohttp.ClientSession
. There is little logic here except wrappingClientSession._request()
with caching behavior.response.CachedResponse
: A wrapper class built from anaiohttp.ClientResponse
, with additional cache-related info. This is what is serialized and persisted to the cache.backends.base.CacheBackend
: Most of the caching logic lives here, including saving and retriving responses, creating cache keys, expiration, etc. It contains twoBaseCache
objects for storing responses and redirects, respectively. By default this is just a non-persistent dict cache.backends.base.BaseCache
: Base class for lower-level storage operations, overridden by individual backends.Other backend implementations in
backends.*
: A backend implementation subclassesCacheBackend
(for higher-level operations), as well asBaseCache
(for lower-level operations).