cachetools 6.2.0__tar.gz → 6.2.1__tar.gz

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

@@ -1,3 +1,13 @@
+v6.2.1 (2025-10-12)
+===================
+
+- Add support for Python 3.14.
+
+- Improve documentation.
+
+- Update CI environment.
+
+
 v6.2.0 (2025-08-25)
 ===================
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cachetools
-Version: 6.2.0
+Version: 6.2.1
 Summary: Extensible memoizing collections and decorators
 Home-page: https://github.com/tkem/cachetools/
 Author: Thomas Kemmer
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.9
 License-File: LICENSE

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

@@ -350,7 +350,7 @@ often called with the same arguments:
       `cache stampede`_ issues under high load, depending on your
       actual use case.  Providing a `condition` variable will mitigate
       these situations, but will inflict some performance penalty.
-   
+
    If no separate `lock` parameter is provided, `condition` must also
    implement the `context manager`_ protocol, and will also be used to
    guard access to the cache.
@@ -451,7 +451,7 @@ often called with the same arguments:
       [..., (('fib', 42), 267914296), ..., (('luc', 42), 599074578)]
 
 
-   Function invocations are _not_ cached if any exception are raised.
+   Function invocations are *not* cached if any exceptions are raised.
    To cache some (or all) calls raising exceptions, additional
    function wrappers may be introduced which wrap exceptions as
    regular function results for caching purposes:
@@ -488,6 +488,49 @@ often called with the same arguments:
           print(e, "-", _get_pep_wrapped.cache_info())
 
 
+   Curiously, default function arguments are not quite handled as one
+   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:
+
+   .. doctest::
+      :pyversion: >= 3
+
+      >>> @cached(LRUCache(maxsize=100))
+      ... def foo(a=1):
+      ...     print(f"foo({a}) called")
+      ...
+      >>> foo()
+      foo(1) called
+      >>> foo()
+      >>> foo(1)
+      foo(1) called
+      >>> foo(1)
+      >>> foo(a=1)
+      foo(1) called
+      >>> foo(a=1)
+
+   If consistent behavior is required, a private helper function may
+   be introduced to avoid ambiguities, e.g.:
+
+   .. doctest::
+      :pyversion: >= 3
+
+      >>> def foo(a=1):
+      ...     _foo(a)
+      ...
+      >>> @cached(LRUCache(maxsize=100))
+      ... def _foo(a):
+      ...     print(f"_foo({a}) called")
+      ...
+      >>> foo()
+      _foo(1) called
+      >>> foo()
+      >>> foo(1)
+      >>> foo(a=1)
+
+
 .. decorator:: cachedmethod(cache, key=cachetools.keys.methodkey, lock=None, condition=None)
 
    Decorator to wrap a class or instance method with a memoizing
@@ -731,8 +774,9 @@ all the decorators in this module are thread-safe by default.
 
    Decorator to wrap a function with a memoizing callable that saves
    up to `maxsize` results based on a Least Recently Used (LRU)
-   algorithm with a per-item time-to-live (TTL) value.
-
+   algorithm with a per-item time-to-live (TTL) value.  By default,
+   the time-to-live is set to 600 seconds and :func:`time.monotonic`
+   is used to retrieve the current time.
 
 .. _@lru_cache: https://docs.python.org/3/library/functools.html#functools.lru_cache
 .. _cache algorithm: https://en.wikipedia.org/wiki/Cache_algorithms

{cachetools-6.2.0 → cachetools-6.2.1}/setup.cfg

@@ -21,6 +21,7 @@ classifiers =
 	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]

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

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

{cachetools-6.2.0 → cachetools-6.2.1}/src/cachetools/func.py

@@ -92,6 +92,7 @@ def ttl_cache(maxsize=128, ttl=600, timer=time.monotonic, typed=False):
     """Decorator to wrap a function with a memoizing callable that saves
     up to `maxsize` results based on a Least Recently Used (LRU)
     algorithm with a per-item time-to-live (TTL) value.
+
     """
     if maxsize is None:
         return _cache(_UnboundTTLCache(ttl, timer), None, typed)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cachetools
-Version: 6.2.0
+Version: 6.2.1
 Summary: Extensible memoizing collections and decorators
 Home-page: https://github.com/tkem/cachetools/
 Author: Thomas Kemmer
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.9
 License-File: LICENSE