cachetools 7.2.6__tar.gz → 7.2.7__tar.gz

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

@@ -1,3 +1,11 @@
+v7.2.7 (2026-10-28)
+===================
+
+- Various performance improvements.
+
+- Minor unit test improvements.
+
+
 v7.2.6 (2026-10-26)
 ===================
 

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

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

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

@@ -12,7 +12,7 @@ __all__ = (
     "cachedmethod",
 )
 
-__version__ = "7.2.6"
+__version__ = "7.2.7"
 
 import collections
 import collections.abc
@@ -24,30 +24,12 @@ import time
 from . import keys
 
 
-class _DefaultSize:
-    """A minimal "fake" dict that returns a constant size 1 for any key."""
-
-    __slots__ = ()
-
-    def __getitem__(self, _key):
-        return 1
-
-    def __setitem__(self, _key, _value):
-        pass
-
-    def pop(self, _key):
-        return 1
-
-    def clear(self):
-        pass
-
-
 class Cache(collections.abc.MutableMapping):
     """Mutable mapping to serve as a simple cache or cache base class."""
 
     __marker = object()
 
-    __size = _DefaultSize()
+    __size = None
 
     def __init__(self, maxsize, getsizeof=None):
         if maxsize < 0:
@@ -75,30 +57,48 @@ class Cache(collections.abc.MutableMapping):
             return self.__missing__(key)
 
     def __setitem__(self, key, value):
+        data = self.__data
+        size = self.__size
         maxsize = self.__maxsize
-        size = self.getsizeof(value)
-        if size < 0:
-            raise ValueError("value size must be non-negative")
-        if size > maxsize:
-            raise ValueError("value too large")
-        if key not in self.__data:
-            diffsize = size
-            while self.__currsize + diffsize > maxsize:
-                self.popitem()
+        if size is None:
+            if maxsize < 1:
+                raise ValueError("value too large")
+            elif key in data:
+                data[key] = value
+            else:
+                while self.__currsize + 1 > maxsize:
+                    self.popitem()
+                data[key] = value
+                self.__currsize += 1
         else:
-            diffsize = size - self.__size[key]
-            while self.__currsize + diffsize > maxsize:
-                self.popitem()
-                if key not in self.__data:
-                    diffsize = size
-        self.__data[key] = value
-        self.__size[key] = size
-        self.__currsize += diffsize
+            itemsize = self.getsizeof(value)
+            if itemsize > maxsize:
+                raise ValueError("value too large")
+            if itemsize < 0:
+                raise ValueError("value size must be non-negative")
+            if key not in data:
+                diffsize = itemsize
+                while self.__currsize + diffsize > maxsize:
+                    self.popitem()
+            else:
+                diffsize = itemsize - size[key]
+                while self.__currsize + diffsize > maxsize:
+                    self.popitem()
+                    if key not in data:
+                        diffsize = itemsize
+            data[key] = value
+            size[key] = itemsize
+            self.__currsize += diffsize
 
     def __delitem__(self, key):
-        size = self.__size.pop(key)
-        del self.__data[key]
-        self.__currsize -= size
+        size = self.__size
+        if size is None:
+            del self.__data[key]
+            self.__currsize -= 1
+        else:
+            itemsize = size.pop(key)
+            del self.__data[key]
+            self.__currsize -= itemsize
 
     def __contains__(self, key):
         return key in self.__data
@@ -148,8 +148,10 @@ class Cache(collections.abc.MutableMapping):
     # optimized version for each Cache subclass.
 
     def clear(self):
+        size = self.__size
+        if size is not None:
+            size.clear()
         self.__data.clear()
-        self.__size.clear()
         self.__currsize = 0
 
     @property
@@ -508,11 +510,12 @@ class TTLCache(_TimedCache):
             expires = time + self.__ttl
             self.expire(time)
             cache_setitem(self, key, value)
-        try:
-            link = self.__getlink(key)
-        except KeyError:
-            self.__links[key] = link = TTLCache._Link(key)
+        links = self.__links
+        link = links.get(key)
+        if link is None:
+            links[key] = link = TTLCache._Link(key)
         else:
+            links.move_to_end(key)
             link.unlink()
         link.expires = expires
         link.next = root = self.__root
@@ -560,6 +563,8 @@ class TTLCache(_TimedCache):
             time = self.timer()
         root = self.__root
         curr = root.next
+        if curr is root or time < curr.expires:
+            return []  # fast path: nothing has expired
         links = self.__links
         expired = []
         cache_delitem = Cache.__delitem__
@@ -595,11 +600,6 @@ class TTLCache(_TimedCache):
         root.prev = root.next = root
         self.__links.clear()
 
-    def __getlink(self, key):
-        value = self.__links[key]
-        self.__links.move_to_end(key)
-        return value
-
 
 class TLRUCache(_TimedCache):
     """Time-aware Least Recently Used (TLRU) cache implementation."""
@@ -655,11 +655,12 @@ class TLRUCache(_TimedCache):
             cache_setitem(self, key, value)
         # removing an existing item would break the heap structure, so
         # only mark it as removed for now
-        try:
-            self.__getitem(key).removed = True
-        except KeyError:
-            pass
-        self.__items[key] = item = TLRUCache._Item(key, expires)
+        items = self.__items
+        item = items.get(key)
+        if item is not None:
+            item.removed = True
+            items.move_to_end(key)
+        items[key] = item = TLRUCache._Item(key, expires)
         heapq.heappush(self.__order, item)
 
     def __delitem__(self, key, cache_delitem=Cache.__delitem__):
@@ -696,6 +697,8 @@ class TLRUCache(_TimedCache):
         if len(order) > len(items) * self.__HEAP_CLEANUP_FACTOR:
             self.__order = order = [item for item in order if not item.removed]
             heapq.heapify(order)
+        if not order or (not order[0].removed and time < order[0].expires):
+            return []  # fast path: nothing has expired
         expired = []
         cache_delitem = Cache.__delitem__
         cache_getitem = Cache.__getitem__
@@ -728,11 +731,6 @@ class TLRUCache(_TimedCache):
         self.__items.clear()
         del self.__order[:]
 
-    def __getitem(self, key):
-        value = self.__items[key]
-        self.__items.move_to_end(key)
-        return value
-
     def __delitem(self, key, cache_delitem=Cache.__delitem__):
         try:
             self.__items.pop(key).removed = True

{cachetools-7.2.6 → cachetools-7.2.7}/src/cachetools/_descriptor.py

@@ -46,46 +46,34 @@ class _MethodDescriptor:
             # objtype is not used for instance lookups, so it need not be bound here
             return self.__get_unbound()
         elif self.__attrname is not None:
-            # replace descriptor instance with wrapper in instance dict
-            wrapper = self.Wrapper(obj, self)  # type: ignore
-            try:
-                descriptor = next(
-                    (
-                        cls.__dict__[self.__attrname]
-                        for cls in type(obj).__mro__
-                        if self.__attrname in cls.__dict__
-                    ),
-                    None,
-                )
-                if descriptor is self:
-                    # In case of a race condition where another thread already replaced
-                    # the descriptor, prefer the initial wrapper.
+            descriptor = next(
+                (
+                    cls.__dict__[self.__attrname]
+                    for cls in type(obj).__mro__
+                    if self.__attrname in cls.__dict__
+                ),
+                None,
+            )
+            if descriptor is self:
+                # In case of a race condition where another thread already replaced
+                # the descriptor, prefer the initial wrapper.
+                wrapper = self.Wrapper(obj, self)  # type: ignore
+                try:
                     wrapper = obj.__dict__.setdefault(self.__attrname, wrapper)
-                else:
-                    # A super() lookup must neither reuse the override's wrapper
-                    # nor replace it, so preserve state separately for each descriptor.
+                except (AttributeError, TypeError) as e:
+                    self.__instance_dict_error(obj, e)
+            else:
+                # A super() lookup must neither reuse the override's wrapper
+                # nor replace it, so preserve state separately for each descriptor.
+                try:
                     wrappers = obj.__dict__.setdefault("__cachetools_cachedmethods", {})
+                except (AttributeError, TypeError) as e:
+                    self.__instance_dict_error(obj, e)
+                    wrappers = {}  # deprecated fallback: throwaway wrapper
+                wrapper = wrappers.get(self)
+                if wrapper is None:
+                    wrapper = self.Wrapper(obj, self)  # type: ignore
                     wrapper = wrappers.setdefault(self, wrapper)
-            except AttributeError:
-                # not all objects have __dict__ (e.g. class defines slots)
-                msg = (
-                    f"No '__dict__' attribute on {type(obj).__name__!r} "
-                    f"instance to cache {self.__attrname!r} property."
-                )
-                if self.__deprecated:
-                    _warn_instance_dict(msg, 3)
-                else:
-                    raise TypeError(msg) from None
-            except TypeError:
-                msg = (
-                    f"The '__dict__' attribute on {type(obj).__name__!r} "
-                    f"instance does not support item assignment for "
-                    f"caching {self.__attrname!r} property."
-                )
-                if self.__deprecated:
-                    _warn_instance_dict(msg, 3)
-                else:
-                    raise TypeError(msg) from None
         elif self.__deprecated:
             # deprecated @classmethod, warning already raised elsewhere
             wrapper = self.Wrapper(obj, self)  # type: ignore
@@ -110,6 +98,24 @@ class _MethodDescriptor:
             self.__unbound = _Unbound(self)
         return self.__unbound
 
+    def __instance_dict_error(self, obj, error):
+        if isinstance(error, AttributeError):
+            # not all objects have __dict__ (e.g. class defines slots)
+            msg = (
+                f"No '__dict__' attribute on {type(obj).__name__!r} "
+                f"instance to cache {self.__attrname!r}"
+            )
+        else:
+            # some objects may have an immutable __dict__
+            msg = (
+                f"The '__dict__' attribute on {type(obj).__name__!r} "
+                f"instance does not support item assignment for "
+                f"caching {self.__attrname!r}"
+            )
+        if not self.__deprecated:
+            raise TypeError(msg) from None
+        _warn_instance_dict(msg, 4)
+
 
 class _Unbound:
     """Callable returned on class access.

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

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

{cachetools-7.2.6 → cachetools-7.2.7}/tests/test_cachedmethod.py

@@ -565,6 +565,15 @@ class MethodDecoratorTestMixin(SimplifiedTestCaseProtocol):
             def get_info(self, value):
                 return value
 
+        class SlotsChild(Slots):
+            __slots__ = ()
+
+            def get(self, value):  # type: ignore
+                return super().get(value)
+
+            def get_info(self, value):  # type: ignore
+                return super().get_info(value)
+
         cache = self.cache(2)
         cached = Slots(cache)
 
@@ -579,6 +588,21 @@ class MethodDecoratorTestMixin(SimplifiedTestCaseProtocol):
         self.assertEqual(len(w), 2)
         self.assertIs(w[0].category, DeprecationWarning)
         self.assertIs(w[1].category, DeprecationWarning)
+        self.assertEqual(w[0].filename, __file__)
+
+        child = SlotsChild(cache)
+
+        with self.assertRaisesRegex(TypeError, "No '__dict__' attribute"):
+            child.get_info(42)
+
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            self.assertEqual(child.get(0), 0)
+            self.assertEqual(child.get(0), 0)
+        self.assertEqual(len(w), 2)
+        self.assertIs(w[0].category, DeprecationWarning)
+        self.assertIs(w[1].category, DeprecationWarning)
+        self.assertEqual(w[0].filename, __file__)
 
     def test_decorator_immutable_dict(self):
 
@@ -602,6 +626,13 @@ class MethodDecoratorTestMixin(SimplifiedTestCaseProtocol):
             def get_info(self, value):
                 return value
 
+        class ImmutableChild(Immutable):
+            def get(self, value):  # type: ignore
+                return super().get(value)
+
+            def get_info(self, value):  # type: ignore
+                return super().get_info(value)
+
         cache = self.cache(2)
         cached = Immutable(cache)
 
@@ -616,6 +647,48 @@ class MethodDecoratorTestMixin(SimplifiedTestCaseProtocol):
         self.assertEqual(len(w), 2)
         self.assertIs(w[0].category, DeprecationWarning)
         self.assertIs(w[1].category, DeprecationWarning)
+        self.assertEqual(w[0].filename, __file__)
+
+        child = ImmutableChild(cache)
+
+        with self.assertRaisesRegex(TypeError, "does not support item assignment"):
+            child.get_info(42)
+
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            self.assertEqual(child.get(0), 0)
+            self.assertEqual(child.get(0), 0)
+        self.assertEqual(len(w), 2)
+        self.assertIs(w[0].category, DeprecationWarning)
+        self.assertIs(w[1].category, DeprecationWarning)
+        self.assertEqual(w[0].filename, __file__)
+
+    def test_decorator_wrapper_error(self):
+        # a non-callable key makes Wrapper.__init__ raise TypeError
+        class Cached:
+            def __init__(self, cache):
+                self.cache = cache
+
+            @cachedmethod(lambda self: self.cache, key=None)  # type: ignore
+            def get(self, value):
+                return value
+
+            @cachedmethod(lambda self: self.cache, key=None, info=True)  # type: ignore
+            def get_info(self, value):
+                return value
+
+        class CachedChild(Cached):
+            def get(self, value):  # type: ignore
+                return super().get(value)
+
+            def get_info(self, value):
+                return super().get_info(value)
+
+        cached = CachedChild(self.cache(2))
+        with self.assertRaisesRegex(TypeError, "must be callable"):
+            cached.get(0)
+        with self.assertRaisesRegex(TypeError, "must be callable"):
+            cached.get_info(0)
 
     def test_decorator_different_names(self):
         # RuntimeError for Python < 3.12, TypeError otherwise

{cachetools-7.2.6 → cachetools-7.2.7}/tests/test_classmethod.py

@@ -36,6 +36,12 @@ class Cached:
         cls.count += 1
         return cls.count
 
+    @classmethod
+    @cachedmethod(lambda cls: cls.cache, info=True)
+    def get_info(cls, value):
+        cls.count += 1
+        return cls.count
+
 
 class CachedClassMethodTest(unittest.TestCase):
     def test(self):
@@ -114,6 +120,43 @@ class CachedClassMethodTest(unittest.TestCase):
         self.assertIs(w[0].category, DeprecationWarning)
         self.assertIs(w[1].category, DeprecationWarning)
 
+    def test_info(self):
+        # info=True requires an instance method, so calls fail on all
+        # supported Python versions
+        Cached.cache = LRUCache(2)
+        cached = Cached()
+
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore")
+            with self.assertRaises(TypeError):
+                cached.get_info(0)
+            with self.assertRaises(TypeError):
+                Cached.get_info(0)
+            self.assertEqual(len(Cached.cache), 0)
+
+    def test_shared_cache(self):
+        class Child(Cached):
+            pass
+
+        # cache is a class attribute, so it is shared with subclasses
+        Cached.cache = LRUCache(2)
+        Cached.count = 0
+
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore")
+            self.assertIs(Child.cache, Cached.cache)
+            self.assertEqual(Cached.get(0), 1)
+            self.assertEqual(Child.get(0), 1)
+            self.assertEqual(Child().get(0), 1)
+            self.assertEqual(len(Cached.cache), 1)
+            self.assertEqual(Child.get(1), 2)
+            self.assertEqual(Cached.get(1), 2)
+            self.assertEqual(len(Cached.cache), 2)
+
+            Child.get.cache_clear(Child)  # type: ignore
+            self.assertEqual(len(Cached.cache), 0)
+            self.assertEqual(Cached.get(0), 2)
+
     def test_clear(self):
         Cached.cache = LRUCache(2)
         Cached.count = 0