Skip to main content

Extensible memoizing collections and decorators

Project description

Latest PyPI version Documentation build status CI build status Test coverage License Code style: black

This module provides various memoizing collections and decorators, including variants of the Python Standard Library’s @lru_cache function decorator.

from cachetools import cached, LRUCache, TTLCache

# speed up calculating Fibonacci numbers with dynamic programming
@cached(cache={})
def fib(n):
    return n if n < 2 else fib(n - 1) + fib(n - 2)

# cache least recently used Python Enhancement Proposals
@cached(cache=LRUCache(maxsize=32))
def get_pep(num):
    url = 'http://www.python.org/dev/peps/pep-%04d/' % num
    with urllib.request.urlopen(url) as s:
        return s.read()

# cache weather data for no longer than ten minutes
@cached(cache=TTLCache(maxsize=1024, ttl=600))
def get_weather(place):
    return owm.weather_at_place(place).get_weather()

For the purpose of this module, a cache is a mutable mapping of a fixed maximum size. When the cache is full, i.e. by adding another item the cache would exceed its maximum size, the cache must choose which item(s) to discard based on a suitable cache algorithm. In general, a cache’s size is the total size of its items, and an item’s size is a property or function of its value, e.g. the result of sys.getsizeof(value). For the trivial but common case that each item counts as 1, a cache’s size is equal to the number of its items, or len(cache).

Multiple cache classes based on different caching algorithms are implemented, and decorators for easily memoizing function and method calls are provided, too.

Installation

cachetools is available from PyPI and can be installed by running:

pip install cachetools

Typing stubs for this package are provided by typeshed and can be installed by running:

pip install types-cachetools

Project Resources

License

Copyright (c) 2014-2021 Thomas Kemmer.

Licensed under the MIT License.

Project details


Download files

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

Source Distribution

cachetools-chrisglass-4.2.4.1.tar.gz (26.7 kB view details)

Uploaded Source

File details

Details for the file cachetools-chrisglass-4.2.4.1.tar.gz.

File metadata

  • Download URL: cachetools-chrisglass-4.2.4.1.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.5.0 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for cachetools-chrisglass-4.2.4.1.tar.gz
Algorithm Hash digest
SHA256 f7f1191b8ea4b9af57c1430de6ca53dc3cc3fdc5cbe57d453f58ecca0f9e0b1e
MD5 40a0e7d07ef69fff0d4bc0748149da2c
BLAKE2b-256 fb5fb1f87a1b195d582f64c24ff348291533b7908779b727e168e0267691bac5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page