Skip to main content

LRU cache for Python. Use Redis as backend. Provides a dictionary-like object as well as a method decorator.

Project description

Installation

pip install redis-lru

Introduction

It’s often useful to have an lru redis cache. Of course, it’s also desirable not to have the cache grow too large, and cache expiration is often desirable. This module provides such a cache.

redis-lru supports CPython 2.7, 3.4+

For the most part, you can just use it like this:

from redis_lru import redis_lru_cache_function

client = redis.StrictRedis()

@redis_lru_cache_function(max_size=1024, expiration=15*60, node=client)
def f(x):
    print("Calling f({})".format(str(x)))
    return x


f(3) # This will print "Calling f(3)", will return 3
f(3) # This will not print anything, but will return 3 (unless 15 minutes have passed between the first and second function call).

One can also create an RedisLRUCacheDict object, which have a redis backend behind with LRU eviction semantics:

from redis_lru import RedisLRUCacheDict

client = redis.StrictRedis()

d = RedisLRUCacheDict('unique_key', max_size=3, expiration=3, node=client)

d['foo'] = 'bar'
print(d['foo']) # prints "bar"

import time
time.sleep(4) # 4 seconds > 3 second cache expiry of d
print(d['foo']) # KeyError

In order to configure the decorator in a more detailed manner, or share a cache across functions, one can create a cache and pass it in as an argument to the cached function decorator:

d = RedisLRUCacheDict(max_size=3, expiration=3, node=client)

@redis_lru_cache_function(cache=d)
def f(x):
    return x/2

The doctests in the code provide more examples.

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

redis-lru-0.0.2.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

redis_lru-0.0.2-py2.py3-none-any.whl (5.6 kB view hashes)

Uploaded Python 2 Python 3

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