decorators.py

__all__ = ['function_cache']
from functools import wraps
from inspect import signature
import logging

from .backends import get_cache_backend

logger = logging.getLogger(__name__)


def function_cache(name='default', keys=None, key_prefix=None, **kwargs):
    cache_backend = get_cache_backend(name, keys=keys, **kwargs)
    _key_prefix = key_prefix

    def decorator(decorated_func):
        sig = signature(decorated_func)
        pass_cache_key = '_cache_key' in sig.parameters or any(param.kind == param.VAR_KEYWORD for param in sig.parameters.values())

        cache_key_prefix = f'{decorated_func.__module__}.{decorated_func.__name__}-' if _key_prefix is None else _key_prefix

        @wraps(decorated_func)
        def wrapper(*wrapped_args, **wrapped_kwargs):
            cache_key = f'{cache_key_prefix}{cache_backend.compute_key(wrapped_args, wrapped_kwargs)}'

            cache_hit = cache_backend.exists(cache_key)
            logger.debug(f'Cache {"hit" if cache_hit else "miss"} for cache key <{cache_key}>.')
            if cache_hit:
                return cache_backend.get(cache_key)

            if pass_cache_key:
                result = decorated_func(*wrapped_args, **wrapped_kwargs, _cache_key=cache_key)
            else:
                result = decorated_func(*wrapped_args, **wrapped_kwargs)
            #end if

            cache_backend.put(cache_key, result)

            return result
        #end def

        return wrapper
    #end def

    return decorator
#end def