An easy-to-use cache module
Project description
mecache
An easy-to-use cache module
How to use
Run pip install mecache
or pipenv install mecache
to install.
Built-in two cache modes, file cache mode, redis cache mode.
You can control the time of cache failure by using the cache parameters.
redis modes
from mecache import Redis
# Refer to https://redis-py.readthedocs.io/en/latest/ for all parameters
redis = Redis(host="127.0.0.1", port='6379', db=0, password="password")
# Cache failure after 60 seconds
@redis.cache(60)
def do(x, y):
import time
time.sleep(2)
return x+y
asynchronous redis modes
from mecache import AioRedis
# Refer to https://aioredis.readthedocs.io/en/latest/api_reference.html#aioredis.create_redis_pool for all parameters
file = await AioRedis('redis://localhost')
# Cache failure after 60 seconds
@file.cache(60)
async def do(x, y):
return await do.something
file modes
from mecache import File
# CACHE_PATH like '/var/tmp/test-cache'
file = File("CACHE_PATH")
# Cache failure after 60 seconds
@file.cache(60)
def do(x, y):
import time
time.sleep(2)
return x+y
asynchronous file modes
from mecache import AioFile
# CACHE_PATH like '/var/tmp/test-cache'
file = AioFile("CACHE_PATH")
# Cache failure after 60 seconds
@file.cache(60)
async def do(x, y):
return await do.something
Advanced usage
If the parameters of a function are difficult to serialize using pickle, you can specify the rules that generate key by customizing keyf
. The return value of the function keyf
must be a string.
# a example in django view function
def key_by_user(request):
return request.user.username
@file.cache(60*60, keyf=key_by_user)
def home(request):
return render(request, 'home.html')
You can also overwrite keyf
for all cache. This is a example:
from mecache import File
class CustomFile(File):
@staticmethod
def keyf(*args, **kwargs):
string = do.something
return string
file = CustomFile("CACHE_PATH")
Custom made
If you need a custom cache, you can use BaseCache
or AioBaseCache
to create your cache class. Like this
from mecache import BaseCache
class CustomCache(BaseCache):
def get_cache(self, func, key, max_time):
qual = func.__qualname__
return get(qual+":"+key)
def set_cache(self, result, func, key, max_time):
qual = func.__qualname__
set(qual+":"+key, result, ex=time.time()+max_time)
Project details
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.
Source Distribution
mecache-1.4.2.tar.gz
(5.1 kB
view hashes)
Built Distribution
Close
Hashes for mecache-1.4.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b110d07e9fcf40bc1b9a23fb298c7c4c92f04dff12100d63d2c23b05e24c3d34 |
|
MD5 | 266df0e4e38091289415eaac12fbfeb1 |
|
BLAKE2b-256 | f5acf5bf64e4b502502531ff000368570781fd2fcc09b73c9280d92a82a49378 |