cachetools 7.2.7__tar.gz → 7.2.8__tar.gz

{cachetools-7.2.7 → cachetools-7.2.8}/CHANGELOG.rst

@@ -1,3 +1,12 @@
+v7.2.8 (2026-10-31)
+===================
+
+- Fix type stubs for ``TTLCache`` and ``TLRUCache`` with default
+  ``timer``.
+
+- Minor documentation and unit test improvements.
+
+
 v7.2.7 (2026-10-28)
 ===================
 

{cachetools-7.2.7/src/cachetools.egg-info → cachetools-7.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cachetools
-Version: 7.2.7
+Version: 7.2.8
 Summary: Extensible memoizing collections and decorators
 Author-email: Thomas Kemmer <tkemmer@computer.org>
 Maintainer-email: Thomas Kemmer <tkemmer@computer.org>

{cachetools-7.2.7 → cachetools-7.2.8}/docs/index.rst

@@ -356,6 +356,16 @@ often called with the same arguments:
    implement the `context manager`_ protocol, and will also be used to
    guard access to the cache.
 
+   .. note::
+
+      Even though `lock` and `condition` can be passed separately,
+      the condition variable must be associated with the lock that
+      guards the cache.  In practice, when using
+      :class:`threading.Lock` and :class:`threading.Condition`, the
+      condition variable must be created with the corresponding lock,
+      e.g. ``condition=threading.Condition(lock)``; an unrelated
+      :class:`threading.Condition` will raise :exc:`RuntimeError`.
+
    The decorator's `cache`, `key`, `lock` and `condition` parameters
    are also available as :attr:`cache`, :attr:`cache_key`,
    :attr:`cache_lock` and :attr:`cache_condition` attributes of the
@@ -548,6 +558,8 @@ often called with the same arguments:
       `lock(self)` will only guard access to the cache itself.  It is
       the user's responsibility to handle concurrent calls to the
       underlying wrapped method in a multithreaded environment.
+      Likewise, a condition variable returned by `condition(self)`
+      must be associated with a lock returned by `lock(self)`.
 
    Similarly to the :func:`cached` function decorator, the `cache`,
    `key`, `lock` and `condition` parameters are also available as

{cachetools-7.2.7 → cachetools-7.2.8}/src/cachetools/__init__.py

@@ -12,7 +12,7 @@ __all__ = (
     "cachedmethod",
 )
 
-__version__ = "7.2.7"
+__version__ = "7.2.8"
 
 import collections
 import collections.abc

{cachetools-7.2.7 → cachetools-7.2.8}/src/cachetools/__init__.pyi

@@ -36,8 +36,6 @@ _T = TypeVar("_T")
 _KT = TypeVar("_KT")
 _VT = TypeVar("_VT")
 _TT = TypeVar("_TT", default=float)
-_KT2 = TypeVar("_KT2")
-_VT2 = TypeVar("_VT2")
 
 class Cache(MutableMapping[_KT, _VT]):
     def __init__(
@@ -94,13 +92,13 @@ class _TimedCache(Cache[_KT, _VT], Generic[_KT, _VT, _TT]):
     def timer(self) -> _Timer[_TT]: ...
 
 class TTLCache(_TimedCache[_KT, _VT, _TT]):
-    @overload
+    @overload  # without timer, _TT takes its default
     def __init__(
-        self: TTLCache[_KT2, _VT2, float],
+        self,
         maxsize: float,
         ttl: float,
         *,
-        getsizeof: Callable[[_VT2], float] | None = None,
+        getsizeof: Callable[[_VT], float] | None = None,
     ) -> None: ...
     @overload
     def __init__(
@@ -115,13 +113,13 @@ class TTLCache(_TimedCache[_KT, _VT, _TT]):
     def expire(self, time: _TT | None = None) -> list[tuple[_KT, _VT]]: ...
 
 class TLRUCache(_TimedCache[_KT, _VT, _TT]):
-    @overload
+    @overload  # without timer, _TT takes its default
     def __init__(
-        self: TLRUCache[_KT2, _VT2, float],
+        self,
         maxsize: float,
-        ttu: Callable[[_KT2, _VT2, float], float],
+        ttu: Callable[[_KT, _VT, float], float],
         *,
-        getsizeof: Callable[[_VT2], float] | None = None,
+        getsizeof: Callable[[_VT], float] | None = None,
     ) -> None: ...
     @overload
     def __init__(

{cachetools-7.2.7 → cachetools-7.2.8}/src/cachetools/_cachedmethod.py

@@ -35,7 +35,7 @@ class _WrapperBase:
         # wrappers
         return (self.__descriptor.__get__, (self._obj,))
 
-    def __call__(self, *args, **kwargs):
+    def __call__(self, /, *args, **kwargs):
         raise NotImplementedError()  # pragma: no cover
 
     def cache_clear(self):
@@ -72,7 +72,7 @@ def _condition_info(method, cache, key, lock, cond, info):
                 self.__hits = self.__misses = 0
                 self.__pending = set()
 
-            def __call__(self, *args, **kwargs):
+            def __call__(self, /, *args, **kwargs):
                 cache = self.cache
                 lock = self.cache_lock
                 cond = self.cache_condition
@@ -121,7 +121,7 @@ def _locked_info(method, cache, key, lock, info):
                 super().__init__(obj, descriptor, method, cache, key, lock)
                 self.__hits = self.__misses = 0
 
-            def __call__(self, *args, **kwargs):
+            def __call__(self, /, *args, **kwargs):
                 cache = self.cache
                 lock = self.cache_lock
                 key = self.cache_key(*args, **kwargs)
@@ -161,7 +161,7 @@ def _unlocked_info(method, cache, key, info):
                 super().__init__(obj, descriptor, method, cache, key)
                 self.__hits = self.__misses = 0
 
-            def __call__(self, *args, **kwargs):
+            def __call__(self, /, *args, **kwargs):
                 cache = self.cache
                 key = self.cache_key(*args, **kwargs)
                 try:
@@ -220,7 +220,7 @@ def _condition(method, cache, key, lock, cond):
         with lock(self):
             c.clear()
 
-    def classmethod_wrapper(self, *args, **kwargs):
+    def classmethod_wrapper(self, /, *args, **kwargs):
         p = pending.setdefault(self, set())
         return wrapper(self, p, *args, **kwargs)
 
@@ -230,7 +230,7 @@ def _condition(method, cache, key, lock, cond):
                 super().__init__(obj, descriptor, method, cache, key, lock, cond)
                 self.__pending = set()
 
-            def __call__(self, *args, **kwargs):
+            def __call__(self, /, *args, **kwargs):
                 return wrapper(self._obj, self.__pending, *args, **kwargs)
 
             # objtype: backward-compatible @classmethod handling with Python < 3.13
@@ -241,7 +241,7 @@ def _condition(method, cache, key, lock, cond):
 
 
 def _locked(method, cache, key, lock):
-    def wrapper(self, *args, **kwargs):
+    def wrapper(self, /, *args, **kwargs):
         c = cache(self)
         k = key(self, *args, **kwargs)
         with lock(self):
@@ -269,7 +269,7 @@ def _locked(method, cache, key, lock):
             def __init__(self, obj, descriptor):
                 super().__init__(obj, descriptor, method, cache, key, lock)
 
-            def __call__(self, *args, **kwargs):
+            def __call__(self, /, *args, **kwargs):
                 return wrapper(self._obj, *args, **kwargs)
 
             # objtype: backward-compatible @classmethod handling with Python < 3.13
@@ -280,7 +280,7 @@ def _locked(method, cache, key, lock):
 
 
 def _unlocked(method, cache, key):
-    def wrapper(self, *args, **kwargs):
+    def wrapper(self, /, *args, **kwargs):
         c = cache(self)
         k = key(self, *args, **kwargs)
         try:
@@ -303,7 +303,7 @@ def _unlocked(method, cache, key):
             def __init__(self, obj, descriptor):
                 super().__init__(obj, descriptor, method, cache, key)
 
-            def __call__(self, *args, **kwargs):
+            def __call__(self, /, *args, **kwargs):
                 return wrapper(self._obj, *args, **kwargs)
 
             # objtype: backward-compatible @classmethod handling with Python < 3.13

{cachetools-7.2.7 → cachetools-7.2.8}/src/cachetools/keys.py

@@ -54,7 +54,7 @@ def hashkey(*args, **kwargs):
         return _HashedTuple(args)
 
 
-def methodkey(self, *args, **kwargs):
+def methodkey(self, /, *args, **kwargs):
     """Return a cache key for use with cached methods."""
     return hashkey(*args, **kwargs)
 
@@ -72,6 +72,6 @@ def typedkey(*args, **kwargs):
     return key
 
 
-def typedmethodkey(self, *args, **kwargs):
+def typedmethodkey(self, /, *args, **kwargs):
     """Return a typed cache key for use with cached methods."""
     return typedkey(*args, **kwargs)

{cachetools-7.2.7 → cachetools-7.2.8/src/cachetools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cachetools
-Version: 7.2.7
+Version: 7.2.8
 Summary: Extensible memoizing collections and decorators
 Author-email: Thomas Kemmer <tkemmer@computer.org>
 Maintainer-email: Thomas Kemmer <tkemmer@computer.org>

{cachetools-7.2.7 → cachetools-7.2.8}/tests/test_keys.py

@@ -38,6 +38,9 @@ class CacheKeysTest(unittest.TestCase):
         # untyped keys compare equal
         self.assertEqual(key("x", 1, 2, 3), key("y", 1.0, 2.0, 3.0))
         self.assertEqual(hash(key("x", 1, 2, 3)), hash(key("y", 1.0, 2.0, 3.0)))
+        # "self" is positional-only, so it may also be a keyword argument
+        self.assertEqual(key("x", self=1), key("y", self=1))
+        self.assertNotEqual(key("x", self=1), key("x"))
 
     def test_typedkey(self, key=cachetools.keys.typedkey):
         self.assertEqual(key(), key())
@@ -54,6 +57,8 @@ class CacheKeysTest(unittest.TestCase):
             hash(key({}))
         # typed keys compare unequal
         self.assertNotEqual(key(1, 2, 3), key(1.0, 2.0, 3.0))
+        self.assertNotEqual(key(1, 2, 3, x=0), key(1, 2, 3, x=0.0))
+        self.assertNotEqual(key(1, 2, 3, x=0), key(1, 2, 3, x=False))
 
     def test_typedmethodkey(self, key=cachetools.keys.typedmethodkey):
         # similar to typedkey(), but ignores its first positional argument
@@ -71,6 +76,11 @@ class CacheKeysTest(unittest.TestCase):
             hash(key("x", {}))
         # typed keys compare unequal
         self.assertNotEqual(key("x", 1, 2, 3), key("x", 1.0, 2.0, 3.0))
+        self.assertNotEqual(key("x", 1, 2, 3, x=0), key("x", 1, 2, 3, x=0.0))
+        self.assertNotEqual(key("x", 1, 2, 3, x=0), key("x", 1, 2, 3, x=False))
+        # "self" is positional-only, so it may also be a keyword argument
+        self.assertEqual(key("x", self=1), key("y", self=1))
+        self.assertNotEqual(key("x", self=1), key("x", self=1.0))
 
     def test_addkeys(self, key=cachetools.keys.hashkey):
         self.assertIsInstance(key(), tuple)

{cachetools-7.2.7 → cachetools-7.2.8}/tests/test_threading.py

@@ -5,8 +5,8 @@ from cachetools import LRUCache, cached, cachedmethod
 
 
 class WaitCondition(Condition):
-    def __init__(self):
-        super().__init__()
+    def __init__(self, lock=None):
+        super().__init__(lock)
         self.waiting = Event()
 
     def wait(self, timeout=None):
@@ -93,6 +93,90 @@ class ThreadingTest(unittest.TestCase):
                 func = Cached().method
                 self.run_cond_wait_test(func, cond, started, release, calls)
 
+    def test_cached_lock_cond(self):
+        for info in (False, True):
+            with self.subTest(info=info):
+                cache = LRUCache(1)
+                lock = Lock()
+                cond = WaitCondition(lock)
+                started = Event()
+                release = Event()
+                calls = []
+
+                @cached(cache, lock=lock, condition=cond, info=info)
+                def func(calls=calls, started=started, release=release):
+                    calls.append(None)
+                    started.set()
+                    release.wait(self.TIMEOUT)
+                    return object()
+
+                self.run_cond_wait_test(func, cond, started, release, calls)
+
+    def test_cachedmethod_lock_cond(self):
+        for info in (False, True):
+            with self.subTest(info=info):
+                cache = LRUCache(1)
+                lock = Lock()
+                cond = WaitCondition(lock)
+                started = Event()
+                release = Event()
+                calls = []
+
+                class Cached:
+                    @cachedmethod(
+                        lambda _: cache,
+                        lock=lambda _: lock,
+                        condition=lambda _: cond,
+                        info=info,
+                    )
+                    def method(
+                        self,
+                        calls=calls,
+                        started=started,
+                        release=release,
+                        timeout=self.TIMEOUT,
+                    ):
+                        calls.append(None)
+                        started.set()
+                        release.wait(timeout)
+                        return object()
+
+                func = Cached().method
+                self.run_cond_wait_test(func, cond, started, release, calls)
+
+    def test_cached_unrelated_lock_cond(self):
+        # a condition variable not created with the lock fails on
+        # the first cache miss, even without concurrent calls
+        for info in (False, True):
+            with self.subTest(info=info):
+
+                @cached(LRUCache(1), lock=Lock(), condition=Condition(), info=info)
+                def func():
+                    return object()
+
+                with self.assertRaises(RuntimeError):
+                    func()
+
+    def test_cachedmethod_unrelated_lock_cond(self):
+        for info in (False, True):
+            with self.subTest(info=info):
+                cache = LRUCache(1)
+                lock = Lock()
+                cond = Condition()
+
+                class Cached:
+                    @cachedmethod(
+                        lambda _: cache,
+                        lock=lambda _: lock,
+                        condition=lambda _: cond,
+                        info=info,
+                    )
+                    def method(self):
+                        return object()
+
+                with self.assertRaises(RuntimeError):
+                    Cached().method()
+
     def run_cond_wait_test(self, func, cond, started, release, calls):
         results = [None] * 2
 
@@ -122,14 +206,6 @@ class ThreadingTest(unittest.TestCase):
             self.assertEqual(cache_info.hits + cache_info.misses, self.NTHREADS)
             self.assertGreaterEqual(cache_info.misses, 1)
 
-    def run_cond_test(self, func, cache, info):
-        self.run_threading_test(func, cache)
-
-        if info:
-            cache_info = func.cache_info()
-            self.assertEqual(cache_info.hits, self.NTHREADS - 1)
-            self.assertEqual(cache_info.misses, 1)
-
     def run_threading_test(self, func, cache):
         results = [None] * self.NTHREADS
 

{cachetools-7.2.7 → cachetools-7.2.8}/tests/test_tlru.py

@@ -400,3 +400,23 @@ class TLRUCacheTest(unittest.TestCase, CacheTestMixin):
         cache.timer.tick()
         cache.timer.tick()  # past TTL
         self.assertNotIn(42, cache)
+
+    def test_tlru_default_timer_stubs(self):
+        # type stubs must infer key and value types with the default timer
+        def ttu(_key: str, value: int, now: float) -> float:
+            return now + value
+
+        cache: TLRUCache[str, int] = TLRUCache(maxsize=2, ttu=ttu)
+
+        cache["a"] = 3600
+        self.assertEqual(3600, cache["a"])
+        self.assertEqual(1, len(cache))
+        self.assertIn("a", cache)
+
+        sized: TLRUCache[str, str] = TLRUCache(
+            maxsize=10, ttu=lambda _k, _v, now: now + 3600, getsizeof=len
+        )
+
+        sized["abc"] = "abc"
+        self.assertEqual("abc", sized["abc"])
+        self.assertEqual(3, sized.currsize)

{cachetools-7.2.7 → cachetools-7.2.8}/tests/test_ttl.py

@@ -272,3 +272,18 @@ class TTLCacheTest(unittest.TestCase, CacheTestMixin):
         cache.timer.tick()
         cache.timer.tick()  # past TTL
         self.assertNotIn(42, cache)
+
+    def test_ttl_default_timer_stubs(self):
+        # type stubs must infer key and value types with the default timer
+        cache: TTLCache[str, int] = TTLCache(maxsize=2, ttl=math.inf)
+
+        cache["a"] = 1
+        self.assertEqual(1, cache["a"])
+        self.assertEqual(1, len(cache))
+        self.assertIn("a", cache)
+
+        sized: TTLCache[str, str] = TTLCache(maxsize=10, ttl=math.inf, getsizeof=len)
+
+        sized["abc"] = "abc"
+        self.assertEqual("abc", sized["abc"])
+        self.assertEqual(3, sized.currsize)