cachify 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

cachify/features/never_die.py

@@ -1,219 +1,219 @@
-import asyncio
-import functools
-import inspect
-import threading
-import time
-from asyncio import AbstractEventLoop
-from concurrent.futures import Future as ConcurrentFuture
-from dataclasses import dataclass
-from typing import Any, Callable
-
-from cachify.config import logger
-from cachify.types import CacheConfig, CacheKeyFunction, Number
-from cachify.utils.arguments import create_cache_key
-
-_NEVER_DIE_THREAD: threading.Thread | None = None
-_NEVER_DIE_LOCK: threading.Lock = threading.Lock()
-_NEVER_DIE_REGISTRY: list["NeverDieCacheEntry"] = []
-_NEVER_DIE_CACHE_THREADS: dict[str, threading.Thread] = {}
-_NEVER_DIE_CACHE_FUTURES: dict[str, ConcurrentFuture] = {}
-
-_MAX_BACKOFF: int = 10
-_BACKOFF_MULTIPLIER: float = 1.25
-_REFRESH_INTERVAL_SECONDS: float = 0.1
-
-
-@dataclass
-class NeverDieCacheEntry:
-    function: Callable[..., Any]
-    ttl: Number
-    args: tuple
-    kwargs: dict
-    cache_key_func: CacheKeyFunction | None
-    ignore_fields: tuple[str, ...]
-    loop: AbstractEventLoop | None
-    config: CacheConfig
-
-    def __post_init__(self):
-        self._backoff: float = 1
-        self._expires_at: float = time.monotonic() + self.ttl
-
-    @functools.cached_property
-    def cache_key(self) -> str:
-        return create_cache_key(
-            self.function,
-            self.cache_key_func,
-            self.ignore_fields,
-            self.args,
-            self.kwargs,
-        )
-
-    def __eq__(self, other: Any) -> bool:
-        if not isinstance(other, NeverDieCacheEntry):
-            return False
-        return self.cache_key == other.cache_key
-
-    def __hash__(self) -> int:
-        return hash(self.cache_key)
-
-    def is_expired(self) -> bool:
-        return time.monotonic() > self._expires_at
-
-    def reset(self):
-        self._backoff = 1
-        self._expires_at = time.monotonic() + self.ttl
-
-    def revive(self):
-        self._backoff = min(self._backoff * _BACKOFF_MULTIPLIER, _MAX_BACKOFF)
-        self._expires_at = time.monotonic() + self.ttl * self._backoff
-
-
-def _run_sync_function_and_cache(entry: NeverDieCacheEntry):
-    """Run a function and cache its result"""
-    try:
-        with entry.config.sync_lock(entry.cache_key):
-            result = entry.function(*entry.args, **entry.kwargs)
-            entry.config.storage.set(entry.cache_key, result, None)
-            entry.reset()
-    except BaseException:
-        entry.revive()
-        logger.debug(
-            "Exception caching function with never_die",
-            extra={"function": entry.function.__qualname__},
-            exc_info=True,
-        )
-
-
-async def _run_async_function_and_cache(entry: NeverDieCacheEntry):
-    """Run a function and cache its result"""
-    try:
-        async with entry.config.async_lock(entry.cache_key):
-            result = await entry.function(*entry.args, **entry.kwargs)
-            await entry.config.storage.aset(entry.cache_key, result, None)
-            entry.reset()
-    except BaseException:
-        entry.revive()
-        logger.debug(
-            "Exception caching function with never_die",
-            extra={"function": entry.function.__qualname__},
-            exc_info=True,
-        )
-
-
-def _cache_is_being_set(entry: NeverDieCacheEntry) -> bool:
-    if entry.loop:
-        return entry.cache_key in _NEVER_DIE_CACHE_FUTURES and not _NEVER_DIE_CACHE_FUTURES[entry.cache_key].done()
-    return entry.cache_key in _NEVER_DIE_CACHE_THREADS and _NEVER_DIE_CACHE_THREADS[entry.cache_key].is_alive()
-
-
-def _clear_dead_futures():
-    """Clear dead futures from the cache future registry"""
-    for cache_key, thread in list(_NEVER_DIE_CACHE_FUTURES.items()):
-        if thread.done():
-            del _NEVER_DIE_CACHE_FUTURES[cache_key]
-
-
-def _clear_dead_threads():
-    """Clear dead threads from the cache thread registry"""
-    for cache_key, thread in list(_NEVER_DIE_CACHE_THREADS.items()):
-        if thread.is_alive():
-            continue
-        del _NEVER_DIE_CACHE_THREADS[cache_key]
-
-
-def _refresh_never_die_caches():
-    """Background thread function that periodically refreshes never_die cache entries"""
-    while True:
-        try:
-            for entry in list(_NEVER_DIE_REGISTRY):
-                if not entry.is_expired():
-                    continue
-
-                if _cache_is_being_set(entry):
-                    continue
-
-                if not entry.loop:  # sync
-                    thread = threading.Thread(target=_run_sync_function_and_cache, args=(entry,), daemon=True)
-                    thread.start()
-                    _NEVER_DIE_CACHE_THREADS[entry.cache_key] = thread
-                    continue
-
-                if entry.loop.is_closed():
-                    logger.debug(
-                        f"Loop is closed, skipping future creation",
-                        extra={"function": entry.function.__qualname__},
-                        exc_info=True,
-                    )
-                    continue
-
-                try:
-                    coroutine = _run_async_function_and_cache(entry)
-                    future = asyncio.run_coroutine_threadsafe(coroutine, entry.loop)
-                except RuntimeError:
-                    coroutine.close()
-                    logger.debug(
-                        f"Loop is closed, skipping future creation",
-                        extra={"function": entry.function.__qualname__},
-                        exc_info=True,
-                    )
-                    continue
-
-                _NEVER_DIE_CACHE_FUTURES[entry.cache_key] = future
-        finally:
-            time.sleep(_REFRESH_INTERVAL_SECONDS)
-            _clear_dead_futures()
-            _clear_dead_threads()
-
-
-def _start_never_die_thread():
-    """Start the background thread if it's not already running"""
-    global _NEVER_DIE_THREAD
-    with _NEVER_DIE_LOCK:
-        if _NEVER_DIE_THREAD and _NEVER_DIE_THREAD.is_alive():
-            return
-
-        _NEVER_DIE_THREAD = threading.Thread(target=_refresh_never_die_caches, daemon=True)
-        _NEVER_DIE_THREAD.start()
-
-
-def register_never_die_function(
-    function: Callable[..., Any],
-    ttl: Number,
-    args: tuple,
-    kwargs: dict,
-    cache_key_func: CacheKeyFunction | None,
-    ignore_fields: tuple[str, ...],
-    config: CacheConfig,
-):
-    """Register a function for never_die cache refreshing"""
-    is_async = inspect.iscoroutinefunction(function)
-
-    entry = NeverDieCacheEntry(
-        function=function,
-        ttl=ttl,
-        args=args,
-        kwargs=kwargs,
-        cache_key_func=cache_key_func,
-        ignore_fields=ignore_fields,
-        loop=asyncio.get_running_loop() if is_async else None,
-        config=config,
-    )
-
-    with _NEVER_DIE_LOCK:
-        if entry not in _NEVER_DIE_REGISTRY:
-            _NEVER_DIE_REGISTRY.append(entry)
-
-    _start_never_die_thread()
-
-
-def clear_never_die_registry():
-    """
-    Clear all entries from the never_die registry.
-
-    Useful for testing to prevent background threads from
-    accessing resources that have been cleaned up.
-    """
-    with _NEVER_DIE_LOCK:
-        _NEVER_DIE_REGISTRY.clear()
-        _NEVER_DIE_CACHE_THREADS.clear()
-        _NEVER_DIE_CACHE_FUTURES.clear()
+import asyncio
+import functools
+import inspect
+import threading
+import time
+from asyncio import AbstractEventLoop
+from concurrent.futures import Future as ConcurrentFuture
+from dataclasses import dataclass
+from typing import Any, Callable
+
+from cachify.config import logger
+from cachify.types import CacheConfig, CacheKeyFunction, Number
+from cachify.utils.arguments import create_cache_key
+
+_NEVER_DIE_THREAD: threading.Thread | None = None
+_NEVER_DIE_LOCK: threading.Lock = threading.Lock()
+_NEVER_DIE_REGISTRY: list["NeverDieCacheEntry"] = []
+_NEVER_DIE_CACHE_THREADS: dict[str, threading.Thread] = {}
+_NEVER_DIE_CACHE_FUTURES: dict[str, ConcurrentFuture] = {}
+
+_MAX_BACKOFF: int = 10
+_BACKOFF_MULTIPLIER: float = 1.25
+_REFRESH_INTERVAL_SECONDS: float = 0.1
+
+
+@dataclass
+class NeverDieCacheEntry:
+    function: Callable[..., Any]
+    ttl: Number
+    args: tuple
+    kwargs: dict
+    cache_key_func: CacheKeyFunction | None
+    ignore_fields: tuple[str, ...]
+    loop: AbstractEventLoop | None
+    config: CacheConfig
+
+    def __post_init__(self):
+        self._backoff: float = 1
+        self._expires_at: float = time.monotonic() + self.ttl
+
+    @functools.cached_property
+    def cache_key(self) -> str:
+        return create_cache_key(
+            self.function,
+            self.cache_key_func,
+            self.ignore_fields,
+            self.args,
+            self.kwargs,
+        )
+
+    def __eq__(self, other: Any) -> bool:
+        if not isinstance(other, NeverDieCacheEntry):
+            return False
+        return self.cache_key == other.cache_key
+
+    def __hash__(self) -> int:
+        return hash(self.cache_key)
+
+    def is_expired(self) -> bool:
+        return time.monotonic() > self._expires_at
+
+    def reset(self):
+        self._backoff = 1
+        self._expires_at = time.monotonic() + self.ttl
+
+    def revive(self):
+        self._backoff = min(self._backoff * _BACKOFF_MULTIPLIER, _MAX_BACKOFF)
+        self._expires_at = time.monotonic() + self.ttl * self._backoff
+
+
+def _run_sync_function_and_cache(entry: NeverDieCacheEntry):
+    """Run a function and cache its result"""
+    try:
+        with entry.config.sync_lock(entry.cache_key):
+            result = entry.function(*entry.args, **entry.kwargs)
+            entry.config.storage.set(entry.cache_key, result, None)
+            entry.reset()
+    except BaseException:
+        entry.revive()
+        logger.debug(
+            "Exception caching function with never_die",
+            extra={"function": entry.function.__qualname__},
+            exc_info=True,
+        )
+
+
+async def _run_async_function_and_cache(entry: NeverDieCacheEntry):
+    """Run a function and cache its result"""
+    try:
+        async with entry.config.async_lock(entry.cache_key):
+            result = await entry.function(*entry.args, **entry.kwargs)
+            await entry.config.storage.aset(entry.cache_key, result, None)
+            entry.reset()
+    except BaseException:
+        entry.revive()
+        logger.debug(
+            "Exception caching function with never_die",
+            extra={"function": entry.function.__qualname__},
+            exc_info=True,
+        )
+
+
+def _cache_is_being_set(entry: NeverDieCacheEntry) -> bool:
+    if entry.loop:
+        return entry.cache_key in _NEVER_DIE_CACHE_FUTURES and not _NEVER_DIE_CACHE_FUTURES[entry.cache_key].done()
+    return entry.cache_key in _NEVER_DIE_CACHE_THREADS and _NEVER_DIE_CACHE_THREADS[entry.cache_key].is_alive()
+
+
+def _clear_dead_futures():
+    """Clear dead futures from the cache future registry"""
+    for cache_key, thread in list(_NEVER_DIE_CACHE_FUTURES.items()):
+        if thread.done():
+            del _NEVER_DIE_CACHE_FUTURES[cache_key]
+
+
+def _clear_dead_threads():
+    """Clear dead threads from the cache thread registry"""
+    for cache_key, thread in list(_NEVER_DIE_CACHE_THREADS.items()):
+        if thread.is_alive():
+            continue
+        del _NEVER_DIE_CACHE_THREADS[cache_key]
+
+
+def _refresh_never_die_caches():
+    """Background thread function that periodically refreshes never_die cache entries"""
+    while True:
+        try:
+            for entry in list(_NEVER_DIE_REGISTRY):
+                if not entry.is_expired():
+                    continue
+
+                if _cache_is_being_set(entry):
+                    continue
+
+                if not entry.loop:  # sync
+                    thread = threading.Thread(target=_run_sync_function_and_cache, args=(entry,), daemon=True)
+                    thread.start()
+                    _NEVER_DIE_CACHE_THREADS[entry.cache_key] = thread
+                    continue
+
+                if entry.loop.is_closed():
+                    logger.debug(
+                        f"Loop is closed, skipping future creation",
+                        extra={"function": entry.function.__qualname__},
+                        exc_info=True,
+                    )
+                    continue
+
+                try:
+                    coroutine = _run_async_function_and_cache(entry)
+                    future = asyncio.run_coroutine_threadsafe(coroutine, entry.loop)
+                except RuntimeError:
+                    coroutine.close()
+                    logger.debug(
+                        f"Loop is closed, skipping future creation",
+                        extra={"function": entry.function.__qualname__},
+                        exc_info=True,
+                    )
+                    continue
+
+                _NEVER_DIE_CACHE_FUTURES[entry.cache_key] = future
+        finally:
+            time.sleep(_REFRESH_INTERVAL_SECONDS)
+            _clear_dead_futures()
+            _clear_dead_threads()
+
+
+def _start_never_die_thread():
+    """Start the background thread if it's not already running"""
+    global _NEVER_DIE_THREAD
+    with _NEVER_DIE_LOCK:
+        if _NEVER_DIE_THREAD and _NEVER_DIE_THREAD.is_alive():
+            return
+
+        _NEVER_DIE_THREAD = threading.Thread(target=_refresh_never_die_caches, daemon=True)
+        _NEVER_DIE_THREAD.start()
+
+
+def register_never_die_function(
+    function: Callable[..., Any],
+    ttl: Number,
+    args: tuple,
+    kwargs: dict,
+    cache_key_func: CacheKeyFunction | None,
+    ignore_fields: tuple[str, ...],
+    config: CacheConfig,
+):
+    """Register a function for never_die cache refreshing"""
+    is_async = inspect.iscoroutinefunction(function)
+
+    entry = NeverDieCacheEntry(
+        function=function,
+        ttl=ttl,
+        args=args,
+        kwargs=kwargs,
+        cache_key_func=cache_key_func,
+        ignore_fields=ignore_fields,
+        loop=asyncio.get_running_loop() if is_async else None,
+        config=config,
+    )
+
+    with _NEVER_DIE_LOCK:
+        if entry not in _NEVER_DIE_REGISTRY:
+            _NEVER_DIE_REGISTRY.append(entry)
+
+    _start_never_die_thread()
+
+
+def clear_never_die_registry():
+    """
+    Clear all entries from the never_die registry.
+
+    Useful for testing to prevent background threads from
+    accessing resources that have been cleaned up.
+    """
+    with _NEVER_DIE_LOCK:
+        _NEVER_DIE_REGISTRY.clear()
+        _NEVER_DIE_CACHE_THREADS.clear()
+        _NEVER_DIE_CACHE_FUTURES.clear()

cachify/memory_cache.py

@@ -1,37 +1,37 @@
-import threading
-from typing import Callable
-
-from cachify.cache import base_cache
-from cachify.storage.memory_storage import MemoryStorage
-from cachify.types import CacheConfig, CacheKeyFunction, F, Number
-from cachify.utils.locks import ASYNC_LOCKS, SYNC_LOCKS
-
-_CACHE_CLEAR_THREAD: threading.Thread | None = None
-_CACHE_CLEAR_LOCK: threading.Lock = threading.Lock()
-
-_MEMORY_CONFIG = CacheConfig(
-    storage=MemoryStorage,
-    sync_lock=lambda cache_key: SYNC_LOCKS[cache_key],
-    async_lock=lambda cache_key: ASYNC_LOCKS[cache_key],
-)
-
-
-def _start_cache_clear_thread():
-    """This is to avoid memory leaks by clearing expired cache items periodically."""
-    global _CACHE_CLEAR_THREAD
-    with _CACHE_CLEAR_LOCK:
-        if _CACHE_CLEAR_THREAD and _CACHE_CLEAR_THREAD.is_alive():
-            return
-        _CACHE_CLEAR_THREAD = threading.Thread(target=MemoryStorage.clear_expired_cached_items, daemon=True)
-        _CACHE_CLEAR_THREAD.start()
-
-
-def cache(
-    ttl: Number = 300,
-    never_die: bool = False,
-    cache_key_func: CacheKeyFunction | None = None,
-    ignore_fields: tuple[str, ...] = (),
-) -> Callable[[F], F]:
-    """In-memory cache decorator. See `base_cache` for full documentation."""
-    _start_cache_clear_thread()
-    return base_cache(ttl, never_die, cache_key_func, ignore_fields, _MEMORY_CONFIG)
+import threading
+from typing import Callable
+
+from cachify.cache import base_cache
+from cachify.storage.memory_storage import MemoryStorage
+from cachify.types import CacheConfig, CacheKeyFunction, F, Number
+from cachify.utils.locks import ASYNC_LOCKS, SYNC_LOCKS
+
+_CACHE_CLEAR_THREAD: threading.Thread | None = None
+_CACHE_CLEAR_LOCK: threading.Lock = threading.Lock()
+
+_MEMORY_CONFIG = CacheConfig(
+    storage=MemoryStorage,
+    sync_lock=lambda cache_key: SYNC_LOCKS[cache_key],
+    async_lock=lambda cache_key: ASYNC_LOCKS[cache_key],
+)
+
+
+def _start_cache_clear_thread():
+    """This is to avoid memory leaks by clearing expired cache items periodically."""
+    global _CACHE_CLEAR_THREAD
+    with _CACHE_CLEAR_LOCK:
+        if _CACHE_CLEAR_THREAD and _CACHE_CLEAR_THREAD.is_alive():
+            return
+        _CACHE_CLEAR_THREAD = threading.Thread(target=MemoryStorage.clear_expired_cached_items, daemon=True)
+        _CACHE_CLEAR_THREAD.start()
+
+
+def cache(
+    ttl: Number = 300,
+    never_die: bool = False,
+    cache_key_func: CacheKeyFunction | None = None,
+    ignore_fields: tuple[str, ...] = (),
+) -> Callable[[F], F]:
+    """In-memory cache decorator. See `base_cache` for full documentation."""
+    _start_cache_clear_thread()
+    return base_cache(ttl, never_die, cache_key_func, ignore_fields, _MEMORY_CONFIG)

cachify/redis/__init__.py

@@ -1,19 +1,19 @@
-from cachify.redis.config import (
-    DEFAULT_KEY_PREFIX,
-    DEFAULT_LOCK_TIMEOUT,
-    RedisConfig,
-    get_redis_config,
-    reset_redis_config,
-    setup_redis_config,
-)
-from cachify.redis.lock import RedisLockManager
-
-__all__ = [
-    "DEFAULT_KEY_PREFIX",
-    "DEFAULT_LOCK_TIMEOUT",
-    "RedisConfig",
-    "RedisLockManager",
-    "get_redis_config",
-    "reset_redis_config",
-    "setup_redis_config",
-]
+from cachify.redis.config import (
+    DEFAULT_KEY_PREFIX,
+    DEFAULT_LOCK_TIMEOUT,
+    RedisConfig,
+    get_redis_config,
+    reset_redis_config,
+    setup_redis_config,
+)
+from cachify.redis.lock import RedisLockManager
+
+__all__ = [
+    "DEFAULT_KEY_PREFIX",
+    "DEFAULT_LOCK_TIMEOUT",
+    "RedisConfig",
+    "RedisLockManager",
+    "get_redis_config",
+    "reset_redis_config",
+    "setup_redis_config",
+]