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

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

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

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

@@ -1,6 +1,6 @@
 [project]
 name = "persistent-function-cache"
-version = "0.2.0"
+version = "0.2.1"
 description = "Persistent cache for expensive functions"
 authors = [{name = "Quinten Roets", email = "qdr2104@columbia.edu"}]
 license = {text = "MIT"}

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

@@ -0,0 +1,90 @@
+import inspect
+import pickle
+from collections.abc import Callable, Iterable, Iterator
+from dataclasses import dataclass
+from functools import cached_property
+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
+    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:
+            yield from self.args
+            yield from self.kwargs.values()
+        else:
+            arguments = inspect.signature(self.function).bind(*self.args, **self.kwargs)
+            arguments.apply_defaults()
+            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)
+
+    @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_function_cache-0.2.1/src/persistent_cache/main/decorator.py

@@ -0,0 +1,87 @@
+from collections.abc import Callable, Iterable
+from functools import wraps
+from typing import Any, TypeVar, cast, overload
+
+from persistent_cache.models import Path
+from persistent_cache.reducers.base import Reducer
+
+from .cache_slot import CacheSlot
+
+F = TypeVar("F", bound=Callable[..., Any])
+
+
+@overload
+def cache(
+    function: F,
+    *,
+    cache_directory: Path = Path.cache,
+    cache_key_arguments: Iterable[str] | str | None = None,
+    extra_cache_keys: Iterable[Any] | None = None,
+    key_reducer: type[Reducer] = Reducer,
+    deep_learning: bool = False,
+    speedup_deep_learning: bool = False,
+) -> F: ...
+
+
+@overload
+def cache(
+    function: None = None,
+    *,
+    cache_directory: Path = Path.cache,
+    cache_key_arguments: Iterable[str] | str | None = None,
+    extra_cache_keys: Any = None,
+    key_reducer: type[Reducer] = Reducer,
+    deep_learning: bool = False,
+    speedup_deep_learning: bool = False,
+) -> Callable[[F], F]: ...
+
+
+def cache(  # noqa: PLR0913
+    function: F | None = None,
+    *,
+    cache_directory: Path = Path.cache,
+    cache_key_arguments: Iterable[str] | str | None = None,
+    extra_cache_keys: Any = None,
+    key_reducer: type[Reducer] | None = None,
+    deep_learning: bool = False,
+    speedup_deep_learning: bool = False,
+) -> F | Callable[[F], F]:
+    """A decorator to cache function results. Decorated functions are only executed if
+    result is not present in cache. The arguments of the function can be any nested
+    complex object.
+
+    Use as:
+
+    from persistent_cache import cache
+
+    @cache
+    def long_function(complex_object):
+        ...
+    """
+
+    def cache_decorator(function_: F) -> F:
+        @wraps(function_)
+        def wrapped_function(*args: Any, **kwargs: Any) -> Any:
+            cache_slot = CacheSlot(
+                function_,
+                args,
+                kwargs,
+                cache_directory,
+                cache_key_arguments,
+                extra_cache_keys,
+                key_reducer,
+                deep_learning,
+                speedup_deep_learning,
+            )
+            try:
+                result = cache_slot.value
+            except KeyError:
+                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

{persistent_function_cache-0.2.0 → persistent_function_cache-0.2.1}/src/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_function_cache-0.2.1/src/persistent_cache/models/__init__.py

@@ -0,0 +1 @@
+from .path import Path

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

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

{persistent_function_cache-0.2.0 → persistent_function_cache-0.2.1}/src/persistent_function_cache.egg-info/SOURCES.txt

@@ -9,11 +9,10 @@ src/persistent_cache/caches/speedup_deep_learning.py
 src/persistent_cache/cli/__init__.py
 src/persistent_cache/cli/clear_cache.py
 src/persistent_cache/main/__init__.py
-src/persistent_cache/main/cacheslot.py
+src/persistent_cache/main/cache_slot.py
 src/persistent_cache/main/decorator.py
 src/persistent_cache/main/hashing.py
 src/persistent_cache/models/__init__.py
-src/persistent_cache/models/function.py
 src/persistent_cache/models/path.py
 src/persistent_cache/reducers/__init__.py
 src/persistent_cache/reducers/base.py

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

@@ -7,6 +7,7 @@ import cli
 import pytest
 
 from persistent_cache import cache, deep_learning, speedup_deep_learning
+from persistent_cache.reducers import Reducer
 
 caches = [cache, deep_learning.cache, speedup_deep_learning.cache]
 
@@ -53,3 +54,33 @@ def test_cache_with_argument_names(cache_decorator: Callable[..., Any]) -> None:
         cache_key_arguments=cache_key_arguments,
     )
     cached_function("test")
+
+
+@pytest.mark.parametrize("cache_decorator", caches)
+def test_cache_with_extra_cache_key(
+    cache_decorator: Callable[..., Any],
+) -> None:
+    cached_function = cache_decorator(calculate_with_name, extra_cache_keys="value")
+    cached_function("test")
+
+
+@pytest.mark.parametrize("cache_decorator", caches)
+def test_cache_with_extra_cache_keys(
+    cache_decorator: Callable[..., Any],
+) -> None:
+    cached_function = cache_decorator(
+        calculate_with_name,
+        extra_cache_keys=("value",),
+    )
+    cached_function("test")
+
+
+@pytest.mark.parametrize("cache_decorator", caches)
+def test_cache_with_reducer(
+    cache_decorator: Callable[..., Any],
+) -> None:
+    cached_function = cache_decorator(
+        calculate_with_name,
+        key_reducer=Reducer,
+    )
+    cached_function("test")

persistent_function_cache-0.2.0/src/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_function_cache-0.2.0/src/persistent_cache/main/decorator.py

@@ -1,122 +0,0 @@
-import inspect
-from collections.abc import Callable, Iterator
-from functools import wraps
-from typing import Any, cast, overload
-
-from persistent_cache.models import F, Path
-from persistent_cache.reducers.base import Reducer
-
-from .cacheslot import CacheSlot
-
-
-@overload
-def cache(
-    function: F,
-    *,
-    cache_path: Path = Path.cache,
-    cache_key_arguments: tuple[str, ...] | str | None = None,
-    key_reducer: type[Reducer] = Reducer,
-    deep_learning: bool = False,
-    speedup_deep_learning: bool = False,
-) -> F: ...
-
-
-@overload
-def cache(
-    function: None = None,
-    *,
-    cache_path: Path = Path.cache,
-    cache_key_arguments: tuple[str, ...] | str | None = None,
-    key_reducer: type[Reducer] = Reducer,
-    deep_learning: bool = False,
-    speedup_deep_learning: bool = False,
-) -> Callable[[F], F]: ...
-
-
-def cache(  # noqa: PLR0913
-    function: F | None = None,
-    *,
-    cache_path: Path = Path.cache,
-    cache_key_arguments: tuple[str, ...] | str | None = None,
-    key_reducer: type[Reducer] | None = None,
-    deep_learning: bool = False,
-    speedup_deep_learning: bool = False,
-) -> F | Callable[[F], F]:
-    """A decorator to cache function results. Decorated functions are only executed if
-    result is not present in cache. The arguments of the function can be any nested
-    complex object.
-
-    Use as:
-
-    from persistent_cache import cache
-
-    @cache
-    def long_function(complex_object):
-        ...
-    """
-
-    reducer = extract_reducer(
-        key_reducer,
-        deep_learning=deep_learning,
-        speedup_deep_learning=speedup_deep_learning,
-    )
-
-    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, arguments, reducer, cache_path)
-            try:
-                value = cache_slot.value
-            except KeyError:
-                value = function(*args, **kwargs)
-                cache_slot.value = value
-            return value
-
-        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_function_cache-0.2.0/src/persistent_cache/models/__init__.py

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

persistent_function_cache-0.2.0/src/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])