cachetools 6.2.4__tar.gz → 6.2.5__tar.gz

{cachetools-6.2.4 → cachetools-6.2.5}/CHANGELOG.rst

@@ -1,3 +1,14 @@
+v6.2.5 (2026-01-25)
+===================
+
+- Improve documentation regarding ``@cachedmethod`` with ``lock``
+  parameter.
+
+- Add test cases for cache stampede scenarios.
+
+- Update CI environment.
+
+
 v6.2.4 (2025-12-15)
 ===================
 

{cachetools-6.2.4 → cachetools-6.2.5}/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2025 Thomas Kemmer
+Copyright (c) 2014-2026 Thomas Kemmer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

{cachetools-6.2.4/src/cachetools.egg-info → cachetools-6.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cachetools
-Version: 6.2.4
+Version: 6.2.5
 Summary: Extensible memoizing collections and decorators
 Author-email: Thomas Kemmer <tkemmer@computer.org>
 Maintainer-email: Thomas Kemmer <tkemmer@computer.org>
@@ -127,7 +127,7 @@ Related Projects
 License
 ------------------------------------------------------------------------
 
-Copyright (c) 2014-2025 Thomas Kemmer.
+Copyright (c) 2014-2026 Thomas Kemmer.
 
 Licensed under the `MIT License`_.
 

{cachetools-6.2.4 → cachetools-6.2.5}/README.rst

@@ -102,7 +102,7 @@ Related Projects
 License
 ------------------------------------------------------------------------
 
-Copyright (c) 2014-2025 Thomas Kemmer.
+Copyright (c) 2014-2026 Thomas Kemmer.
 
 Licensed under the `MIT License`_.
 

{cachetools-6.2.4 → cachetools-6.2.5}/docs/conf.py

@@ -19,7 +19,7 @@ def get_version():
 
 
 project = "cachetools"
-copyright = "2014-2025 Thomas Kemmer"
+copyright = "2014-2026 Thomas Kemmer"
 release, version = get_version()
 
 extensions = [

{cachetools-6.2.4 → cachetools-6.2.5}/docs/index.rst

@@ -572,14 +572,15 @@ often called with the same arguments:
    .. testcode::
 
       from cachetools.keys import hashkey
-      from functools import partial
+      from threading import Lock
 
       class CachedPEPs:
 
           def __init__(self, cachesize):
               self.cache = LRUCache(maxsize=cachesize)
+              self.lock = Lock()
 
-          @cachedmethod(lambda self: self.cache)
+          @cachedmethod(lambda self: self.cache, lock=lambda self: self.lock)
           def get(self, num):
               """Retrieve text of a Python Enhancement Proposal"""
               url = 'http://www.python.org/dev/peps/pep-%04d/' % num

{cachetools-6.2.4 → cachetools-6.2.5}/src/cachetools/__init__.py

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

{cachetools-6.2.4 → cachetools-6.2.5/src/cachetools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cachetools
-Version: 6.2.4
+Version: 6.2.5
 Summary: Extensible memoizing collections and decorators
 Author-email: Thomas Kemmer <tkemmer@computer.org>
 Maintainer-email: Thomas Kemmer <tkemmer@computer.org>
@@ -127,7 +127,7 @@ Related Projects
 License
 ------------------------------------------------------------------------
 
-Copyright (c) 2014-2025 Thomas Kemmer.
+Copyright (c) 2014-2026 Thomas Kemmer.
 
 Licensed under the `MIT License`_.
 

{cachetools-6.2.4 → cachetools-6.2.5}/src/cachetools.egg-info/SOURCES.txt

@@ -25,5 +25,6 @@ tests/test_keys.py
 tests/test_lfu.py
 tests/test_lru.py
 tests/test_rr.py
+tests/test_threading.py
 tests/test_tlru.py
 tests/test_ttl.py

cachetools-6.2.5/tests/test_threading.py

@@ -0,0 +1,49 @@
+import threading
+import time
+import unittest
+from os import environ
+
+from cachetools import LRUCache, cached, cachedmethod
+
+
+@unittest.skipUnless(environ.get("THREADING_TESTS", False), "THREADING_TESTS not set")
+class ThreadingTest(unittest.TestCase):
+
+    NTHREADS = 10
+
+    cache = LRUCache(1)
+
+    cond = threading.Condition()
+
+    count = 0
+
+    @cached(cache=LRUCache(1), condition=threading.Condition(), info=True)
+    def func(self):
+        time.sleep(1.0)
+        return 42
+
+    @cachedmethod(cache=lambda self: self.cache, condition=lambda self: self.cond)
+    def meth(self):
+        time.sleep(1.0)
+        self.count += 1
+        return 42
+
+    def test_cached_stampede(self):
+        threads = [threading.Thread(target=self.func) for i in range(0, self.NTHREADS)]
+        for t in threads:
+            t.start()
+        for t in threads:
+            t.join()
+
+        info = self.func.cache_info()
+        self.assertEqual(info.hits, self.NTHREADS - 1)
+        self.assertEqual(info.misses, 1)
+
+    def test_cachedmethod_stampede(self):
+        threads = [threading.Thread(target=self.meth) for i in range(0, self.NTHREADS)]
+        for t in threads:
+            t.start()
+        for t in threads:
+            t.join()
+
+        self.assertEqual(self.count, 1)

{cachetools-6.2.4 → cachetools-6.2.5}/tox.ini

@@ -5,6 +5,8 @@ envlist = check-manifest,docs,doctest,flake8,py
 deps =
     pytest
     pytest-cov
+setenv =
+    THREADING_TESTS = 1
 commands =
     py.test --basetemp={envtmpdir} --cov=cachetools --cov-report term-missing {posargs}