cachetools 7.2.8__tar.gz → 7.3.0__tar.gz

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

@@ -1,3 +1,15 @@
+v7.3.0 (2026-11-05)
+===================
+
+- Use ``OrderedDict`` for defined and faster ``LFUCache`` eviction.
+
+- Various unit test improvements.
+
+- Minor type stub improvements.
+
+- Minor documentation improvements.
+
+
 v7.2.8 (2026-10-31)
 ===================
 

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

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

{cachetools-7.2.8 → cachetools-7.3.0}/docs/conf.py

@@ -13,6 +13,5 @@ extensions = [
     "sphinx.ext.todo",
 ]
 exclude_patterns = ["_build"]
-master_doc = "index"
 html_theme = "classic"
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}

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

@@ -92,10 +92,17 @@ inserted into the cache.
    :members: popitem
 
    This class counts how often an item is retrieved, and discards the
-   items used least often to make space when necessary.
+   items used least often to make space when necessary.  In case of a
+   tie, the least recently used of these items is discarded.
 
-   Updating a cache item via :meth:`LFUCache.__setitem__` also counts
-   as a use of the item, i.e. it will increment the item's use count.
+   Inserting or updating a cache item via :meth:`LFUCache.__setitem__`
+   also counts as a use of the item; an update will increment the
+   item's use count.
+
+   .. versionchanged:: 7.3
+
+      Switched to discarding the least recently used item in case of
+      a tie.  Previously, an arbitrary item was discarded.
 
 .. autoclass:: LRUCache(maxsize, getsizeof=None)
    :members: popitem

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

@@ -12,7 +12,7 @@ __all__ = (
     "cachedmethod",
 )
 
-__version__ = "7.2.8"
+__version__ = "7.3.0"
 
 import collections
 import collections.abc
@@ -212,7 +212,7 @@ class LFUCache(Cache):
 
         def __init__(self, count):
             self.count = count
-            self.keys = set()
+            self.keys = collections.OrderedDict()
 
         def unlink(self):
             next = self.next
@@ -244,13 +244,13 @@ class LFUCache(Cache):
             link.next = root.next
             root.next = link.next.prev = link
             link.prev = root
-        link.keys.add(key)
+        link.keys[key] = None
         self.__links[key] = link
 
     def __delitem__(self, key, cache_delitem=Cache.__delitem__):
         cache_delitem(self, key)
         link = self.__links.pop(key)
-        link.keys.remove(key)
+        del link.keys[key]
         if not link.keys:
             link.unlink()
 
@@ -260,7 +260,7 @@ class LFUCache(Cache):
         curr = root.next
         if curr is root:
             raise KeyError("%s is empty" % type(self).__name__) from None
-        key = next(iter(curr.keys))  # remove an arbitrary element
+        key = next(iter(curr.keys))  # remove the "oldest" element
         value = Cache.__getitem__(self, key)
         del self[key]
         return (key, value)
@@ -283,8 +283,8 @@ class LFUCache(Cache):
             curr.next = link.next
             link.next = curr.next.prev = curr
             curr.prev = link
-        curr.keys.add(key)
-        link.keys.remove(key)
+        curr.keys[key] = None
+        del link.keys[key]
         if not link.keys:
             link.unlink()
         self.__links[key] = curr

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

@@ -51,7 +51,12 @@ class Cache(MutableMapping[_KT, _VT]):
     def pop(self, key: _KT) -> _VT: ...
     @overload
     def pop(self, key: _KT, default: _VT | _T) -> _VT | _T: ...
-    def setdefault(self, key: _KT, default: _VT | None = None) -> _VT: ...
+    @overload
+    def setdefault(
+        self: Cache[_KT, _T | None], key: _KT, default: None = None
+    ) -> _T | None: ...
+    @overload
+    def setdefault(self, key: _KT, default: _VT) -> _VT: ...
     @property
     def maxsize(self) -> float: ...
     @property
@@ -104,7 +109,7 @@ class TTLCache(_TimedCache[_KT, _VT, _TT]):
     def __init__(
         self,
         maxsize: float,
-        ttl: Any,  # FIXME: must be "addable" to _TT
+        ttl: Any,  # must be "addable" to _TT
         timer: Callable[[], _TT],
         getsizeof: Callable[[_VT], float] | None = None,
     ) -> None: ...
@@ -141,8 +146,6 @@ class _CacheInfo(NamedTuple):
 
 @type_check_only
 class _AbstractCondition(AbstractContextManager[Any], Protocol):
-    # implementation and unit tests currently do not use plain wait()
-    # and notify(); these are reserved for future use
     def wait(self, timeout: float | None = None) -> bool: ...
     def wait_for(
         self, predicate: Callable[[], _T], timeout: float | None = None

{cachetools-7.2.8 → cachetools-7.3.0}/src/cachetools/_descriptor.py

@@ -178,7 +178,7 @@ class _ClassMethodDescriptor(_MethodDescriptor):
         self.__cache_clear = cache_clear
 
     # called for @classmethod with Python >= 3.13
-    def __call__(self, *args, **kwargs):
+    def __call__(self, /, *args, **kwargs):
         _warn_classmethod(stacklevel=3)
         return self.__wrapper(*args, **kwargs)
 

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

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

{cachetools-7.2.8 → cachetools-7.3.0}/tests/test_cached.py

@@ -438,6 +438,21 @@ class CacheWrapperTest(unittest.TestCase, DecoratorTestMixin):
         self.assertEqual(cached.get_static(1), 1)
         self.assertEqual(Cached.get_static(1), 1)
 
+    def test_autospec(self):
+        import unittest.mock
+
+        class Cached:
+            @cachetools.cached(self.cache(2))
+            def get(self, value):
+                return value
+
+        mock = unittest.mock.create_autospec(Cached, instance=True)
+        mock.get.return_value = 42
+        self.assertEqual(mock.get(1), 42)
+        mock.get.assert_called_with(1)
+        self.assertEqual(mock.get(value=1), 42)
+        mock.get.assert_called_with(value=1)
+
 
 class DictWrapperTest(unittest.TestCase, DecoratorTestMixin):
     def cache(self, minsize):

{cachetools-7.2.8 → cachetools-7.3.0}/tests/test_cachedmethod.py

@@ -982,6 +982,10 @@ class NoneMethodTest(unittest.TestCase):
 
 class UnboundMethodTest(unittest.TestCase):
     def test_class_call(self):
+        for attr in ("cache", "cache_key", "cache_lock", "cache_condition"):
+            self.assertFalse(hasattr(Cached.get, attr))
+        for attr in ("cache_clear", "cache_info"):
+            self.assertFalse(hasattr(Cached.get, attr))
         cached = Cached(Cache(2))
         self.assertEqual(Cached.get(cached, 1), 0)
         self.assertEqual(cached.get(1), 0)
@@ -993,6 +997,10 @@ class UnboundMethodTest(unittest.TestCase):
         self.assertEqual(cached.get(1), 0)
 
     def test_class_call_info(self):
+        for attr in ("cache", "cache_key", "cache_lock", "cache_condition"):
+            self.assertFalse(hasattr(Cached.get_info, attr))
+        for attr in ("cache_clear", "cache_info"):
+            self.assertFalse(hasattr(Cached.get_info, attr))
         cached = Cached(Cache(2))
         self.assertEqual(Cached.get_info(cached, 1), 0)
         self.assertEqual(cached.get_info(1), 0)

{cachetools-7.2.8 → cachetools-7.3.0}/tests/test_classmethod.py

@@ -42,6 +42,12 @@ class Cached:
         cls.count += 1
         return cls.count
 
+    @classmethod
+    @cachedmethod(lambda cls: cls.cache)
+    def get_self(cls, self):
+        cls.count += 1
+        return cls.count
+
 
 class CachedClassMethodTest(unittest.TestCase):
     def test(self):
@@ -192,3 +198,15 @@ class CachedClassMethodTest(unittest.TestCase):
             self.assertEqual(len(Cached.cache), 1)
             Cached.get_condition.cache_clear(cached)  # type: ignore
             self.assertEqual(len(Cached.cache), 0)
+
+    def test_self_keyword(self):
+        # https://github.com/tkem/cachetools/issues/451
+        Cached.cache = LRUCache(2)
+        Cached.count = 0
+        cached = Cached()
+
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore")
+            self.assertEqual(Cached.get_self(self=0), 1)
+            self.assertEqual(cached.get_self(self=0), 1)
+            self.assertEqual(Cached.get_self(self=1), 2)

{cachetools-7.2.8 → cachetools-7.3.0}/tests/test_func.py

@@ -192,10 +192,75 @@ class LRUDecoratorTest(unittest.TestCase, DecoratorTestMixin):
 class RRDecoratorTest(unittest.TestCase, DecoratorTestMixin):
     DECORATOR = staticmethod(cachetools.func.rr_cache)
 
+    def test_rr_choice(self):
+        cached = cachetools.func.rr_cache(maxsize=2, choice=min)(lambda n: n)
+        self.assertEqual(cached.cache_parameters(), {"maxsize": 2, "typed": False})
+        self.assertEqual(cached(1), 1)
+        self.assertEqual(cached(2), 2)
+        self.assertEqual(cached.cache_info(), (0, 2, 2, 2))
+        # the smallest key, (1,), is evicted
+        self.assertEqual(cached(3), 3)
+        self.assertEqual(cached.cache_info(), (0, 3, 2, 2))
+        self.assertEqual(cached(2), 2)
+        self.assertEqual(cached(3), 3)
+        self.assertEqual(cached.cache_info(), (2, 3, 2, 2))
+        # now (2,) is the smallest key
+        self.assertEqual(cached(1), 1)
+        self.assertEqual(cached.cache_info(), (2, 4, 2, 2))
+        self.assertEqual(cached(3), 3)
+        self.assertEqual(cached.cache_info(), (3, 4, 2, 2))
+        self.assertEqual(cached(2), 2)
+        self.assertEqual(cached.cache_info(), (3, 5, 2, 2))
+
 
 class TTLDecoratorTest(unittest.TestCase, DecoratorTestMixin):
     DECORATOR = staticmethod(cachetools.func.ttl_cache)
 
+    class Timer:
+        def __init__(self):
+            self.time = 0
+
+        def __call__(self):
+            return self.time
+
+        def tick(self):
+            self.time += 1
+
+    def test_ttl_expire(self):
+        timer = self.Timer()
+        cached = cachetools.func.ttl_cache(maxsize=2, ttl=1, timer=timer)(lambda n: n)
+        self.assertEqual(cached.cache_parameters(), {"maxsize": 2, "typed": False})
+        self.assertEqual(cached(1), 1)
+        self.assertEqual(cached.cache_info(), (0, 1, 2, 1))
+        self.assertEqual(cached(1), 1)
+        self.assertEqual(cached.cache_info(), (1, 1, 2, 1))
+        timer.tick()
+        self.assertEqual(cached.cache_info(), (1, 1, 2, 0))
+        self.assertEqual(cached(1), 1)
+        self.assertEqual(cached.cache_info(), (1, 2, 2, 1))
+        self.assertEqual(cached(2), 2)
+        self.assertEqual(cached.cache_info(), (1, 3, 2, 2))
+        timer.tick()
+        self.assertEqual(cached(1), 1)
+        self.assertEqual(cached.cache_info(), (1, 4, 2, 1))
+
+    def test_ttl_expire_unbound(self):
+        timer = self.Timer()
+        cached = cachetools.func.ttl_cache(maxsize=None, ttl=1, timer=timer)(
+            lambda n: n
+        )
+        self.assertEqual(cached.cache_parameters(), {"maxsize": None, "typed": False})
+        self.assertEqual(cached.cache_info(), (0, 0, None, 0))
+        for n in range(256):
+            self.assertEqual(cached(n), n)
+        self.assertEqual(cached.cache_info(), (0, 256, None, 256))
+        self.assertEqual(cached(0), 0)
+        self.assertEqual(cached.cache_info(), (1, 256, None, 256))
+        timer.tick()
+        self.assertEqual(cached.cache_info(), (1, 256, None, 0))
+        self.assertEqual(cached(0), 0)
+        self.assertEqual(cached.cache_info(), (1, 257, None, 1))
+
     def test_ttl_datetime(self):
         from datetime import datetime, timedelta
 

{cachetools-7.2.8 → cachetools-7.3.0}/tests/test_lfu.py

@@ -18,39 +18,67 @@ class LFUCacheTest(unittest.TestCase, CacheTestMixin):
 
         self.assertEqual(len(cache), 2)
         self.assertEqual(cache[1], 1)
-        self.assertTrue(2 in cache or 3 in cache)
-        self.assertTrue(2 not in cache or 3 not in cache)
+        self.assertNotIn(2, cache)
+        self.assertEqual(cache[3], 3)
 
+        cache[3]
         cache[4] = 4
         self.assertEqual(len(cache), 2)
-        self.assertEqual(cache[4], 4)
-        self.assertEqual(cache[1], 1)
-
-        cache[1]
-        self.assertEqual(len(cache), 2)
-        self.assertEqual(cache[1], 1)
+        self.assertNotIn(1, cache)
+        self.assertEqual(cache[3], 3)
         self.assertEqual(cache[4], 4)
 
     def test_lfu_tie(self):
         cache = LFUCache[int, int](maxsize=3)
 
         cache[1] = 1
-        cache[1]
         cache[2] = 2
         cache[3] = 3
-        cache[4] = 4
 
+        cache[3]
+        cache[2]
+        cache[1]
+
+        # do not use self.assertEqual(cache[1], 1) here, since that
+        # would mess up usage counts
         self.assertEqual(len(cache), 3)
         self.assertIn(1, cache)
+        self.assertIn(2, cache)
+        self.assertIn(3, cache)
+
+        cache[4] = 4
+        self.assertEqual(len(cache), 3)
+        self.assertIn(1, cache)
+        self.assertIn(2, cache)
+        self.assertNotIn(3, cache)
         self.assertIn(4, cache)
-        self.assertTrue(2 in cache or 3 in cache)
-        self.assertTrue(2 not in cache or 3 not in cache)
 
+        cache[4]
         cache[5] = 5
         self.assertEqual(len(cache), 3)
         self.assertIn(1, cache)
+        self.assertNotIn(2, cache)
+        self.assertNotIn(3, cache)
+        self.assertIn(4, cache)
         self.assertIn(5, cache)
-        self.assertTrue(2 in cache or 3 in cache or 4 in cache)
+
+    def test_lfu_tie_insert_only(self):
+        cache = LFUCache[int, int](maxsize=3)
+
+        cache[1] = 1
+        cache[2] = 2
+        cache[3] = 3
+
+        # items never retrieved are tied at use count 1, so they are
+        # evicted in insertion order; the set-based implementation
+        # used up to v7.2 only fails this from key 17 on
+        for key in range(4, 20):
+            cache[key] = key
+            self.assertEqual(len(cache), 3)
+            self.assertNotIn(key - 3, cache)
+            self.assertIn(key - 2, cache)
+            self.assertIn(key - 1, cache)
+            self.assertIn(key, cache)
 
     def test_lfu_getsizeof(self):
         cache = LFUCache[int, int](maxsize=3, getsizeof=lambda x: x)

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

@@ -248,7 +248,7 @@ class TLRUCacheTest(unittest.TestCase, CacheTestMixin):
         self.assertEqual(1, len(cache))
 
     def test_ttu_atomic(self):
-        cache = TLRUCache[int, int, int](
+        cache = TLRUCache[int, int | None, int](
             maxsize=1, ttu=lambda k, v, t: t + 2, timer=Timer(auto=True)
         )
         cache[1] = 1
@@ -258,7 +258,7 @@ class TLRUCacheTest(unittest.TestCase, CacheTestMixin):
         cache[1] = 1
         self.assertEqual(1, cache.pop(1))
         cache[1] = 1
-        self.assertEqual(1, cache.setdefault(1))
+        self.assertEqual(1, cache.setdefault(1))  # implicit default=None
         cache[1] = 1
         cache.clear()
         self.assertEqual(0, len(cache))

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

@@ -189,7 +189,7 @@ class TTLCacheTest(unittest.TestCase, CacheTestMixin):
         self.assertEqual([2], [key for key in cache])
 
     def test_ttl_atomic(self):
-        cache = TTLCache[int, int, int](maxsize=1, ttl=2, timer=Timer(auto=True))
+        cache = TTLCache[int, int | None, int](maxsize=1, ttl=2, timer=Timer(auto=True))
         cache[1] = 1
         self.assertEqual(1, cache[1])
         cache[1] = 1
@@ -197,7 +197,7 @@ class TTLCacheTest(unittest.TestCase, CacheTestMixin):
         cache[1] = 1
         self.assertEqual(1, cache.pop(1))
         cache[1] = 1
-        self.assertEqual(1, cache.setdefault(1))
+        self.assertEqual(1, cache.setdefault(1))  # implicit default=None
         cache[1] = 1
         cache.clear()
         self.assertEqual(0, len(cache))