persistent-function-cache 0.2.1__tar.gz → 0.3.0__tar.gz

{persistent_function_cache-0.2.1/src/persistent_function_cache.egg-info → persistent_function_cache-0.3.0}/PKG-INFO

@@ -1,26 +1,27 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: persistent-function-cache
-Version: 0.2.1
+Version: 0.3.0
 Summary: Persistent cache for expensive functions
 Author-email: Quinten Roets <qdr2104@columbia.edu>
-License: MIT
+License-Expression: MIT
 Project-URL: Source Code, https://github.com/quintenroets/persistent-cache
-Requires-Python: <3.13,>=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: package-utils<1,>=0.6.7
-Requires-Dist: powercli<1,>=0.3.2
-Requires-Dist: superpathlib<3,>=2.0.9
+Requires-Dist: package-utils<1,>=0.8.5
+Requires-Dist: powercli<1,>=0.4.0
+Requires-Dist: superpathlib<3,>=2.0.13
 Provides-Extra: dev
-Requires-Dist: package-dev-tools<1,>=0.5.11; extra == "dev"
+Requires-Dist: package-dev-tools<1,>=0.8.1; extra == "dev"
 Requires-Dist: package-dev-utils<1,>=0.1.6; extra == "dev"
 Requires-Dist: numpy<3,>=1.26.0; extra == "dev"
 Requires-Dist: torch<3,>=1.26.0; extra == "dev"
+Dynamic: license-file
 
 # Cache
 [![PyPI version](https://badge.fury.io/py/persistent-function-cache.svg)](https://badge.fury.io/py/persistent-function-cache)
 ![PyPI downloads](https://img.shields.io/pypi/dm/persistent-function-cache)
-![Python version](https://img.shields.io/badge/python-3.10--3.12-brightgreen)
+![Python version](https://img.shields.io/badge/python-3.11+-brightgreen)
 ![Operating system](https://img.shields.io/badge/os-linux%20%7c%20macOS%20%7c%20windows-brightgreen)
 ![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
 

{persistent_function_cache-0.2.1 → persistent_function_cache-0.3.0}/README.md

@@ -1,7 +1,7 @@
 # Cache
 [![PyPI version](https://badge.fury.io/py/persistent-function-cache.svg)](https://badge.fury.io/py/persistent-function-cache)
 ![PyPI downloads](https://img.shields.io/pypi/dm/persistent-function-cache)
-![Python version](https://img.shields.io/badge/python-3.10--3.12-brightgreen)
+![Python version](https://img.shields.io/badge/python-3.11+-brightgreen)
 ![Operating system](https://img.shields.io/badge/os-linux%20%7c%20macOS%20%7c%20windows-brightgreen)
 ![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
 

{persistent_function_cache-0.2.1 → persistent_function_cache-0.3.0}/pyproject.toml

@@ -1,20 +1,20 @@
 [project]
 name = "persistent-function-cache"
-version = "0.2.1"
+version = "0.3.0"
 description = "Persistent cache for expensive functions"
 authors = [{name = "Quinten Roets", email = "qdr2104@columbia.edu"}]
-license = {text = "MIT"}
+license = "MIT"
 readme = "README.md"
-requires-python = ">=3.10, <3.13"
+requires-python = ">=3.11"
 dependencies = [
-    "package-utils >=0.6.7, <1",
-    "powercli >=0.3.2, <1",
-    "superpathlib >=2.0.9, <3",
+    "package-utils >=0.8.5, <1",
+    "powercli >=0.4.0, <1",
+    "superpathlib >=2.0.13, <3",
 ]
 
 [project.optional-dependencies]
 dev = [
-    "package-dev-tools >=0.5.11, <1",
+    "package-dev-tools >=0.8.1, <1",
     "package-dev-utils >=0.1.6, <1",
     "numpy >=1.26.0, <3",
     "torch >=1.26.0, <3",
@@ -53,7 +53,14 @@ fix = true
 select = ["ALL"]
 ignore = [
     "ANN401",   # annotated with Any
+    "CPY001",   # missing copyright notice
     "D",        # docstrings
+    "D1",       # missing docstrings
+    "D200",     # one-line docstring
+    "D203",     # conflicts with D211
+    "D205",     # blank line between summary and description
+    "D212",     # conflicts with D213
+    "D401",     # imperative first line
     "G004",     # logging f-string
 ]
 

{persistent_function_cache-0.2.1 → persistent_function_cache-0.3.0}/src/persistent_cache/cli/clear_cache.py

@@ -1,6 +1,6 @@
 import time
 from dataclasses import dataclass
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from functools import cached_property
 from typing import Annotated
 
@@ -43,7 +43,7 @@ def main(options: Options) -> None:
             if options.verbose:
                 relative_path = path.relative_to(Options.cache_path)
                 timestamp = datetime.fromtimestamp(path.mtime).astimezone(
-                    tz=timezone.utc,
+                    tz=UTC,
                 )
                 message = f"{relative_path} ({timestamp})"
                 cli.console.print(message)

{persistent_function_cache-0.2.1 → persistent_function_cache-0.3.0}/src/persistent_cache/main/cache_slot.py

@@ -3,6 +3,7 @@ import pickle
 from collections.abc import Callable, Iterable, Iterator
 from dataclasses import dataclass
 from functools import cached_property
+from inspect import BoundArguments
 from typing import Any
 
 from persistent_cache.models import Path
@@ -18,6 +19,7 @@ class CacheSlot:
     kwargs: dict[str, Any]
     directory: Path
     key_arguments: Iterable[str] | str | None
+    argument_reducers: dict[str, Callable[[Any], Any]] | None
     extra_keys: Any
     key_reducer: type[Reducer] | None
     deep_learning: bool
@@ -60,28 +62,38 @@ class CacheSlot:
 
     @property
     def argument_values(self) -> Iterator[Any]:
-        if self.key_arguments is None:
+        if self.key_arguments is None and self.argument_reducers is None:
             yield from self.args
             yield from self.kwargs.values()
         else:
             arguments = inspect.signature(self.function).bind(*self.args, **self.kwargs)
             arguments.apply_defaults()
+            yield from self.extract_argument_values(arguments)
+
+    def extract_argument_values(self, arguments: BoundArguments) -> Iterator[Any]:
+        if self.key_arguments is not None:
             if isinstance(self.key_arguments, str):
                 yield arguments.arguments.get(self.key_arguments)
             else:
                 for name in self.key_arguments:
                     yield arguments.arguments.get(name)
+        if self.argument_reducers is not None:
+            for argument_name, reducer in self.argument_reducers.items():
+                argument = arguments.arguments.get(argument_name)
+                yield reducer(argument)
 
     @property
     def reducer(self) -> type[Reducer]:
         if self.key_reducer is not None:
             return self.key_reducer
         if self.deep_learning:
-            from persistent_cache.reducers.deep_learning import Reducer as Reducer_
+            from persistent_cache.reducers.deep_learning import (  # noqa: PLC0415
+                Reducer as Reducer_,
+            )
 
             return Reducer_
         if self.speedup_deep_learning:
-            from persistent_cache.reducers.speedup_deep_learning import (
+            from persistent_cache.reducers.speedup_deep_learning import (  # noqa: PLC0415
                 Reducer as Reducer_,
             )
 

{persistent_function_cache-0.2.1 → persistent_function_cache-0.3.0}/src/persistent_cache/main/decorator.py

@@ -16,6 +16,7 @@ def cache(
     *,
     cache_directory: Path = Path.cache,
     cache_key_arguments: Iterable[str] | str | None = None,
+    argument_reducers: dict[str, Callable[[Any], Any]] | None = None,
     extra_cache_keys: Iterable[Any] | None = None,
     key_reducer: type[Reducer] = Reducer,
     deep_learning: bool = False,
@@ -29,6 +30,7 @@ def cache(
     *,
     cache_directory: Path = Path.cache,
     cache_key_arguments: Iterable[str] | str | None = None,
+    argument_reducers: dict[str, Callable[[Any], Any]] | None = None,
     extra_cache_keys: Any = None,
     key_reducer: type[Reducer] = Reducer,
     deep_learning: bool = False,
@@ -41,6 +43,7 @@ def cache(  # noqa: PLR0913
     *,
     cache_directory: Path = Path.cache,
     cache_key_arguments: Iterable[str] | str | None = None,
+    argument_reducers: dict[str, Callable[[Any], Any]] | None = None,
     extra_cache_keys: Any = None,
     key_reducer: type[Reducer] | None = None,
     deep_learning: bool = False,
@@ -68,6 +71,7 @@ def cache(  # noqa: PLR0913
                 kwargs,
                 cache_directory,
                 cache_key_arguments,
+                argument_reducers,
                 extra_cache_keys,
                 key_reducer,
                 deep_learning,
@@ -80,7 +84,7 @@ def cache(  # noqa: PLR0913
                 cache_slot.value = result
             return result
 
-        return cast(F, wrapped_function)
+        return cast("F", wrapped_function)
 
     if function is not None:
         cache_decorator = cache_decorator(function)

persistent_function_cache-0.3.0/src/persistent_cache/main/hashing.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import hashlib
+import inspect
+import io
+import pickle
+from functools import cache
+from typing import TYPE_CHECKING, Any
+
+from package_utils.annotations import first_parameter_types
+
+if TYPE_CHECKING:
+    from collections.abc import Callable, Iterator  # pragma: nocover
+    from typing import BinaryIO  # pragma: nocover
+
+    from persistent_cache.reducers.base import Reducer  # pragma: nocover
+
+
+def compute_hash(key_reducer: type[Reducer], items: Iterator[Any]) -> str:
+    with io.BytesIO() as fp:
+        HashPickler(fp, key_reducer).dump(tuple(items))
+        data = fp.getvalue()
+    # use fast hash function because it is not used for security
+    return hashlib.new("sha1", data=data, usedforsecurity=False).hexdigest()
+
+
+class HashPickler(pickle.Pickler):
+    def __init__(self, file_pointer: BinaryIO, reducer: type[Reducer]) -> None:
+        super().__init__(file_pointer)
+        self.reducers = load_reducers(reducer)  # type: ignore[arg-type]
+
+    def reducer_override(self, obj: Any) -> Any:
+        """The goal of this pickler is to create hashes of complex objects, not to
+        reconstruct complex objects.
+
+        So mapping does not need to be reversible.
+        """
+        reducer = next(self.determine_reducer(obj), None)
+        return NotImplemented if reducer is None else (tuple, (reducer(obj),))
+
+    def determine_reducer(self, obj: Any) -> Iterator[Callable[[Any], Any]]:
+        if obj is not tuple:
+            for obj_type, reducer in self.reducers.items():
+                if isinstance(obj, obj_type):
+                    yield reducer
+
+
+@cache
+def load_reducers(reducer: type[Reducer]) -> dict[type, Callable[[Any], Any]]:
+    return {
+        parameter_type: method
+        for _, method in inspect.getmembers(reducer, predicate=inspect.ismethod)
+        for parameter_type in first_parameter_types(method)
+    }

{persistent_function_cache-0.2.1 → persistent_function_cache-0.3.0}/src/persistent_cache/models/path.py

@@ -1,4 +1,4 @@
-from typing import TypeVar, cast
+from typing import Self, TypeVar, cast
 
 import superpathlib
 from simple_classproperty import classproperty
@@ -9,11 +9,11 @@ T = TypeVar("T", bound="Path")
 class Path(superpathlib.Path):
     @classmethod
     @classproperty
-    def source_root(cls: type[T]) -> T:
+    def source_root(cls) -> Self:
         return cls(__file__).parent.parent
 
     @classmethod
     @classproperty
-    def cache(cls: type[T]) -> T:
+    def cache(cls) -> Self:
         path = cls.script_assets / cls.source_root.name
-        return cast(T, path)
+        return cast("Self", path)

{persistent_function_cache-0.2.1 → persistent_function_cache-0.3.0}/src/persistent_cache/reducers/speedup_deep_learning.py

@@ -57,7 +57,3 @@ class Reducer(deep_learning.Reducer):
             label = None
 
         return length, data, label
-
-    @classmethod
-    def reduce_tensor(cls, tensor: torch.Tensor) -> NDArray[Any]:
-        return tensor.detach().cpu().numpy()

{persistent_function_cache-0.2.1 → persistent_function_cache-0.3.0/src/persistent_function_cache.egg-info}/PKG-INFO

@@ -1,26 +1,27 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: persistent-function-cache
-Version: 0.2.1
+Version: 0.3.0
 Summary: Persistent cache for expensive functions
 Author-email: Quinten Roets <qdr2104@columbia.edu>
-License: MIT
+License-Expression: MIT
 Project-URL: Source Code, https://github.com/quintenroets/persistent-cache
-Requires-Python: <3.13,>=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: package-utils<1,>=0.6.7
-Requires-Dist: powercli<1,>=0.3.2
-Requires-Dist: superpathlib<3,>=2.0.9
+Requires-Dist: package-utils<1,>=0.8.5
+Requires-Dist: powercli<1,>=0.4.0
+Requires-Dist: superpathlib<3,>=2.0.13
 Provides-Extra: dev
-Requires-Dist: package-dev-tools<1,>=0.5.11; extra == "dev"
+Requires-Dist: package-dev-tools<1,>=0.8.1; extra == "dev"
 Requires-Dist: package-dev-utils<1,>=0.1.6; extra == "dev"
 Requires-Dist: numpy<3,>=1.26.0; extra == "dev"
 Requires-Dist: torch<3,>=1.26.0; extra == "dev"
+Dynamic: license-file
 
 # Cache
 [![PyPI version](https://badge.fury.io/py/persistent-function-cache.svg)](https://badge.fury.io/py/persistent-function-cache)
 ![PyPI downloads](https://img.shields.io/pypi/dm/persistent-function-cache)
-![Python version](https://img.shields.io/badge/python-3.10--3.12-brightgreen)
+![Python version](https://img.shields.io/badge/python-3.11+-brightgreen)
 ![Operating system](https://img.shields.io/badge/os-linux%20%7c%20macOS%20%7c%20windows-brightgreen)
 ![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
 

persistent_function_cache-0.3.0/src/persistent_function_cache.egg-info/requires.txt

@@ -0,0 +1,9 @@
+package-utils<1,>=0.8.5
+powercli<1,>=0.4.0
+superpathlib<3,>=2.0.13
+
+[dev]
+package-dev-tools<1,>=0.8.1
+package-dev-utils<1,>=0.1.6
+numpy<3,>=1.26.0
+torch<3,>=1.26.0

{persistent_function_cache-0.2.1 → persistent_function_cache-0.3.0}/tests/test_cache.py

@@ -84,3 +84,14 @@ def test_cache_with_reducer(
         key_reducer=Reducer,
     )
     cached_function("test")
+
+
+@pytest.mark.parametrize("cache_decorator", caches)
+def test_cache_with_argument_reducer(
+    cache_decorator: Callable[..., Any],
+) -> None:
+    cached_function = cache_decorator(
+        calculate_with_name,
+        argument_reducers={"value": lambda x: x.strip()},
+    )
+    cached_function("test")

persistent_function_cache-0.2.1/src/persistent_cache/main/hashing.py

@@ -1,80 +0,0 @@
-from __future__ import annotations
-
-import hashlib
-import inspect
-import io
-import pickle
-from types import UnionType
-from typing import TYPE_CHECKING, Any, get_args, get_origin, get_type_hints
-
-from persistent_cache.reducers.base import Reducer
-
-if TYPE_CHECKING:
-    from collections.abc import Callable, Iterator  # pragma: nocover
-    from typing import BinaryIO  # pragma: nocover
-
-
-def extract_types(method: Callable[[Any], Any]) -> Iterator[type]:
-    type_hints = get_type_hints(method).values()
-    if type_hints:
-        argument_type = next(iter(type_hints))
-        origin = get_origin(argument_type)
-        arguments = get_args(argument_type)
-        if origin is UnionType:
-            yield from arguments
-        elif origin is not None:
-            yield origin
-        else:
-            yield argument_type
-
-
-class HashPickler(pickle.Pickler):
-    def __init__(
-        self,
-        file_pointer: BinaryIO,
-        reducer: type[Reducer] = Reducer,
-    ) -> None:
-        super().__init__(file_pointer)
-        self.reducer = reducer
-        self.reducers = {}
-        for _, method in inspect.getmembers(reducer, predicate=inspect.ismethod):
-            argument_types = extract_types(method)
-            for argument_type in argument_types:
-                self.reducers[argument_type] = method
-
-    def reducer_override(self, obj: Any) -> Any:
-        """The goal of this pickler is to create hashes of complex objects, not to
-        reconstruct complex objects.
-
-        So mapping does not need to be reversible.
-        """
-        reducer = next(self.determine_reducer(obj), None)
-        reduction: Any
-        if reducer is None:
-            reduction = NotImplemented
-        else:
-            mapping = reducer(obj)
-            str_mapping = str(item_to_bytes(self.reducer, mapping))
-            reduction = str, (str_mapping,)
-        return reduction
-
-    def determine_reducer(self, obj: Any) -> Iterator[Callable[[Any], Any]]:
-        if obj is not str:
-            for obj_type, reducer in self.reducers.items():
-                if isinstance(obj, obj_type):
-                    yield reducer
-
-
-def compute_hash(key_reducer: type[Reducer], items: Iterator[Any]) -> str:
-    data = item_to_bytes(key_reducer, tuple(items))
-    # use fast hash function because it is not used for security
-    return hashlib.new("sha1", data=data, usedforsecurity=False).hexdigest()
-
-
-def item_to_bytes(key_reducer: type[Reducer], item: Any) -> bytes:
-    with io.BytesIO() as fp:
-        # Use custom pickler to generate bytes from complex structures
-        pickler = HashPickler(fp, key_reducer)
-        pickler.dump(item)
-        fp.seek(0)
-        return fp.read()

persistent_function_cache-0.2.1/src/persistent_function_cache.egg-info/requires.txt

@@ -1,9 +0,0 @@
-package-utils<1,>=0.6.7
-powercli<1,>=0.3.2
-superpathlib<3,>=2.0.9
-
-[dev]
-package-dev-tools<1,>=0.5.11
-package-dev-utils<1,>=0.1.6
-numpy<3,>=1.26.0
-torch<3,>=1.26.0