multi backend asyncio cache
Project description
Asyncio cache supporting multiple backends (memory, redis and memcached).
This library aims for simplicity over specialization. All caches contain the same minimum interface which consists on the following functions:
add: Only adds key/value if key does not exist.
get: Retrieve value identified by key.
set: Sets key/value.
multi_get: Retrieves multiple key/values.
multi_set: Sets multiple key/values.
exists: Returns True if key exists False otherwise.
increment: Increment the value stored in the given key.
delete: Deletes key and returns number of deleted items.
clear: Clears the items stored.
raw: Executes the specified command using the underlying client.
Installing
Do pip install aiocache
Usage
Using a cache is as simple as
>>> import asyncio
>>> loop = asyncio.get_event_loop()
>>> from aiocache import SimpleMemoryCache # Here you can also use RedisCache and MemcachedCache
>>> cache = SimpleMemoryCache()
>>> loop.run_until_complete(cache.set('key', 'value'))
True
>>> loop.run_until_complete(cache.get('key'))
'value'Or as a decorator
import asyncio
from collections import namedtuple
from aiocache import cached, RedisCache
from aiocache.serializers import PickleSerializer
# With this we can store python objects in backends like Redis!
Result = namedtuple('Result', "content, status")
cache = RedisCache(endpoint="127.0.0.1", port=6379, namespace="main")
@cached(
ttl=10, cache=RedisCache, key="key", serializer=PickleSerializer(), port=6379, namespace="main")
async def cached_call():
print("Sleeping for three seconds zzzz.....")
await asyncio.sleep(3)
return Result("content", 200)
def run():
loop = asyncio.get_event_loop()
loop.run_until_complete(cached_call())
loop.run_until_complete(cached_call())
loop.run_until_complete(cached_call())
loop.run_until_complete(cache.delete("key"))
if __name__ == "__main__":
run()You can also setup cache aliases like in Django settings:
import asyncio
from aiocache import caches, SimpleMemoryCache, RedisCache
from aiocache.serializers import DefaultSerializer, PickleSerializer
# You can use either classes or strings for referencing classes
caches.set_config({
'default': {
'cache': "aiocache.SimpleMemoryCache",
'serializer': {
'class': "aiocache.serializers.DefaultSerializer"
}
},
'redis_alt': {
'cache': "aiocache.RedisCache",
'endpoint': "127.0.0.1",
'port': 6379,
'timeout': 1,
'serializer': {
'class': "aiocache.serializers.PickleSerializer"
},
'plugins': [
{'class': "aiocache.plugins.HitMissRatioPlugin"},
{'class': "aiocache.plugins.TimingPlugin"}
]
}
})
async def default_cache():
cache = caches.get('default') # This always returns the SAME instance
await cache.set("key", "value")
assert await cache.get("key") == "value"
async def alt_cache():
cache = caches.create('redis_alt') # This creates a NEW instance on every call
await cache.set("key", "value")
assert await cache.get("key") == "value"
def test_alias():
loop = asyncio.get_event_loop()
loop.run_until_complete(default_cache())
loop.run_until_complete(alt_cache())
loop.run_until_complete(caches.get('redis_alt').delete("key"))
if __name__ == "__main__":
test_alias()How does it work
Aiocache provides 3 main entities:
backends: Allow you specify which backend you want to use for your cache. Currently supporting: SimpleMemoryCache, RedisCache using aioredis and MemCache using aiomcache.
serializers: Serialize and deserialize the data between your code and the backends. This allows you to save any Python object into your cache. Currently supporting: DefaultSerializer, PickleSerializer, JsonSerializer. But you can also build custom ones.
plugins: Implement a hooks system that allows to execute extra behavior before and after of each command.
If you are missing an implementation of backend, serializer or plugin you think it could be interesting for the package, do not hesitate to open a new issue.
Those 3 entities combine during some of the cache operations to apply the desired command (backend), data transformation (serializer) and pre/post hooks (plugins). To have a better vision of what happens, here you can check how set function works in aiocache:
Amazing examples
In examples folder you can check different use cases:
Documentation
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
