9.3

Author: Fabien Coelho

CacheToolsUtils.py

@@ -380,10 +380,10 @@ def cached(cache, *args, **kwargs):
 
     def decorate(fun: Callable):
 
-        # use cachetools
+        # use cachetools "cached" decorator
         fun = cachetools.cached(cache, *args, **kwargs)(fun)
 
-        # extend
+        # extend it with two functions
         def cache_in(*args, **kwargs) -> bool:
             """Tell whether key is already in cache."""
             key = fun.cache_key(*args, **kwargs)  # type: ignore
@@ -409,12 +409,19 @@ def cache_del(*args, **kwargs):
 MapGen = Callable[[MutableMapping, str], MutableMapping]
 
 
-def cacheMethods(cache: MutableMapping, obj: Any, gen: MapGen = PrefixedCache, **funs):
+def cacheMethods(
+    cache: MutableMapping,
+    obj: Any,
+    gen: MapGen = PrefixedCache,
+    opts: dict[str, Any] = {},
+    **funs
+):
     """Cache some object methods.
 
     :param cache: cache to use.
     :param obj: object instance to be cached.
     :param gen: generator of PrefixedCache.
+    :param opts: additional parameters when calling `cached`.
     :param funs: name of methods and corresponding prefix
 
     .. code-block:: python
@@ -426,17 +433,22 @@ def cacheMethods(cache: MutableMapping, obj: Any, gen: MapGen = PrefixedCache, *
         f = getattr(obj, fun)
         while hasattr(f, "__wrapped__"):
             f = f.__wrapped__
-        setattr(obj, fun, cached(cache=gen(cache, prefix))(f))
+        setattr(obj, fun, cached(cache=gen(cache, prefix), **opts)(f))
 
 
 def cacheFunctions(
-    cache: MutableMapping, globs: MutableMapping[str, Any], gen: MapGen = PrefixedCache, **funs
+    cache: MutableMapping,
+    globs: MutableMapping[str, Any],
+    gen: MapGen = PrefixedCache,
+    opts: dict[str, Any] = {},
+    **funs
 ):
     """Cache some global functions, with a prefix.
 
     :param cache: cache to use.
     :param globs: global object dictionary.
     :param gen: generator of PrefixedCache.
+    :param opts: additional parameters when calling `cached`.
     :param funs: name of functions and corresponding prefix
 
     .. code-block:: python
@@ -448,7 +460,7 @@ def cacheFunctions(
         f = globs[fun]
         while hasattr(f, "__wrapped__"):
             f = f.__wrapped__
-        globs[fun] = cached(cache=gen(cache, prefix))(f)
+        globs[fun] = cached(cache=gen(cache, prefix), **opts)(f)
 
 
 # JSON-based key function

docs/REFERENCE.md

@@ -137,14 +137,15 @@ pcache = ctu.PrefixedRedisCache(rd_base, "pac.", ttl=3600)
 This utility function create a prefixed cache around methods of an object
 or functions in the global scope.
 First parameter is the actual cache, second parameter is the object or scope,
+`opts` named-parameter allows additional options to `cached`,
 and finally a keyword mapping from function names to prefixes.
 
 ```python
 # add cache to obj.get_data and obj.get_some
 ctu.cacheMethods(cache, obj, get_data="1.", get_some="2.")
 
 # add cache to some_func
-ctu.cacheFunctions(cache, globals(), some_func="f.")
+ctu.cacheFunctions(cache, globals(), opts={"key": ctu.json_key}, some_func="f.")
 ```
 
 ## Decorator cached

docs/VERSIONS.md

@@ -19,6 +19,11 @@ Install [package](https://pypi.org/project/CacheToolsUtils/) from
   Maybe the existing client can do that with appropriate options?
 - `cached`: add `contains` and `delete` parameters to change names?
 
+## 9.3 on 2024-12-06
+
+Add `opts` to provide additional parameters to cached when wrapping methods
+and functions.
+
 ## 9.2 on 2024-11-29
 
 Simpler and more compact json cache key function.

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "CacheToolsUtils"
-version = "9.2"
+version = "9.3"
 authors = [ { name = "Fabien Coelho", email = "[email protected]" } ]
 description = "Cachetools Utilities"
 readme = "README.md"

test.py

@@ -392,7 +392,7 @@ def test_methods():
     s = Stuff("test_methods")
     c = ct.TTLCache(1024, ttl=60)
     cs = ctu.StatsCache(c)
-    ctu.cacheMethods(cs, s, sum_n1="1.", sum_n2="2.")
+    ctu.cacheMethods(cs, s, opts={"key": ctu.json_key}, sum_n1="1.", sum_n2="2.")
     n2 = s.sum_n2(128)
     n1 = s.sum_n1(128)
     for i in range(1, 128):