Skip to main content
Help us improve Python packaging – donate today!

persistent caching to memory, disk, or database

Project Description

Klepto extends python’s ‘lru_cache’ to utilize different keymaps and alternate caching algorithms, such as ‘lfu_cache’ and ‘mru_cache’. While caching is meant for fast access to saved results, klepto also has archiving capabilities, for longer-term storage. Klepto uses a simple dictionary-sytle interface for all caches and archives, and all caches can be applied to any python function as a decorator. Keymaps are algorithms for converting a function’s input signature to a unique dictionary, where the function’s results are the dictionary value. Thus for y = f(x), y will be stored in cache[x] (e.g. {x:y}).

Klepto provides both standard and ‘safe’ caching, where safe caches are slower but can recover from hashing errors. Klepto is intended to be used for distributed and parallel computing, where several of the keymaps serialize the stored objects. Caches and archives are intended to be read/write accessible from different threads and processes. Klepto enables a user to decorate a function, save the results to a file or database archive, close the interpreter, start a new session, and reload the function and it’s cache.

Klepto is part of pathos, a python framework for heterogenous computing. Klepto is in the early development stages, and any user feedback is highly appreciated. Contact Mike McKerns [mmckerns at caltech dot edu] with comments, suggestions, and any bugs you may find. A list of known issues is maintained at

Major Features

Klepto has standard and ‘safe’ variants of the following:

- 'lfu_cache' - the least-frequently-used caching algorithm
- 'lru_cache' - the least-recently-used caching algorithm
- 'mru_cache' - the most-recently-used caching algorithm
- 'rr_cache' - the random-replacement caching algorithm
- 'no_cache' - a dummy caching interface to archiving
- 'inf_cache' - an infinitely-growing cache

Klepto has the following archive types:

- 'file_archive' - a dictionary-style interface to a file
- 'dir_archive' - a dictionary-style interface to a folder of files
- 'sqltable_archive' - a dictionary-style interface to a sql database table
- 'sql_archive' - a dictionary-style interface to a sql database
- 'dict_archive' - a dictionary with an archive interface
- 'null_archive' - a dictionary-style interface to a dummy archive

Klepto provides the following keymaps:

- 'keymap' - keys are raw python objects
- 'hashmap' - keys are a hash for the python object
- 'stringmap' - keys are the python object cast as a string
- 'picklemap' - keys are the serialized python object

Klepto also includes a few useful decorators providing:

- simple, shallow, or deep rounding
- cryptographic key generation, with masking of selected arguments

Current Release

The latest release version is klepto-0.1. You can download it here. The latest stable version of klepto is always available at:

Development Release

If you like living on the edge, and don’t mind the promise of a little instability, you can get the latest development release with all the shiny new features at:


Klepto is packaged to install from source, so you must download the tarball, unzip, and run the installer:

$ tar -xvzf klepto-0.1.tgz
$ cd klepto-0.1
$ python setup py build
$ python setup py install

You will be warned of any missing dependencies and/or settings after you run the “build” step above.

Alternately, klepto can be installed with easy_install:

$ easy_install -f . klepto


Klepto requires:

- python, version >= 2.5, version < 3.0
- dill, version >= 0.2
- pox, version >= 0.2

Optional requirements:

- sqlalchemy, version >= 0.8.4
- setuptools, version >= 0.6

Usage Notes

Probably the best way to get started is to look at the tests that are provide within klepto. See klepto.tests for a set of scripts that test klepto’s caching and archiving functionalities. Klepto’s source code is also generally well documented, so further questions may be resolved by inspecting the code itself.


Klepto is distributed under a 3-clause BSD license.

>>> import klepto
>>> print klepto.license()


If you use klepto to do research that leads to publication, we ask that you acknowledge use of klepto by citing the following in your publication:

Michael McKerns and Michael Aivazis,
"pathos: a framework for heterogeneous computing", 2010- ;

More Information

Please see for further information.

Release history Release notifications

History Node


History Node


History Node


History Node


This version
History Node


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
klepto-0.1.tgz (58.2 kB) Copy SHA256 hash SHA256 Source None May 19, 2014 (78.2 kB) Copy SHA256 hash SHA256 Source None May 19, 2014

Supported by

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