File size: 9,601 Bytes
d1ceb73 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 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 130 131 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 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
import asyncio
import dataclasses
import sys
from asyncio.coroutines import _is_coroutine # type: ignore[attr-defined]
from functools import _CacheInfo, _make_key, partial, partialmethod
from typing import (
Any,
Callable,
Coroutine,
Generic,
Hashable,
Optional,
OrderedDict,
Set,
Type,
TypedDict,
TypeVar,
Union,
cast,
final,
overload,
)
if sys.version_info >= (3, 11):
from typing import Self
else:
from typing_extensions import Self
__version__ = "2.0.4"
__all__ = ("alru_cache",)
_T = TypeVar("_T")
_R = TypeVar("_R")
_Coro = Coroutine[Any, Any, _R]
_CB = Callable[..., _Coro[_R]]
_CBP = Union[_CB[_R], "partial[_Coro[_R]]", "partialmethod[_Coro[_R]]"]
@final
class _CacheParameters(TypedDict):
typed: bool
maxsize: Optional[int]
tasks: int
closed: bool
@final
@dataclasses.dataclass
class _CacheItem(Generic[_R]):
fut: "asyncio.Future[_R]"
later_call: Optional[asyncio.Handle]
def cancel(self) -> None:
if self.later_call is not None:
self.later_call.cancel()
self.later_call = None
@final
class _LRUCacheWrapper(Generic[_R]):
def __init__(
self,
fn: _CB[_R],
maxsize: Optional[int],
typed: bool,
ttl: Optional[float],
) -> None:
try:
self.__module__ = fn.__module__
except AttributeError:
pass
try:
self.__name__ = fn.__name__
except AttributeError:
pass
try:
self.__qualname__ = fn.__qualname__
except AttributeError:
pass
try:
self.__doc__ = fn.__doc__
except AttributeError:
pass
try:
self.__annotations__ = fn.__annotations__
except AttributeError:
pass
try:
self.__dict__.update(fn.__dict__)
except AttributeError:
pass
# set __wrapped__ last so we don't inadvertently copy it
# from the wrapped function when updating __dict__
self._is_coroutine = _is_coroutine
self.__wrapped__ = fn
self.__maxsize = maxsize
self.__typed = typed
self.__ttl = ttl
self.__cache: OrderedDict[Hashable, _CacheItem[_R]] = OrderedDict()
self.__closed = False
self.__hits = 0
self.__misses = 0
self.__tasks: Set["asyncio.Task[_R]"] = set()
def cache_invalidate(self, /, *args: Hashable, **kwargs: Any) -> bool:
key = _make_key(args, kwargs, self.__typed)
cache_item = self.__cache.pop(key, None)
if cache_item is None:
return False
else:
cache_item.cancel()
return True
def cache_clear(self) -> None:
self.__hits = 0
self.__misses = 0
for c in self.__cache.values():
if c.later_call:
c.later_call.cancel()
self.__cache.clear()
self.__tasks.clear()
async def cache_close(self, *, wait: bool = False) -> None:
self.__closed = True
tasks = list(self.__tasks)
if not tasks:
return
if not wait:
for task in tasks:
if not task.done():
task.cancel()
await asyncio.gather(*tasks, return_exceptions=True)
def cache_info(self) -> _CacheInfo:
return _CacheInfo(
self.__hits,
self.__misses,
self.__maxsize,
len(self.__cache),
)
def cache_parameters(self) -> _CacheParameters:
return _CacheParameters(
maxsize=self.__maxsize,
typed=self.__typed,
tasks=len(self.__tasks),
closed=self.__closed,
)
def _cache_hit(self, key: Hashable) -> None:
self.__hits += 1
self.__cache.move_to_end(key)
def _cache_miss(self, key: Hashable) -> None:
self.__misses += 1
def _task_done_callback(
self, fut: "asyncio.Future[_R]", key: Hashable, task: "asyncio.Task[_R]"
) -> None:
self.__tasks.discard(task)
cache_item = self.__cache.get(key)
if self.__ttl is not None and cache_item is not None:
loop = asyncio.get_running_loop()
cache_item.later_call = loop.call_later(
self.__ttl, self.__cache.pop, key, None
)
if task.cancelled():
fut.cancel()
return
exc = task.exception()
if exc is not None:
fut.set_exception(exc)
return
fut.set_result(task.result())
async def __call__(self, /, *fn_args: Any, **fn_kwargs: Any) -> _R:
if self.__closed:
raise RuntimeError(f"alru_cache is closed for {self}")
loop = asyncio.get_running_loop()
key = _make_key(fn_args, fn_kwargs, self.__typed)
cache_item = self.__cache.get(key)
if cache_item is not None:
if not cache_item.fut.done():
self._cache_hit(key)
return await asyncio.shield(cache_item.fut)
exc = cache_item.fut._exception
if exc is None:
self._cache_hit(key)
return cache_item.fut.result()
else:
# exception here
cache_item = self.__cache.pop(key)
cache_item.cancel()
fut = loop.create_future()
coro = self.__wrapped__(*fn_args, **fn_kwargs)
task: asyncio.Task[_R] = loop.create_task(coro)
self.__tasks.add(task)
task.add_done_callback(partial(self._task_done_callback, fut, key))
self.__cache[key] = _CacheItem(fut, None)
if self.__maxsize is not None and len(self.__cache) > self.__maxsize:
dropped_key, cache_item = self.__cache.popitem(last=False)
cache_item.cancel()
self._cache_miss(key)
return await asyncio.shield(fut)
def __get__(
self, instance: _T, owner: Optional[Type[_T]]
) -> Union[Self, "_LRUCacheWrapperInstanceMethod[_R, _T]"]:
if owner is None:
return self
else:
return _LRUCacheWrapperInstanceMethod(self, instance)
@final
class _LRUCacheWrapperInstanceMethod(Generic[_R, _T]):
def __init__(
self,
wrapper: _LRUCacheWrapper[_R],
instance: _T,
) -> None:
try:
self.__module__ = wrapper.__module__
except AttributeError:
pass
try:
self.__name__ = wrapper.__name__
except AttributeError:
pass
try:
self.__qualname__ = wrapper.__qualname__
except AttributeError:
pass
try:
self.__doc__ = wrapper.__doc__
except AttributeError:
pass
try:
self.__annotations__ = wrapper.__annotations__
except AttributeError:
pass
try:
self.__dict__.update(wrapper.__dict__)
except AttributeError:
pass
# set __wrapped__ last so we don't inadvertently copy it
# from the wrapped function when updating __dict__
self._is_coroutine = _is_coroutine
self.__wrapped__ = wrapper.__wrapped__
self.__instance = instance
self.__wrapper = wrapper
def cache_invalidate(self, /, *args: Hashable, **kwargs: Any) -> bool:
return self.__wrapper.cache_invalidate(self.__instance, *args, **kwargs)
def cache_clear(self) -> None:
self.__wrapper.cache_clear()
async def cache_close(
self, *, cancel: bool = False, return_exceptions: bool = True
) -> None:
await self.__wrapper.cache_close()
def cache_info(self) -> _CacheInfo:
return self.__wrapper.cache_info()
def cache_parameters(self) -> _CacheParameters:
return self.__wrapper.cache_parameters()
async def __call__(self, /, *fn_args: Any, **fn_kwargs: Any) -> _R:
return await self.__wrapper(self.__instance, *fn_args, **fn_kwargs)
def _make_wrapper(
maxsize: Optional[int],
typed: bool,
ttl: Optional[float] = None,
) -> Callable[[_CBP[_R]], _LRUCacheWrapper[_R]]:
def wrapper(fn: _CBP[_R]) -> _LRUCacheWrapper[_R]:
origin = fn
while isinstance(origin, (partial, partialmethod)):
origin = origin.func
if not asyncio.iscoroutinefunction(origin):
raise RuntimeError(f"Coroutine function is required, got {fn!r}")
# functools.partialmethod support
if hasattr(fn, "_make_unbound_method"):
fn = fn._make_unbound_method()
return _LRUCacheWrapper(cast(_CB[_R], fn), maxsize, typed, ttl)
return wrapper
@overload
def alru_cache(
maxsize: Optional[int] = 128,
typed: bool = False,
*,
ttl: Optional[float] = None,
) -> Callable[[_CBP[_R]], _LRUCacheWrapper[_R]]:
...
@overload
def alru_cache(
maxsize: _CBP[_R],
/,
) -> _LRUCacheWrapper[_R]:
...
def alru_cache(
maxsize: Union[Optional[int], _CBP[_R]] = 128,
typed: bool = False,
*,
ttl: Optional[float] = None,
) -> Union[Callable[[_CBP[_R]], _LRUCacheWrapper[_R]], _LRUCacheWrapper[_R]]:
if maxsize is None or isinstance(maxsize, int):
return _make_wrapper(maxsize, typed, ttl)
else:
fn = cast(_CB[_R], maxsize)
if callable(fn) or hasattr(fn, "_make_unbound_method"):
return _make_wrapper(128, False, None)(fn)
raise NotImplementedError(f"{fn!r} decorating is not supported")
|