Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexk307/cache_deco
Backend agnostic cache decorator
https://github.com/alexk307/cache_deco
cache cache-control cache-deco redis
Last synced: 3 months ago
JSON representation
Backend agnostic cache decorator
- Host: GitHub
- URL: https://github.com/alexk307/cache_deco
- Owner: alexk307
- License: mit
- Created: 2016-04-30T16:21:12.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-26T20:22:38.000Z (almost 2 years ago)
- Last Synced: 2024-07-17T13:59:05.189Z (4 months ago)
- Topics: cache, cache-control, cache-deco, redis
- Language: Python
- Homepage:
- Size: 45.9 KB
- Stars: 81
- Watchers: 7
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cache_deco [](https://travis-ci.org/alexk307/cache_deco) [](https://coveralls.io/github/alexk307/redis_cache?branch=master)
Implements high level function caching to any backend with a decorator
# Install
`pip install redis_cache_decorator`
# Usage
## Setup
```python
from cache_deco import Cache
from backends.redis.redis_backend import RedisBackend
# Create your cache backend
redis = RedisBackend('localhost', 6379)
# Use this backend as your cache
c = Cache(redis)
```
## Cache
```python
@c.cache()
def my_method(a, b, c):
return a ** b ** c
```
### Options
`expiration`: Number of seconds to keep the result in the cache. Defaults to 60 seconds when not specified.
e.g.
```python
@c.cache(expiration=100)
def my_method():
...
```
`signature_generator`: Callable function that generates the signature to cache on. The default signature generator will be used if not specified.
e.g.
```python
def sig_gen(*args, **kwargs):
return "?".join(args)
@c.cache(signature_generator=sig_gen)
def my_method():
...
```
`invalidator`: Boolean to determine whether or not to return a cache invalidating function
e.g.
```python
@c.cache(invalidator=True)
def my_method():
...
```
Now when you call `my_method`, it will return two values. The first value is the cached return if a cache hit occurs, otherwise it's the return value from executing the function.
The second value is a callable function to invalidate the cache.
```python
return_value, invalidator = my_method()
```
To invalidate the cached return, just call the invalidator:
```python
invalidator()
```
# Custom Backends
You can use any backend for the cache by implementing the [base class](https://github.com/alexk307/cache_deco/blob/master/backends/backend_base.py)
# Contributing
Check for any open issues, or open one yourself! All contributions are appreciated.
# Tests
`nosetests`