Skip to main content

A simple decorator to cache the results of functions

Project description

A simple decorator to cache the results of function calls.


pip install cache_em_all


from cache_em_all import Cachable

def answer_to(question):
    if question == "life":
        import time
        return 42

answer_to("life") # Takes 7.5 million years
answer_to("life") # Pretty much instant

After the first call to answer_to, the result of the function is stored in a file cache/answer/answer__life.json. When the function is called again (with the same parameters), instead of executing the function, the decorator will get the result from the file.

Advanced usage

File types

Various file types are supported.

extension Description
csv Uses pandas to save the result in a csv file. The return value for the function must be a DataFrame or Series.
json Saves the result in a json file. Useful for lists, dictionaries and primitive types.
pkl Pickles the return value. Return type can be just about anything. May not work well for large (>~2GB) files
pa Uses pyarrow to save files. This is generally faster than pkl and supports larger files (tested up to 50GB)


The Cachable decorator can accept a version number. This is useful for when you update a function. For example,

You had the following code:

from cache_em_all import Cachable

def add(x, y):
    return x + x

This is a bug (should be x+y, not x+x), but you’ve run this function multiple times and there are lots of cached results. Rather than manually deleting the cache folder, you can bump the version number (version numbers start at 0).

from cache_em_all import Cachable

@Cachable("add.json", version=1)
def add(x, y):
    return x + y

Now next time the function is called it will invalidate the cache and re-run the function.

Do not use this feature in multi-processing code because the writes to the version file do not (yet) use locks.


By default all cached files are stored in a folder called cache. This can be changed for each function by passing folder to Cachable.

from cache_em_all import Cachable

@Cachable("add.json", folder="/mnt/ram/fastcache")
def add(x, y):
    return x + y

You can also change the default cache dir so that all cache files are by default saved elsewhere.

from cache_em_all import Cachable, set_cache_dir

def add(x, y):
    return x + y

Disable cache

You can also disable the cache by setting use to False.

from cache_em_all import Cachable

@Cachable("add.json", use=False)
def add(x, y):
    return x + y

This can be useful for debugging or optmizing the function.

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 cache-em-all, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size cache-em-all-0.2.2.tar.gz (16.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page