cachetools 6.2.1__tar.gz → 6.2.3__tar.gz

{cachetools-6.2.1 → cachetools-6.2.3}/CHANGELOG.rst

@@ -1,3 +1,24 @@
+v6.2.3 (2025-12-12)
+===================
+
+- Improve documentation regarding ``@cachedmethod`` with ``condition``
+  parameter.
+
+- Minor style and readability improvements.
+
+- Modernize build environment.
+
+- Update CI environment.
+
+
+v6.2.2 (2025-11-13)
+===================
+
+- Minor improvements from GitHub Copilot code review.
+
+- Improve documentation.
+
+
 v6.2.1 (2025-10-12)
 ===================
 

{cachetools-6.2.1/src/cachetools.egg-info → cachetools-6.2.3}/PKG-INFO

@@ -1,15 +1,13 @@
 Metadata-Version: 2.4
 Name: cachetools
-Version: 6.2.1
+Version: 6.2.3
 Summary: Extensible memoizing collections and decorators
-Home-page: https://github.com/tkem/cachetools/
-Author: Thomas Kemmer
-Author-email: tkemmer@computer.org
-License: MIT
+Author-email: Thomas Kemmer <tkemmer@computer.org>
+Maintainer-email: Thomas Kemmer <tkemmer@computer.org>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/tkem/cachetools/
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Other Environment
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -21,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
 License-File: LICENSE
 Dynamic: license-file
 
@@ -117,6 +116,7 @@ Related Projects
 ------------------------------------------------------------------------
 
 - asyncache_: Helpers to use cachetools_ with asyncio.
+- cachetools-async_: Helpers to use cachetools_ with asyncio.
 - cacheing_: Pure Python Cacheing Library.
 - CacheToolsUtils_: Stackable cache classes for sharing, encryption,
   statistics *and more* on top of cachetools_, redis_ and memcached_.
@@ -146,6 +146,7 @@ Licensed under the `MIT License`_.
 .. _MIT License: https://raw.github.com/tkem/cachetools/master/LICENSE
 
 .. _asyncache: https://pypi.org/project/asyncache/
+.. _cachetools-async: https://pypi.org/project/cachetools-async/
 .. _cacheing: https://pypi.org/project/cacheing/
 .. _CacheToolsUtils: https://pypi.org/project/CacheToolsUtils/
 .. _shelved-cache: https://pypi.org/project/shelved-cache/

{cachetools-6.2.1 → cachetools-6.2.3}/README.rst

@@ -91,6 +91,7 @@ Related Projects
 ------------------------------------------------------------------------
 
 - asyncache_: Helpers to use cachetools_ with asyncio.
+- cachetools-async_: Helpers to use cachetools_ with asyncio.
 - cacheing_: Pure Python Cacheing Library.
 - CacheToolsUtils_: Stackable cache classes for sharing, encryption,
   statistics *and more* on top of cachetools_, redis_ and memcached_.
@@ -120,6 +121,7 @@ Licensed under the `MIT License`_.
 .. _MIT License: https://raw.github.com/tkem/cachetools/master/LICENSE
 
 .. _asyncache: https://pypi.org/project/asyncache/
+.. _cachetools-async: https://pypi.org/project/cachetools-async/
 .. _cacheing: https://pypi.org/project/cacheing/
 .. _CacheToolsUtils: https://pypi.org/project/CacheToolsUtils/
 .. _shelved-cache: https://pypi.org/project/shelved-cache/

{cachetools-6.2.1 → cachetools-6.2.3}/docs/index.rst

@@ -232,7 +232,7 @@ With :class:`TTLCache` and :class:`TLRUCache`, items may also be
 removed after they expire.  In this case, :meth:`popitem` will *not*
 be called, but :meth:`expire` will be called from the next mutating
 operation and will return an iterable of the expired `(key, value)`
-pairs.  By overrding :meth:`expire`, a subclass will be able to track
+pairs.  By overriding :meth:`expire`, a subclass will be able to track
 expired items:
 
 .. doctest::
@@ -492,7 +492,7 @@ often called with the same arguments:
    might expect, and also the use of positional vs. keyword arguments
    may lead to surprising results.  In the example below, `foo()`,
    `foo(1)` and `foo(a=1)` are treated as different function
-   invocations, with seperately cached results:
+   invocations, with separately cached results:
 
    .. doctest::
       :pyversion: >= 3
@@ -555,6 +555,12 @@ often called with the same arguments:
    function, :func:`cachetools.keys.methodkey`, ignores its first
    argument, i.e. :const:`self`.  This has mostly historical reasons,
    but also ensures that :const:`self` does not have to be hashable.
+
+   .. note::
+
+      Using :func:`cachedmethod` with a `condition` currently *does*
+      require :const:`self` be hashable, though.
+
    You may provide a different `key` function,
    e.g. :func:`cachetools.keys.hashkey`, if you need :const:`self` to
    be part of the cache key.

cachetools-6.2.3/pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ["setuptools >= 61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cachetools"
+dynamic = ["version"]
+description = "Extensible memoizing collections and decorators"
+authors = [
+    {name = "Thomas Kemmer", email = "tkemmer@computer.org"}
+]
+maintainers = [
+    {name = "Thomas Kemmer", email = "tkemmer@computer.org"}
+]
+readme = "README.rst"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">= 3.9"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+Homepage = "https://github.com/tkem/cachetools/"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = {attr = "cachetools.__version__"}
+
+[tool.flake8]
+max-line-length = 80
+exclude = [".git", ".tox", "build"]
+select = ["C", "E", "F", "W", "B", "B950", "I", "N"]
+# F401: imported but unused (submodule shims)
+# E501: line too long (black)
+ignore = ["F401", "E501"]

cachetools-6.2.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{cachetools-6.2.1 → cachetools-6.2.3}/src/cachetools/__init__.py

@@ -12,7 +12,7 @@ __all__ = (
     "cachedmethod",
 )
 
-__version__ = "6.2.1"
+__version__ = "6.2.3"
 
 import collections
 import collections.abc
@@ -27,13 +27,13 @@ from . import keys
 class _DefaultSize:
     __slots__ = ()
 
-    def __getitem__(self, _):
+    def __getitem__(self, _key):
         return 1
 
-    def __setitem__(self, _, value):
-        assert value == 1
+    def __setitem__(self, _key, _value):
+        pass
 
-    def pop(self, _):
+    def pop(self, _key):
         return 1
 
 
@@ -55,7 +55,7 @@ class Cache(collections.abc.MutableMapping):
 
     def __repr__(self):
         return "%s(%s, maxsize=%r, currsize=%r)" % (
-            self.__class__.__name__,
+            type(self).__name__,
             repr(self.__data),
             self.__maxsize,
             self.__currsize,
@@ -100,6 +100,12 @@ class Cache(collections.abc.MutableMapping):
     def __len__(self):
         return len(self.__data)
 
+    # Note that we cannot simply inherit get(), pop() and setdefault()
+    # from MutableMapping, since these rely on __getitem__ throwing a
+    # KeyError on cache miss.  This is not the case if __missing__ is
+    # implemented for a Cache subclass, so we have to roll our own,
+    # somewhat less elegant versions.
+
     def get(self, key, default=None):
         if key in self:
             return self[key]
@@ -148,9 +154,9 @@ class FIFOCache(Cache):
 
     def __setitem__(self, key, value, cache_setitem=Cache.__setitem__):
         cache_setitem(self, key, value)
-        try:
+        if key in self.__order:
             self.__order.move_to_end(key)
-        except KeyError:
+        else:
             self.__order[key] = None
 
     def __delitem__(self, key, cache_delitem=Cache.__delitem__):
@@ -198,7 +204,8 @@ class LFUCache(Cache):
     def __setitem__(self, key, value, cache_setitem=Cache.__setitem__):
         cache_setitem(self, key, value)
         if key in self.__links:
-            return self.__touch(key)
+            self.__touch(key)
+            return
         root = self.__root
         link = root.next
         if link.count != 1:
@@ -642,7 +649,7 @@ class TLRUCache(_TimedCache):
             try:
                 key = next(iter(self.__items))
             except StopIteration:
-                raise KeyError("%s is empty" % self.__class__.__name__) from None
+                raise KeyError("%s is empty" % type(self).__name__) from None
             else:
                 return (key, self.pop(key))
 

{cachetools-6.2.1 → cachetools-6.2.3}/src/cachetools/_cached.py

@@ -63,7 +63,9 @@ def _locked_info(func, cache, key, lock, info):
         v = func(*args, **kwargs)
         with lock:
             try:
-                # in case of a race, prefer the item already in the cache
+                # In case of a race condition, i.e. if another thread
+                # stored a value for this key while we were calling
+                # func(), prefer the cached value.
                 return cache.setdefault(k, v)
             except ValueError:
                 return v  # value too large
@@ -107,8 +109,11 @@ def _unlocked_info(func, cache, key, info):
         cache.clear()
         hits = misses = 0
 
+    def cache_info():
+        return info(hits, misses)
+
     wrapper.cache_clear = cache_clear
-    wrapper.cache_info = lambda: info(hits, misses)
+    wrapper.cache_info = cache_info
     return wrapper
 
 
@@ -173,7 +178,7 @@ def _locked(func, cache, key, lock):
         v = func(*args, **kwargs)
         with lock:
             try:
-                # in case of a race, prefer the item already in the cache
+                # possible race condition: see above
                 return cache.setdefault(k, v)
             except ValueError:
                 return v  # value too large

{cachetools-6.2.1 → cachetools-6.2.3}/src/cachetools/keys.py

@@ -29,8 +29,8 @@ class _HashedTuple(tuple):
         return {}
 
 
-# used for separating keyword arguments; we do not use an object
-# instance here so identity is preserved when pickling/unpickling
+# A sentinel for separating args from kwargs.  Using the class itself
+# ensures uniqueness and preserves identity when pickling/unpickling.
 _kwmark = (_HashedTuple,)
 
 
@@ -38,7 +38,7 @@ def hashkey(*args, **kwargs):
     """Return a cache key for the specified hashable arguments."""
 
     if kwargs:
-        return _HashedTuple(args + sum(sorted(kwargs.items()), _kwmark))
+        return _HashedTuple(args + _kwmark + tuple(sorted(kwargs.items())))
     else:
         return _HashedTuple(args)
 
@@ -53,6 +53,7 @@ def typedkey(*args, **kwargs):
 
     key = hashkey(*args, **kwargs)
     key += tuple(type(v) for v in args)
+    # TODO: avoid iterating twice over kwargs
     key += tuple(type(v) for _, v in sorted(kwargs.items()))
     return key
 

{cachetools-6.2.1 → cachetools-6.2.3/src/cachetools.egg-info}/PKG-INFO

@@ -1,15 +1,13 @@
 Metadata-Version: 2.4
 Name: cachetools
-Version: 6.2.1
+Version: 6.2.3
 Summary: Extensible memoizing collections and decorators
-Home-page: https://github.com/tkem/cachetools/
-Author: Thomas Kemmer
-Author-email: tkemmer@computer.org
-License: MIT
+Author-email: Thomas Kemmer <tkemmer@computer.org>
+Maintainer-email: Thomas Kemmer <tkemmer@computer.org>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/tkem/cachetools/
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Other Environment
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -21,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
 License-File: LICENSE
 Dynamic: license-file
 
@@ -117,6 +116,7 @@ Related Projects
 ------------------------------------------------------------------------
 
 - asyncache_: Helpers to use cachetools_ with asyncio.
+- cachetools-async_: Helpers to use cachetools_ with asyncio.
 - cacheing_: Pure Python Cacheing Library.
 - CacheToolsUtils_: Stackable cache classes for sharing, encryption,
   statistics *and more* on top of cachetools_, redis_ and memcached_.
@@ -146,6 +146,7 @@ Licensed under the `MIT License`_.
 .. _MIT License: https://raw.github.com/tkem/cachetools/master/LICENSE
 
 .. _asyncache: https://pypi.org/project/asyncache/
+.. _cachetools-async: https://pypi.org/project/cachetools-async/
 .. _cacheing: https://pypi.org/project/cacheing/
 .. _CacheToolsUtils: https://pypi.org/project/CacheToolsUtils/
 .. _shelved-cache: https://pypi.org/project/shelved-cache/

{cachetools-6.2.1 → cachetools-6.2.3}/src/cachetools.egg-info/SOURCES.txt

@@ -3,8 +3,6 @@ LICENSE
 MANIFEST.in
 README.rst
 pyproject.toml
-setup.cfg
-setup.py
 tox.ini
 docs/conf.py
 docs/index.rst

{cachetools-6.2.1 → cachetools-6.2.3}/tox.ini

@@ -33,6 +33,7 @@ deps =
     flake8-black
     flake8-bugbear
     flake8-import-order
+    flake8-pyproject
 commands =
     flake8
 skip_install = true

cachetools-6.2.1/pyproject.toml

@@ -1,3 +0,0 @@
-[build-system]
-requires = ["setuptools >= 46.4.0", "wheel"]
-build-backend = "setuptools.build_meta"

cachetools-6.2.1/setup.cfg

@@ -1,50 +0,0 @@
-[metadata]
-name = cachetools
-version = attr: cachetools.__version__
-url = https://github.com/tkem/cachetools/
-author = Thomas Kemmer
-author_email = tkemmer@computer.org
-license = MIT
-license_files = LICENSE
-description = Extensible memoizing collections and decorators
-long_description = file: README.rst
-classifiers = 
-	Development Status :: 5 - Production/Stable
-	Environment :: Other Environment
-	Intended Audience :: Developers
-	License :: OSI Approved :: MIT License
-	Operating System :: OS Independent
-	Programming Language :: Python
-	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3.9
-	Programming Language :: Python :: 3.10
-	Programming Language :: Python :: 3.11
-	Programming Language :: Python :: 3.12
-	Programming Language :: Python :: 3.13
-	Programming Language :: Python :: 3.14
-	Topic :: Software Development :: Libraries :: Python Modules
-
-[options]
-package_dir = 
-	= src
-packages = find:
-python_requires = >= 3.9
-
-[options.packages.find]
-where = src
-
-[flake8]
-max-line-length = 80
-exclude = .git, .tox, build
-select = C, E, F, W, B, B950, I, N
-ignore = F401, E501
-
-[build_sphinx]
-source-dir = docs/
-build-dir = docs/_build
-all_files = 1
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

cachetools-6.2.1/setup.py

@@ -1,3 +0,0 @@
-from setuptools import setup
-
-setup()