persistent-function-cache 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

persistent_cache/main/cache_slot.py

@@ -0,0 +1,100 @@
+import inspect
+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
+from persistent_cache.reducers.base import Reducer
+
+from . import hashing
+
+
+@dataclass
+class CacheSlot:
+    function: Callable[..., Any]
+    args: tuple[Any, ...]
+    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
+    speedup_deep_learning: bool
+
+    @property
+    def value(self) -> Any:
+        try:
+            with self.path.open("rb") as fp:
+                return pickle.Unpickler(fp).load()  # noqa: S301
+        except (pickle.UnpicklingError, EOFError):
+            # discard values of corrupted or empty slots
+            raise KeyError from None
+
+    @value.setter
+    def value(self, value: Any) -> None:
+        self.path.byte_content = pickle.dumps(value)
+
+    @cached_property
+    def path(self) -> Path:
+        return (
+            self.directory
+            / self.function.__module__.replace(".", "_")
+            / self.function.__name__
+            / hashing.compute_hash(self.reducer, self.keys)
+        )
+
+    @property
+    def keys(self) -> Iterator[Any]:
+        yield self.function
+        is_iterable = isinstance(self.extra_keys, Iterable) and not isinstance(
+            self.extra_keys,
+            str | bytes | bytearray,
+        )
+        if is_iterable:
+            yield from self.extra_keys
+        else:
+            yield self.extra_keys
+        yield from self.argument_values
+
+    @property
+    def argument_values(self) -> Iterator[Any]:
+        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_
+
+            return Reducer_
+        if self.speedup_deep_learning:
+            from persistent_cache.reducers.speedup_deep_learning import (
+                Reducer as Reducer_,
+            )
+
+            return Reducer_
+
+        return Reducer

persistent_cache/main/decorator.py

@@ -1,20 +1,23 @@
-import inspect
-from collections.abc import Callable, Iterator
+from collections.abc import Callable, Iterable
 from functools import wraps
-from typing import Any, cast, overload
+from typing import Any, TypeVar, cast, overload
 
-from persistent_cache.models import F, Path
+from persistent_cache.models import Path
 from persistent_cache.reducers.base import Reducer
 
-from .cacheslot import CacheSlot
+from .cache_slot import CacheSlot
+
+F = TypeVar("F", bound=Callable[..., Any])
 
 
 @overload
 def cache(
     function: F,
     *,
-    cache_path: Path = Path.cache,
-    cache_key_arguments: tuple[str, ...] | str | None = None,
+    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,
     speedup_deep_learning: bool = False,
@@ -25,8 +28,10 @@ def cache(
 def cache(
     function: None = None,
     *,
-    cache_path: Path = Path.cache,
-    cache_key_arguments: tuple[str, ...] | str | None = None,
+    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,
     speedup_deep_learning: bool = False,
@@ -36,8 +41,10 @@ def cache(
 def cache(  # noqa: PLR0913
     function: F | None = None,
     *,
-    cache_path: Path = Path.cache,
-    cache_key_arguments: tuple[str, ...] | str | None = None,
+    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,
     speedup_deep_learning: bool = False,
@@ -55,68 +62,30 @@ def cache(  # noqa: PLR0913
         ...
     """
 
-    reducer = extract_reducer(
-        key_reducer,
-        deep_learning=deep_learning,
-        speedup_deep_learning=speedup_deep_learning,
-    )
-
-    def cache_decorator(function: F) -> F:
-        @wraps(function)
+    def cache_decorator(function_: F) -> F:
+        @wraps(function_)
         def wrapped_function(*args: Any, **kwargs: Any) -> Any:
-            arguments = tuple(
-                extract_argument_values(function, args, kwargs, cache_key_arguments),
+            cache_slot = CacheSlot(
+                function_,
+                args,
+                kwargs,
+                cache_directory,
+                cache_key_arguments,
+                argument_reducers,
+                extra_cache_keys,
+                key_reducer,
+                deep_learning,
+                speedup_deep_learning,
             )
-            cache_slot = CacheSlot(function, arguments, reducer, cache_path)
             try:
-                value = cache_slot.value
+                result = cache_slot.value
             except KeyError:
-                value = function(*args, **kwargs)
-                cache_slot.value = value
-            return value
+                result = function_(*args, **kwargs)
+                cache_slot.value = result
+            return result
 
         return cast(F, wrapped_function)
 
     if function is not None:
         cache_decorator = cache_decorator(function)
     return cache_decorator
-
-
-def extract_argument_values(
-    function: F,
-    args: tuple[Any, ...],
-    kwargs: dict[str, Any],
-    cache_key_arguments: tuple[str, ...] | str | None = None,
-) -> Iterator[Any]:
-    if cache_key_arguments is None:
-        yield from (args, kwargs)
-    else:
-        arguments = inspect.signature(function).bind(*args, **kwargs)
-        arguments.apply_defaults()
-        if isinstance(cache_key_arguments, str):
-            yield arguments.arguments.get(cache_key_arguments)
-        else:
-            for name in cache_key_arguments:
-                yield arguments.arguments.get(name)
-
-
-def extract_reducer(
-    reducer: type[Reducer] | None,
-    *,
-    deep_learning: bool,
-    speedup_deep_learning: bool,
-) -> type[Reducer]:
-    if reducer is None:
-        if deep_learning:
-            from persistent_cache.reducers.deep_learning import Reducer as Reducer_
-
-            reducer = Reducer_
-        elif speedup_deep_learning:
-            from persistent_cache.reducers.speedup_deep_learning import (
-                Reducer as Reducer_,
-            )
-
-            reducer = Reducer_
-        else:
-            reducer = Reducer
-    return reducer

persistent_cache/main/hashing.py

@@ -54,7 +54,7 @@ class HashPickler(pickle.Pickler):
             reduction = NotImplemented
         else:
             mapping = reducer(obj)
-            str_mapping = str(object_to_bytes(self.reducer, mapping))
+            str_mapping = str(item_to_bytes(self.reducer, mapping))
             reduction = str, (str_mapping,)
         return reduction
 
@@ -65,15 +65,16 @@ class HashPickler(pickle.Pickler):
                     yield reducer
 
 
-def compute_hash(key_reducer: type[Reducer], *args: Any) -> str:
-    data = object_to_bytes(key_reducer, args)
+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 object_to_bytes(key_reducer: type[Reducer], args: Any) -> bytes:
+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
-        HashPickler(fp, key_reducer).dump(args)
+        pickler = HashPickler(fp, key_reducer)
+        pickler.dump(item)
         fp.seek(0)
         return fp.read()

persistent_cache/models/__init__.py

@@ -1,2 +1 @@
-from .function import F
 from .path import Path

{persistent_function_cache-0.2.0.dist-info → persistent_function_cache-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: persistent-function-cache
-Version: 0.2.0
+Version: 0.2.2
 Summary: Persistent cache for expensive functions
 Author-email: Quinten Roets <qdr2104@columbia.edu>
 License: MIT

{persistent_function_cache-0.2.0.dist-info → persistent_function_cache-0.2.2.dist-info}/RECORD

@@ -6,19 +6,18 @@ persistent_cache/caches/speedup_deep_learning.py,sha256=bywNXeEZsg8Rs2A1_w-ZrJi9
 persistent_cache/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 persistent_cache/cli/clear_cache.py,sha256=YbKfqzUB9IyEpU-2n0h5BrK9kZKjbayqiMTzjPbDl3s,1541
 persistent_cache/main/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-persistent_cache/main/cacheslot.py,sha256=6jNF6B1aEW185aPJ7Wd7tzLIOcwqyNr2p9tkxUHhk5E,1217
-persistent_cache/main/decorator.py,sha256=ojMDckrv5Fwhh8RvUCeZwQl06I1Q61olvs1HSz-jtVY,3457
-persistent_cache/main/hashing.py,sha256=YP_HO9nJe2_ZkiQf-unM6W9y_k5TJW1JvWeZfPIXtug,2650
-persistent_cache/models/__init__.py,sha256=No2WagrzFJdeQE3hTIeFd2H8hhvvAFcdVH6z07D1vmI,47
-persistent_cache/models/function.py,sha256=C1w0rVOhUkqvpPkXNj85rc4GSJDqT0oIZLsZvhVwn58,113
+persistent_cache/main/cache_slot.py,sha256=MmWBcz798QA8N6CPXXNxYmlGb3HwbG21NbbFcavH6eU,3265
+persistent_cache/main/decorator.py,sha256=lE_0q-KEavCe8IaK8hwuMUxH-tkN1_v-Jgy_dM_8Uxw,2684
+persistent_cache/main/hashing.py,sha256=6GYzUJcqjfjHPWMqPOCEY9FUSH2k2zUGrUza2fKaMTQ,2688
+persistent_cache/models/__init__.py,sha256=1OeLZ6FZ5gAjlerAjc69Vx0AqWLSx6OSqNCpuzkCZQg,23
 persistent_cache/models/path.py,sha256=-HRJ4yqqmBPlax4H0KS8guhndBXNwCnl7WZXhtaWmGQ,441
 persistent_cache/reducers/__init__.py,sha256=hCozFuvrAb_gXLcqMMq92v4KdwBbQugwGwCmyLGt5RE,26
 persistent_cache/reducers/base.py,sha256=HsodcuE8Id5oV93_b_RN18I69UWsJ21yazXCwT1f6YU,1428
 persistent_cache/reducers/deep_learning.py,sha256=cyVolwmwm_ZN2gRxPtfJFqiNQlNuq_CrehO7ZSVWeVw,800
 persistent_cache/reducers/speedup_deep_learning.py,sha256=kMkr1467zUsQUPOi_N8tWKWAtKUcFgsk3rh94QhETg0,1970
-persistent_function_cache-0.2.0.dist-info/LICENSE,sha256=ENpNaBSvIV7ifD7iNz_-lBhImbiYowqPzBc5V5R8IhM,1070
-persistent_function_cache-0.2.0.dist-info/METADATA,sha256=thXWcG0Xy3rs1wV86vs7GcRcIYL8c_zAdwLitFoknNs,2164
-persistent_function_cache-0.2.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-persistent_function_cache-0.2.0.dist-info/entry_points.txt,sha256=fSZfuL6Wn42mZldojgGyg7dzSPCRVAuZox3w6dLd2ZI,88
-persistent_function_cache-0.2.0.dist-info/top_level.txt,sha256=Jj-Z9wxHRlRyDUxrfC9GeaV5-8hAf8R4LclQFZesxi8,17
-persistent_function_cache-0.2.0.dist-info/RECORD,,
+persistent_function_cache-0.2.2.dist-info/LICENSE,sha256=ENpNaBSvIV7ifD7iNz_-lBhImbiYowqPzBc5V5R8IhM,1070
+persistent_function_cache-0.2.2.dist-info/METADATA,sha256=PoI9EMIFqiZ21RHpHKNctkbdhu7h0LdHWD7TS-8_Krc,2164
+persistent_function_cache-0.2.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+persistent_function_cache-0.2.2.dist-info/entry_points.txt,sha256=fSZfuL6Wn42mZldojgGyg7dzSPCRVAuZox3w6dLd2ZI,88
+persistent_function_cache-0.2.2.dist-info/top_level.txt,sha256=Jj-Z9wxHRlRyDUxrfC9GeaV5-8hAf8R4LclQFZesxi8,17
+persistent_function_cache-0.2.2.dist-info/RECORD,,

persistent_cache/main/cacheslot.py

@@ -1,42 +0,0 @@
-import pickle
-from collections.abc import Callable
-from typing import Any, Generic, TypeVar, cast
-
-from persistent_cache.models import Path
-from persistent_cache.reducers.base import Reducer
-
-from . import hashing
-
-T = TypeVar("T")
-
-
-class CacheSlot(Generic[T]):
-    def __init__(
-        self,
-        function: Callable[..., T],
-        args: tuple[Any, ...],
-        key_reducer: type[Reducer] = Reducer,
-        cache_path: Path = Path.cache,
-    ) -> None:
-        # change cache key when implementation changes
-        cache_keys = (function, args)
-        self.location = (
-            cache_path
-            / function.__module__.replace(".", "_")
-            / function.__name__
-            / hashing.compute_hash(key_reducer, cache_keys)
-        )
-
-    @property
-    def value(self) -> T:
-        try:
-            with self.location.open("rb") as fp:
-                value = pickle.Unpickler(fp).load()  # noqa: S301
-        except (pickle.UnpicklingError, EOFError):
-            # discard values of corrupted or empty slots
-            raise KeyError from None
-        return cast(T, value)
-
-    @value.setter
-    def value(self, value: T) -> None:
-        self.location.byte_content = pickle.dumps(value)

persistent_cache/models/function.py

@@ -1,4 +0,0 @@
-from collections.abc import Callable
-from typing import Any, TypeVar
-
-F = TypeVar("F", bound=Callable[..., Any])