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.

Files for redis-lru, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size redis_lru-0.0.3-py2.py3-none-any.whl (5.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size redis-lru-0.0.3.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page