CacheToolsUtils 10.4__tar.gz → 12.0__tar.gz

{cachetoolsutils-10.4 → cachetoolsutils-12.0}/CacheToolsUtils.egg-info/PKG-INFO

@@ -1,16 +1,15 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: CacheToolsUtils
-Version: 10.4
+Version: 12.0
 Summary: Cachetools Utilities
 Author-email: Fabien Coelho <cachetools.utils@coelho.net>
-License: CC0
+License-Expression: CC0-1.0
 Project-URL: repository, https://github.com/zx80/cachetools-utils
 Project-URL: documentation, https://zx80.github.io/cachetools-utils/
 Project-URL: issues, https://github.com/zx80/cachetools-utils/issues
 Project-URL: package, https://pypi.org/project/CacheToolsUtils/
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
 Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
@@ -27,11 +26,9 @@ Requires-Dist: pytest; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pymarkdownlnt; extra == "dev"
 Provides-Extra: doc
-Requires-Dist: sphinx; extra == "doc"
-Requires-Dist: sphinx_rtd_theme; extra == "doc"
-Requires-Dist: sphinx-autoapi; extra == "doc"
-Requires-Dist: sphinx-lint; extra == "doc"
-Requires-Dist: myst_parser; extra == "doc"
+Requires-Dist: mkdocs; extra == "doc"
+Requires-Dist: mkdocs-material; extra == "doc"
+Requires-Dist: mkdocstrings[python]; extra == "doc"
 Provides-Extra: crypt
 Requires-Dist: pycryptodome; extra == "crypt"
 Provides-Extra: tests
@@ -41,6 +38,7 @@ Provides-Extra: pub
 Requires-Dist: build; extra == "pub"
 Requires-Dist: wheel; extra == "pub"
 Requires-Dist: twine; extra == "pub"
+Dynamic: license-file
 
 # CacheToolsUtils
 

{cachetoolsutils-10.4 → cachetoolsutils-12.0}/CacheToolsUtils.egg-info/requires.txt

@@ -14,11 +14,9 @@ coverage
 pymarkdownlnt
 
 [doc]
-sphinx
-sphinx_rtd_theme
-sphinx-autoapi
-sphinx-lint
-myst_parser
+mkdocs
+mkdocs-material
+mkdocstrings[python]
 
 [pub]
 build

{cachetoolsutils-10.4 → cachetoolsutils-12.0}/CacheToolsUtils.py

@@ -5,7 +5,8 @@ CacheTools Utilities. This code is public domain.
 # FIXME 3.13t checks without Cipher package
 # pyright: reportMissingImports=false
 
-from typing import Any, Callable, MutableMapping
+from typing import Any
+from collections.abc import Callable, MutableMapping
 import abc
 
 import base64
@@ -27,8 +28,12 @@ log = logging.getLogger(__name__)
 _NO_DEFAULT = object()
 
 
+class CTUError(Exception):
+    pass
+
+
 class _MutMapMix:
-    """Convenient MutableMapping Mixin, forward to _cache."""
+    """Convenient MutableMapping Mixin, forward to `_cache`."""
 
     # FIXME coverage reports this as missing with Python 3.14
     _cache: MutableMapping  # pragma: no cover
@@ -53,7 +58,7 @@ class _MutMapMix:
 
 
 class _KeyMutMapMix(_MutMapMix):
-    """Convenient MutableMapping Mixin with a key filter, forward to _cache."""
+    """Convenient MutableMapping Mixin with a key filter, forward to `_cache`."""
 
     @abc.abstractmethod
     def _key(self, key: Any) -> Any:  # pragma: no cover
@@ -73,7 +78,7 @@ class _KeyMutMapMix(_MutMapMix):
 
 
 class _StatsMix:
-    """Convenient Mixin to forward stats methods to _cache."""
+    """Convenient Mixin to forward stats methods to `_cache`."""
 
     def hits(self) -> float|None:
         return self._cache.hits()  # type: ignore
@@ -114,9 +119,11 @@ class _RedisMix:  # pragma: no cover
 class DebugCache(_StatsMix, MutableMapping):
     """Debug class.
 
-    :param cache: actual cache
-    :param log: logging instance
-    :param name: name of instance for output
+    Parameters:
+
+    - cache: actual cache
+    - log: logging instance
+    - name: name of instance for output
     """
 
     def __init__(self, cache: MutableMapping, log: logging.Logger, name="cache"):
@@ -162,10 +169,10 @@ class DebugCache(_StatsMix, MutableMapping):
 
 
 class DictCache(_MutMapMix, MutableMapping):
-    """Cache class based on dict."""
+    """Cache class based on `dict`."""
 
     def __init__(self):
-        self._cache = dict()
+        self._cache = {}
 
     def clear(self):
         self._cache.clear()
@@ -174,17 +181,19 @@ class DictCache(_MutMapMix, MutableMapping):
 class LockedCache(_MutMapMix, _StatsMix, _RedisMix, MutableMapping):
     """Cache class with a lock.
 
-    :param cache: actual cache.
-    :param lock: lock (context manager) to use
+    Parameters:
 
-    The locked layer should be the last one before the actual cache.
+    - cache: actual cache.
+    - lock: lock (context manager) to use
 
-    .. code-block: python
+    The locked layer should be the last one before the actual cache.
 
-       import threading
-       import cachetools as ct
-       import CacheToolsUtils as ctu
-       cache = ctu.LockedCache(ct.LFUCache(), threading.RLock())
+    ```python
+    import threading
+    import cachetools as ct
+    import CacheToolsUtils as ctu
+    cache = ctu.LockedCache(ct.LFUCache(), threading.RLock())
+    ```
     """
 
     def __init__(self, cache: MutableMapping, lock):
@@ -211,8 +220,10 @@ class LockedCache(_MutMapMix, _StatsMix, _RedisMix, MutableMapping):
 class PrefixedCache(_KeyMutMapMix, _StatsMix, MutableMapping):
     """Cache class to add a key prefix.
 
-    :param cache: actual cache.
-    :param prefix: prefix to prepend to keys.
+    Parameters:
+
+    - cache: actual cache.
+    - prefix: prefix to prepend to keys.
     """
 
     def __init__(self, cache: MutableMapping, prefix: str|bytes = ""):
@@ -232,9 +243,11 @@ class PrefixedCache(_KeyMutMapMix, _StatsMix, MutableMapping):
 class AutoPrefixedCache(PrefixedCache):
     """Cache class with an automatic counter-based string prefix.
 
-    :param cache: actual cache.
-    :param sep: prefix separator, default is ".".
-    :param method: encoding method in "b64", "b64u", "b32", "b32x", "b16",
+    Parameters:
+
+    - cache: actual cache.
+    - sep: prefix separator, default is ".".
+    - method: encoding method in "b64", "b64u", "b32", "b32x", "b16",
         "a85" and "b85". Default is "b64".
     """
 
@@ -253,7 +266,7 @@ class AutoPrefixedCache(PrefixedCache):
 
     def __init__(self, cache: MutableMapping, sep: str = ".", method: str = "b64"):
         if method not in AutoPrefixedCache._METHODS:
-            raise Exception(f"invalid conversion method: {method}")
+            raise CTUError(f"invalid conversion method: {method}")
         encoder = AutoPrefixedCache._METHODS[method]
         length = max(1, (AutoPrefixedCache._COUNTER.bit_length() + 7) // 8)
         # NOTE byteorder default added to 3.11
@@ -265,16 +278,17 @@ class AutoPrefixedCache(PrefixedCache):
 class StatsCache(_MutMapMix, MutableMapping):
     """Cache class to keep stats.
 
-    :param cache: actual cache.
+    Parameter:
 
-    .. code-block: python
+    - cache: actual cache.
 
-       import cachetools as ct
-       import CacheToolsUtils as ctu
-       cache = ctu.StatsCache(ct.LRUCache())
-       ...
+    ```python
+    import cachetools as ct
+    import CacheToolsUtils as ctu
+    cache = ctu.StatsCache(ct.LRUCache())
+    ```
 
-    Note that CacheTools ``cached`` decorator with ``info=True`` provides
+    Note that CacheTools `cached` decorator with `info=True` provides
     hits, misses, maxsize and currsize information.
     However, this only works for its own classes.
     """
@@ -329,9 +343,11 @@ class StatsCache(_MutMapMix, MutableMapping):
 class TwoLevelCache(_MutMapMix, MutableMapping):
     """Two-Level Cache class for CacheTools.
 
-    :param cache: first (smaller, shorter TTL) cache
-    :param cache2: second (larger, longer TTL) cache
-    :param resilient: whether to ignore cache2 failures
+    Parameters:
+
+    - cache: first (smaller, shorter TTL) cache
+    - cache2: second (larger, longer TTL) cache
+    - resilient: whether to ignore cache2 failures
     """
 
     def __init__(self, cache: MutableMapping, cache2: MutableMapping, resilient=False):
@@ -434,7 +450,7 @@ class _Cipher:
             kwargs = {"mode": cipher.MODE_CBC}
             size = 16
         else:
-            raise Exception(f"unexpected cipher: {name}")
+            raise CTUError(f"unexpected cipher: {name}")
         self._cipher = cipher
         self._params = params
         self._kwargs = kwargs
@@ -457,10 +473,12 @@ class _Cipher:
 class EncryptedCache(_KeyMutMapMix, _StatsMix, MutableMapping):
     """Encrypted Bytes Key-Value Cache.
 
-    :param secret: bytes of secret, at least 16 bytes.
-    :param hsize: size of hashed key, default is *16*.
-    :param csize: value checksum size, default is *0*.
-    :param cipher: chose cipher from "Salsa20", "AES-128-CBC" or "ChaCha20".
+    Parameters:
+
+    - secret: bytes of secret, at least 16 bytes.
+    - hsize: size of hashed key, default is *16*.
+    - csize: value checksum size, default is *0*.
+    - cipher: chose cipher from "Salsa20", "AES-128-CBC" or "ChaCha20".
 
     The key is *not* encrypted but simply hashed, thus they are
     fixed size with a very low collision probability.
@@ -553,14 +571,16 @@ class ToBytesCache(_KeyMutMapMix, _StatsMix, MutableMapping):
 def cached(cache, *args, **kwargs):
     """Extended decorator with delete and exists.
 
-    All parameters are forwarded to ``cachetools.cached``.
+    All parameters are forwarded to `cachetools.cached`.
 
-    :param cache: actual cache.
+    Parameter:
 
-    If *f(\\*args, \\*\\*kwargs)* is the ``cached`` function, then:
+    - cache: actual cache.
 
-    - ``f.cache_in(*args, **kwargs)`` tells whether the result is cached.
-    - ``f.cache_del(*args, **kwargs)`` deletes (invalidates) the cached result.
+    If *f(\\*args, \\*\\*kwargs)* is the _cached_ function, then:
+
+    - `f.cache_in(*args, **kwargs)` tells whether the result is cached.
+    - `f.cache_del(*args, **kwargs)` deletes (invalidates) the cached result.
     """
 
     def decorate(fun: Callable):
@@ -603,15 +623,17 @@ def cacheMethods(
 ):
     """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
+    Parameters:
 
-    .. code-block:: python
+    - cache: cache to use.
+    - obj: object instance to be cached.
+    - gen: generator of PrefixedCache.
+    - opts: additional parameters when calling `cached`.
+    - funs: name of methods and corresponding prefix
 
-       cacheMethods(cache, item, PrefixedCache, compute1="c1.", compute2="c2.")
+    ```python
+    cacheMethods(cache, item, PrefixedCache, compute1="c1.", compute2="c2.")
+    ```
     """
     for fun, prefix in funs.items():
         assert hasattr(obj, fun), f"cannot cache missing method {fun} on {obj}"
@@ -630,15 +652,17 @@ def cacheFunctions(
 ):
     """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
+    Parameters:
 
-    .. code-block:: python
+    - cache: cache to use.
+    - globs: global object dictionary.
+    - gen: generator of PrefixedCache.
+    - opts: additional parameters when calling `cached`.
+    - funs: name of functions and corresponding prefix
 
-       cacheFunctions(cache, globals(), PrefixedCache, fun1="f1.", fun2="f2.")
+    ```python
+    cacheFunctions(cache, globals(), PrefixedCache, fun1="f1.", fun2="f2.")
+    ```
     """
     for fun, prefix in funs.items():
         assert fun in globs, "caching functions: {fun} not found"
@@ -680,7 +704,7 @@ class _HashJsonKey:
         return self._key
 
 
-# NOTE not very useful, behaves as _HashJsonKey.
+# NOTE not very useful, behaves as _HashJsonKey, but is not a class.
 def hash_json_key(*args, **kwargs):
     """Function handling of above class, to keep it hidden."""
     return _HashJsonKey(*args, **kwargs)
@@ -697,13 +721,13 @@ def full_hash_key(*args, **kwargs) -> str:
 # MEMCACHED
 #
 class JsonSerde:
-    """JSON serialize/deserialize class for MemCached (``pymemcache``).
-
-    .. code-block:: python
+    """JSON serialize/deserialize class for MemCached (`pymemcache`).
 
-       import pymemcache as pmc
-       import CacheToolsUtils as ctu
-       pmc_cache = pmc.Client(server="localhost", serde=ctu.JsonSerde())
+    ```python
+    import pymemcache as pmc
+    import CacheToolsUtils as ctu
+    pmc_cache = pmc.Client(server="localhost", serde=ctu.JsonSerde())
+    ```
     """
 
     # keep strings, else json
@@ -724,22 +748,25 @@ class JsonSerde:
         elif flag == 3:
             return json.loads(value.decode("utf-8"))
         else:
-            raise Exception(f"Unknown serialization format: {flag}")
+            raise CTUError(f"Unknown serialization format: {flag}")
 
 
 class MemCached(_KeyMutMapMix, MutableMapping):
     """MemCached-compatible wrapper class for cachetools with key encoding.
 
-    :param cache: actual memcached cache.
+    Parameter:
 
-    .. code-block:: python
+    - cache: actual memcached cache.
 
-       import pymemcache as pmc
-       import CacheToolsUtils as ctu
-       cache = ctu.MemCached(pmc.Client(server="localhost", serde=ctu.JsonSerde()))
+    ```python
+    import pymemcache as pmc
+    import CacheToolsUtils as ctu
+    cache = ctu.MemCached(pmc.Client(server="localhost", serde=ctu.JsonSerde()))
 
-       @ctu.cached(cache=cache)
-       def whatever(...):
+    @ctu.cached(cache=cache)
+    def whatever(...):
+        ...
+    ```
     """
 
     def __init__(self, cache):
@@ -773,15 +800,17 @@ class MemCached(_KeyMutMapMix, MutableMapping):
 class PrefixedMemCached(MemCached):
     """MemCached-compatible wrapper class for cachetools with a key prefix.
 
-    :param cache: actual memcached cache.
-    :param prefix: post key-encoding prepended prefix.
+    Parameters:
 
-    .. code-block:: python
+    - cache: actual memcached cache.
+    - prefix: post key-encoding prepended prefix.
 
-       import pymemcache as pmc
-       import CacheToolsUtils as ctu
-       # add a "app." prefix to keys, after serialization
-       cache = ctu.PrefixedMemCached(pmc.Client(server="localhost", serde=ctu.JsonSerde()), "app.")
+    ```python
+    import pymemcache as pmc
+    import CacheToolsUtils as ctu
+    # add a "app." prefix to keys, after serialization
+    cache = ctu.PrefixedMemCached(pmc.Client(server="localhost", serde=ctu.JsonSerde()), "app.")
+    ```
     """
 
     def __init__(self, cache, prefix: str = ""):
@@ -796,20 +825,22 @@ class PrefixedMemCached(MemCached):
 # REDIS
 #
 class RedisCache(MutableMapping):
-    """Redis TTL-ed wrapper for cachetools (``redis``).
+    """Redis TTL-ed wrapper for cachetools (`redis`).
 
-    :param cache: actual redis cache.
-    :param ttl: time-to-live in seconds, used as default expiration (``ex``), default is 600.
-    :param raw: whether to serialize keys and values, default is *False*.
+    Parameters:
 
-    Keys and values are serialized in *JSON*.
+    - cache: actual redis cache.
+    - ttl: time-to-live in seconds, used as default expiration (`ex`), default is _600_.
+    - raw: whether to serialize keys and values, default is *False*.
 
-    .. code-block:: python
+    Keys and values are serialized in *JSON*.
 
-       import redis
-       import CacheToolsUtils as ctu
-       # redis with 1 hour expiration
-       cache = ctu.RedisCache(redis.Redis(host="localhost"), 3600)
+    ```python
+    import redis
+    import CacheToolsUtils as ctu
+    # redis with 1 hour expiration
+    cache = ctu.RedisCache(redis.Redis(host="localhost"), 3600)
+    ```
     """
 
     def __init__(self, cache, ttl=600, raw=False):
@@ -849,7 +880,7 @@ class RedisCache(MutableMapping):
         return self._cache.dbsize()
 
     def __iter__(self):
-        raise Exception("not implemented yet")
+        raise NotImplementedError("not implemented yet")
 
     def info(self, *args, **kwargs):
         """Return redis informations."""
@@ -889,16 +920,18 @@ class RedisCache(MutableMapping):
 class PrefixedRedisCache(RedisCache):
     """Prefixed Redis wrapper class for cachetools.
 
-    :param cache: actual redis cache.
-    :param prefix: post key encoding prefix, default is empty.
-    :param ttl: time-to-live in seconds, used as default expiration (``ex``), default is 600.
+    Parameters:
 
-    .. code-block:: python
+    - cache: actual redis cache.
+    - prefix: post key encoding prefix, default is empty.
+    - ttl: time-to-live in seconds, used as default expiration (`ex`), default is _600_.
 
-       import redis
-       import CacheToolsUtils as ctu
-       # redis with "app." prefix and 1 hour expiration
-       cache = ctu.PrefixedRedisCache(redis.Redis(host="localhost"), "app.", 3600)
+    ```python
+    import redis
+    import CacheToolsUtils as ctu
+    # redis with "app." prefix and 1 hour expiration
+    cache = ctu.PrefixedRedisCache(redis.Redis(host="localhost"), "app.", 3600)
+    ```
     """
 
     def __init__(self, cache, prefix: str = "", ttl=600):
@@ -919,5 +952,3 @@ class StatsRedisCache(PrefixedRedisCache):
 
     def flushdb(self):
         self._cache.clear()
-
-    pass

{cachetoolsutils-10.4 → cachetoolsutils-12.0}/PKG-INFO

@@ -1,16 +1,15 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: CacheToolsUtils
-Version: 10.4
+Version: 12.0
 Summary: Cachetools Utilities
 Author-email: Fabien Coelho <cachetools.utils@coelho.net>
-License: CC0
+License-Expression: CC0-1.0
 Project-URL: repository, https://github.com/zx80/cachetools-utils
 Project-URL: documentation, https://zx80.github.io/cachetools-utils/
 Project-URL: issues, https://github.com/zx80/cachetools-utils/issues
 Project-URL: package, https://pypi.org/project/CacheToolsUtils/
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
 Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
@@ -27,11 +26,9 @@ Requires-Dist: pytest; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pymarkdownlnt; extra == "dev"
 Provides-Extra: doc
-Requires-Dist: sphinx; extra == "doc"
-Requires-Dist: sphinx_rtd_theme; extra == "doc"
-Requires-Dist: sphinx-autoapi; extra == "doc"
-Requires-Dist: sphinx-lint; extra == "doc"
-Requires-Dist: myst_parser; extra == "doc"
+Requires-Dist: mkdocs; extra == "doc"
+Requires-Dist: mkdocs-material; extra == "doc"
+Requires-Dist: mkdocstrings[python]; extra == "doc"
 Provides-Extra: crypt
 Requires-Dist: pycryptodome; extra == "crypt"
 Provides-Extra: tests
@@ -41,6 +38,7 @@ Provides-Extra: pub
 Requires-Dist: build; extra == "pub"
 Requires-Dist: wheel; extra == "pub"
 Requires-Dist: twine; extra == "pub"
+Dynamic: license-file
 
 # CacheToolsUtils
 

{cachetoolsutils-10.4 → cachetoolsutils-12.0}/pyproject.toml

@@ -4,17 +4,16 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "CacheToolsUtils"
-version = "10.4"
+version = "12.0"
 authors = [ { name = "Fabien Coelho", email = "cachetools.utils@coelho.net" } ]
 description = "Cachetools Utilities"
 readme = "README.md"
-license = { text = "CC0" }
+license = "CC0-1.0"
 requires-python = ">= 3.10"
 dependencies = [ "cachetools" ]
 classifiers = [
   "Development Status :: 5 - Production/Stable",
   "Intended Audience :: Developers",
-  "License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication",
   "Programming Language :: Python",
   "Topic :: Software Development :: Libraries :: Python Modules"
 ]
@@ -37,7 +36,11 @@ dev = [
   "pytest", "coverage",
   "pymarkdownlnt",
 ]
-doc = [ "sphinx", "sphinx_rtd_theme", "sphinx-autoapi", "sphinx-lint", "myst_parser" ]
+doc = [ "mkdocs", "mkdocs-material", "mkdocstrings[python]" ]
 crypt = [ "pycryptodome" ]
 tests = [ "pymemcache", "redis" ]
 pub = [ "build", "wheel", "twine" ]
+
+[tool.ruff.lint]
+# ruff rules are what they are, but they are not always right
+ignore = ["BLE001", "B006", "I001", "RUF012"]