Skip to main content

Minimal persistent memoization cache

Project description

Cachalot PyPI version Pipeline status Coverage report

Cachalot is a minimal persistent memoization cache. It provides a decorator, that stores function result for future use. Perfect for heavy computations and I/O operation (such as web requests). On backend, it uses TinyDB for storage.

Features

  • Simple usage via decorator
  • Persistent caching
  • Key expiration
  • Maximum cache size, to prevent bloat

Installation

Cachalot requires Python 3.5 or newer to run.

Python package

You can easily install Cachalot using pip:

pip3 install cachalot

Manual

Alternatively, to get the latest development version, you can clone this repository and then manually install it:

git clone git@gitlab.com:radek-sprta/cachalot.git
cd cachalot
python3 setup.py install

Usage

from cachalot import Cache

@Cache()
def expensive_function():
    return expensive_calculation()

Advanced usage

from cachalot import Cache

@Cache(path='cache.json', timeout=3600, size=5e3, filesize=1e6, retry=True)
def expensive_function():
    return expensive_calculation()
  • path: Path to the database file. Defaults to .cache.json.
  • timeout: How long should the data be cached in seconds. Defaults to 0 (infinite).
  • size: Maximum number of keys cached. Defaults to 0 (infinite).
  • filesize: Maximum size of database file in bytes. Defaults to 0 (infinite).
  • retry: Retry if result is blank. Defaults to False.

For more information, see documentation.

Contributing

For information on how to contribute to the project, please check the Contributor's Guide

Contact

mail@radeksprta.eu

incoming+radek-sprta/cachalot@gitlab.com

License

MIT License

Credits

This package was created with Cookiecutter and the python-cookiecutter project template. Inspired by Cashier

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
cachalot-1.1.0-py3-none-any.whl (4.2 kB) Copy SHA256 hash SHA256 Wheel py3
cachalot-1.1.0.tar.gz (8.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page