jsons._cache.cached() - Code Metrics - ramonhagenaars/jsons - Measure and Improve Code Quality continuously with Scrutinizer

jsons._cache.cached() A
last analyzed 2022-06-09 19:52 UTC

↳ Parent: jsons._cache

Complexity

Conditions

Size

Total Lines	11
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	4
dl	0
loc	11
rs	10
c	0
b	0
f	0
cc	1
nop	1

"""
PRIVATE MODULE: do not import (from) it directly.

This module contains functionality for caching functions.
"""
from collections import deque
from functools import lru_cache, update_wrapper
from typing import Callable


class _Wrapper:
    """
    A wrapper around a function that needs to be cached. This wrapper allows
    for a single point from which cache can be cleared.
    """
    instances = deque([])

    def __init__(self, wrapped):
        self.wrapped = wrapped
        self.instances.append(self)

    @lru_cache(typed=True)
    def __call__(self, *args, **kwargs):
        return self.wrapped(*args, **kwargs)


def cached(decorated: Callable):
    """
    Alternative for ``functools.lru_cache``. By decorating a function with
    ``cached``, you can clear the cache of that function by calling
    ``clear()``.
    :param decorated: the decorated function.
    :return: a wrapped function.
    """
    wrapper = _Wrapper(decorated)
    update_wrapper(wrapper=wrapper, wrapped=decorated)
    return wrapper


def clear():
    """
    Clear all cache of functions that were cached using ``cached``.
    :return: None.
    """
    for w in _Wrapper.instances:
        w.__call__.cache_clear()


1			"""
2			PRIVATE MODULE: do not import (from) it directly.
3
4			This module contains functionality for caching functions.
5			"""
6			from collections import deque
7			from functools import lru_cache, update_wrapper
8			from typing import Callable
9
10
11			class _Wrapper:
12			"""
13			A wrapper around a function that needs to be cached. This wrapper allows
14			for a single point from which cache can be cleared.
15			"""
16			instances = deque([])
17
18			def __init__(self, wrapped):
19			self.wrapped = wrapped
20			self.instances.append(self)
21
22			@lru_cache(typed=True)
23			def __call__(self, args, *kwargs):
24			return self.wrapped(args, *kwargs)
25
26
27			def cached(decorated: Callable):
28			"""
29			Alternative for ``functools.lru_cache``. By decorating a function with
30			``cached``, you can clear the cache of that function by calling
31			``clear()``.
32			:param decorated: the decorated function.
33			:return: a wrapped function.
34			"""
35			wrapper = _Wrapper(decorated)
36			update_wrapper(wrapper=wrapper, wrapped=decorated)
37			return wrapper
38
39
40			def clear():
41			"""
42			Clear all cache of functions that were cached using ``cached``.
43			:return: None.
44			"""
45			for w in _Wrapper.instances:
46			w.__call__.cache_clear()
47

ramonhagenaars / jsons

jsons._cache.cached() A last analyzed 2022-06-09 19:52 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

jsons._cache.cached() A
last analyzed 2022-06-09 19:52 UTC