Project: expiringdict

Expiring Dict

.. image:: https://travis-ci.org/mailgun/expiringdict.svg?branch=master :target: https://travis-ci.org/mailgun/expiringdict

.. image:: https://coveralls.io/repos/github/mailgun/expiringdict/badge.svg?branch=master :target: https://coveralls.io/github/mailgun/expiringdict?branch=master

ChangeLog_

expiringdict is a Python caching library. The core of the library is ExpiringDict class which is an ordered dictionary with auto-expiring values for caching purposes. Expiration happens on any access, object is locked during cleanup from expired values. ExpiringDict can not store more than max_len elements - the oldest will be deleted.

Note: Iteration over dict and also keys() do not remove expired values!

.. _ChangeLog: ./CHANGELOG.rst

Installation

If you wish to install from PyPi:

.. code-block:: bash

pip install expiringdict

If you wish to download the source and install from GitHub:

.. code-block:: bash

git clone git@github.com:mailgun/expiringdict.git
python setup.py install

or to install with test dependencies (Nose <http://readthedocs.org/docs/nose/en/latest/>, Mock <http://www.voidspace.org.uk/python/mock/>, coverage <http://nedbatchelder.com/code/coverage/>_) run from the directory above:

.. code-block:: bash

pip install -e expiringdict[test]

To run tests with coverage:

.. code-block:: bash

nosetests --with-coverage --cover-package=expiringdict

Usage

Create a dictionary with capacity for 100 elements and elements expiring in 10 seconds:

.. code-block:: py

from expiringdict import ExpiringDict
cache = ExpiringDict(max_len=100, max_age_seconds=10)

put and get a value there:

.. code-block:: py

 cache["key"] = "value"
 cache.get("key")

copy from dict or OrderedDict:

.. code-block:: py

 from expiringdict import ExpiringDict
 my_dict=dict()
 my_dict['test'] = 1
 cache = ExpiringDict(max_len=100, max_age_seconds=10, items=my_dict)
 assert cache['test'] == 1

copy from another ExpiringDict, with or without new length and timeout:

.. code-block:: py

 from expiringdict import ExpiringDict
 cache_hour = ExpiringDict(max_len=100, max_age_seconds=3600)
 cache_hour['test'] = 1
 cache_hour_copy = ExpiringDict(max_len=None, max_age_seconds=None, items=cache_hour)
 cache_minute_copy = ExpiringDict(max_len=None, max_age_seconds=60, items=cache_hour)
 assert cache_minute_copy['test'] == 1

pickle :

.. code-block:: py

import dill
from expiringdict import ExpiringDict
cache = ExpiringDict(max_len=100, max_age_seconds=10)
cache['test'] = 1
pickled_cache = dill.dumps(cache)
unpickled_cache = dill.loads(cache)
assert unpickled_cache['test'] == 1