Pular para conteúdo

inmemory

cachetoolz.backend.inmemory

In backend module.

cachetoolz.backend.inmemory.Cached dataclass

Cached object.

Attributes:

Name Type Description
value str

Value to cache encoded.
expires_at datetime.datetime

Expiry time.

Examples:

>>> Cached(value='foo', expires_at=datetime.now())
Source code in cachetoolz/backend/inmemory.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
@dataclass
class Cached:
    """
    Cached object.

    Attributes
    ----------
    value : str
        Value to cache encoded.
    expires_at : datetime.datetime
        Expiry time.

    Examples
    --------
    >>> Cached(value='foo', expires_at=datetime.now())
    """

    value: str
    expires_at: datetime

cachetoolz.backend.inmemory.InMemory

Bases: BackendABC

In memory backend.

This backend is used to store caches in memory synchronous.

Source code in cachetoolz/backend/inmemory.py 
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
class InMemory(BackendABC):
    """
    In memory backend.

    This backend is used to store caches in memory synchronous.
    """

    def __init__(self):
        """Initialize the instance."""
        self._store: Store = defaultdict(lambda: {})

    def __repr__(self):
        """Creates a visual representation of the instance."""
        store = walk_values(
            partial(walk_values, asdict), dict(self._store.items())
        )
        return f'InMemory({store})'

    def get(self, key: str) -> Any:
        """
        Get a value if not expired.

        Parameters
        ----------
        key : str
            Cache identifier key.

        Returns
        -------
        with_cache : Any
            Value cached.
        without_cache : None
            If not exists or expired.
        """
        self.logger.debug("Get 'key=%s'", key)

        namespace, key_hash = self._separate_namespace(key)

        if cached := self._store[namespace].get(key_hash):
            if cached.expires_at >= datetime.now():
                return cached.value

            del self._store[namespace][key_hash]

        self.logger.debug("No cache to 'key=%s'", key)

    def set(self, key: str, value: str, expires_at: timedelta) -> None:
        """
        Set a value with expires time.

        Parameters
        ----------
        key : str
            Cache identifier key.
        value : str
            Value to cache encoded.
        expires_at : datetime.timedelta
            Expiry time.
        """
        self.logger.debug(
            "Set 'key=%s', 'value=%s', 'expires_at=%s'",
            key,
            value,
            expires_at,
        )

        namespace, key_hash = self._separate_namespace(key)

        self._store[namespace][key_hash] = Cached(
            value=value,
            expires_at=datetime.now() + expires_at,
        )

    def clear(self, namespace: str) -> None:
        """
        Clear a namespace.

        Parameters
        ----------
        namespace : str
            Namespace to cache.
        """
        self.logger.debug("Clear 'namespace=%s'", namespace)

        self._store.pop(namespace)

get(key: str) -> Any

Get a value if not expired.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required

Returns:

Name Type Description
with_cache Any

Value cached.
without_cache None

If not exists or expired.
Source code in cachetoolz/backend/inmemory.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def get(self, key: str) -> Any:
    """
    Get a value if not expired.

    Parameters
    ----------
    key : str
        Cache identifier key.

    Returns
    -------
    with_cache : Any
        Value cached.
    without_cache : None
        If not exists or expired.
    """
    self.logger.debug("Get 'key=%s'", key)

    namespace, key_hash = self._separate_namespace(key)

    if cached := self._store[namespace].get(key_hash):
        if cached.expires_at >= datetime.now():
            return cached.value

        del self._store[namespace][key_hash]

    self.logger.debug("No cache to 'key=%s'", key)

set(key: str, value: str, expires_at: timedelta) -> None

Set a value with expires time.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required
value str

Value to cache encoded.

 required
expires_at datetime.timedelta

Expiry time.

 required
Source code in cachetoolz/backend/inmemory.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
def set(self, key: str, value: str, expires_at: timedelta) -> None:
    """
    Set a value with expires time.

    Parameters
    ----------
    key : str
        Cache identifier key.
    value : str
        Value to cache encoded.
    expires_at : datetime.timedelta
        Expiry time.
    """
    self.logger.debug(
        "Set 'key=%s', 'value=%s', 'expires_at=%s'",
        key,
        value,
        expires_at,
    )

    namespace, key_hash = self._separate_namespace(key)

    self._store[namespace][key_hash] = Cached(
        value=value,
        expires_at=datetime.now() + expires_at,
    )

clear(namespace: str) -> None

Clear a namespace.

Parameters:

Name Type Description Default
namespace str

Namespace to cache.

 required
Source code in cachetoolz/backend/inmemory.py 
118
119
120
121
122
123
124
125
126
127
128
129
def clear(self, namespace: str) -> None:
    """
    Clear a namespace.

    Parameters
    ----------
    namespace : str
        Namespace to cache.
    """
    self.logger.debug("Clear 'namespace=%s'", namespace)

    self._store.pop(namespace)

cachetoolz.backend.inmemory.AsyncInMemory

Bases: AsyncBackendABC

Async in memory backend.

This backend is used to store caches in memory asynchronous.

Source code in cachetoolz/backend/inmemory.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
class AsyncInMemory(AsyncBackendABC):
    """
    Async in memory backend.

    This backend is used to store caches in memory asynchronous.
    """

    def __init__(self):
        """Initialize the instance."""
        self._store: Store = defaultdict(lambda: {})
        self._lock: Lock = Lock()

    def __repr__(self):
        """Creates a visual representation of the instance."""
        store = walk_values(
            partial(walk_values, asdict), dict(self._store.items())
        )
        return f'AsyncInMemory({store})'

    async def get(self, key: str) -> Optional[str]:
        """
        Get a value if not expired.

        Parameters
        ----------
        key : str
            Cache identifier key.

        Returns
        -------
        with_cache : Any
            Value cached.
        without_cache : None
            If not exists or expired.
        """
        self.logger.debug("Get 'key=%s'", key)

        namespace, key_hash = self._separate_namespace(key)

        async with self._lock:
            if cached := self._store[namespace].get(key_hash):
                if cached.expires_at >= datetime.now():
                    return cached.value
                del self._store[namespace][key_hash]

        self.logger.debug("No cache to 'key=%s'", key)
        return None

    async def set(self, key: str, value: str, expires_at: timedelta) -> None:
        """
        Set a value with expires time.

        Parameters
        ----------
        key : str
            Cache identifier key.
        value : str
            Value to cache encoded.
        expires_at : datetime.timedelta
            Expiry time.
        """
        self.logger.debug(
            "Set 'key=%s', 'value=%s', 'expires_at=%s'",
            key,
            value,
            expires_at,
        )

        namespace, key_hash = self._separate_namespace(key)

        async with self._lock:
            self._store[namespace][key_hash] = Cached(
                value=value,
                expires_at=datetime.now() + expires_at,
            )

    async def clear(self, namespace: str) -> None:
        """
        Clear a namespace.

        Parameters
        ----------
        namespace : str
            Namespace to cache.
        """
        self.logger.debug("Clear 'namespace=%s'", namespace)

        async with self._lock:
            self._store.pop(namespace, None)

get(key: str) -> Optional[str] async

Get a value if not expired.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required

Returns:

Name Type Description
with_cache Any

Value cached.
without_cache None

If not exists or expired.
Source code in cachetoolz/backend/inmemory.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
async def get(self, key: str) -> Optional[str]:
    """
    Get a value if not expired.

    Parameters
    ----------
    key : str
        Cache identifier key.

    Returns
    -------
    with_cache : Any
        Value cached.
    without_cache : None
        If not exists or expired.
    """
    self.logger.debug("Get 'key=%s'", key)

    namespace, key_hash = self._separate_namespace(key)

    async with self._lock:
        if cached := self._store[namespace].get(key_hash):
            if cached.expires_at >= datetime.now():
                return cached.value
            del self._store[namespace][key_hash]

    self.logger.debug("No cache to 'key=%s'", key)
    return None

set(key: str, value: str, expires_at: timedelta) -> None async

Set a value with expires time.

Parameters:

Name Type Description Default
key str

Cache identifier key.

 required
value str

Value to cache encoded.

 required
expires_at datetime.timedelta

Expiry time.

 required
Source code in cachetoolz/backend/inmemory.py 
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
async def set(self, key: str, value: str, expires_at: timedelta) -> None:
    """
    Set a value with expires time.

    Parameters
    ----------
    key : str
        Cache identifier key.
    value : str
        Value to cache encoded.
    expires_at : datetime.timedelta
        Expiry time.
    """
    self.logger.debug(
        "Set 'key=%s', 'value=%s', 'expires_at=%s'",
        key,
        value,
        expires_at,
    )

    namespace, key_hash = self._separate_namespace(key)

    async with self._lock:
        self._store[namespace][key_hash] = Cached(
            value=value,
            expires_at=datetime.now() + expires_at,
        )

clear(namespace: str) -> None async

Clear a namespace.

Parameters:

Name Type Description Default
namespace str

Namespace to cache.

 required
Source code in cachetoolz/backend/inmemory.py 
208
209
210
211
212
213
214
215
216
217
218
219
220
async def clear(self, namespace: str) -> None:
    """
    Clear a namespace.

    Parameters
    ----------
    namespace : str
        Namespace to cache.
    """
    self.logger.debug("Clear 'namespace=%s'", namespace)

    async with self._lock:
        self._store.pop(namespace, None)