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

persistent_cache/__init__.py

@@ -1 +1,2 @@
-from .caches.base import cache
+from .caches import deep_learning, speedup_deep_learning
+from .main.decorator import cache

persistent_cache/caches/deep_learning.py

@@ -1,4 +1,5 @@
+import functools
+
 from persistent_cache.main import decorator
-from persistent_cache.reducers.deep_learning import Reducer
 
-cache = decorator.cache(Reducer)
+cache = functools.partial(decorator.cache, deep_learning=True)

persistent_cache/caches/speedup_deep_learning.py

@@ -1,4 +1,5 @@
+import functools
+
 from persistent_cache.main import decorator
-from persistent_cache.reducers.speedup_deep_learning import Reducer
 
-cache = decorator.cache(Reducer)
+cache = functools.partial(decorator.cache, speedup_deep_learning=True)

persistent_cache/main/cacheslot.py

@@ -15,12 +15,11 @@ class CacheSlot(Generic[T]):
         self,
         function: Callable[..., T],
         args: tuple[Any, ...],
-        kwargs: Any,
         key_reducer: type[Reducer] = Reducer,
         cache_path: Path = Path.cache,
     ) -> None:
         # change cache key when implementation changes
-        cache_keys = (function, args, kwargs)
+        cache_keys = (function, args)
         self.location = (
             cache_path
             / function.__module__.replace(".", "_")

persistent_cache/main/decorator.py

@@ -1,20 +1,47 @@
-from collections.abc import Callable
+import inspect
+from collections.abc import Callable, Iterator
 from functools import wraps
-from typing import Any, TypeVar, cast
+from typing import Any, cast, overload
 
-from persistent_cache.models import Path
+from persistent_cache.models import F, Path
 from persistent_cache.reducers.base import Reducer
 
 from .cacheslot import CacheSlot
 
-T = TypeVar("T")
-F = TypeVar("F", bound=Callable[..., Any])
+
+@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,
-) -> Callable[[F], F]:
+    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.
@@ -28,10 +55,19 @@ def cache(
         ...
     """
 
+    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:
-            cache_slot = CacheSlot(function, args, kwargs, key_reducer, cache_path)
+            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:
@@ -41,4 +77,46 @@ def cache(
 
         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

@@ -4,13 +4,28 @@ import hashlib
 import inspect
 import io
 import pickle
-from typing import TYPE_CHECKING, Any, get_args, get_type_hints
+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
-    from typing import BinaryIO
+    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):
@@ -23,13 +38,9 @@ class HashPickler(pickle.Pickler):
         self.reducer = reducer
         self.reducers = {}
         for _, method in inspect.getmembers(reducer, predicate=inspect.ismethod):
-            type_hints = get_type_hints(method).values()
-            if type_hints:
-                argument_type = next(iter(type_hints))
-                argument_types = get_args(argument_type) or (argument_type,)
-                for argument_type in argument_types:
-                    self.reducers[argument_type] = method
-        self.reducers.pop(Any, None)
+            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

persistent_cache/models/__init__.py

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

persistent_cache/models/function.py

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

persistent_cache/reducers/__init__.py

@@ -0,0 +1 @@
+from .base import Reducer

persistent_cache/reducers/speedup_deep_learning.py

@@ -51,7 +51,7 @@ class Reducer(deep_learning.Reducer):
 
         # only use part of dataset for speedup
         data = dataset[13**17 % length] if length > 0 else []
-        if isinstance(data, tuple):
+        if isinstance(data, tuple) and len(data) == 2:  # noqa: PLR2004
             data, label = data
         else:
             label = None

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: persistent-function-cache
-Version: 0.1.0
+Version: 0.2.0
 Summary: Persistent cache for expensive functions
 Author-email: Quinten Roets <qdr2104@columbia.edu>
 License: MIT
@@ -8,21 +8,21 @@ Project-URL: Source Code, https://github.com/quintenroets/persistent-cache
 Requires-Python: <3.13,>=3.10
 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.6.7
+Requires-Dist: powercli<1,>=0.3.2
+Requires-Dist: superpathlib<3,>=2.0.9
 Provides-Extra: dev
-Requires-Dist: package-dev-tools <1,>=0.5.11 ; 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'
+Requires-Dist: package-dev-tools<1,>=0.5.11; 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"
 
 # 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)
 ![Operating system](https://img.shields.io/badge/os-linux%20%7c%20macOS%20%7c%20windows-brightgreen)
-![Coverage](https://img.shields.io/badge/coverage-88%25-brightgreen)
+![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
 
 ## Usage
 Use

persistent_function_cache-0.2.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+persistent_cache/__init__.py,sha256=VUq2BaLpsu66LXVBmRSBHGspctti2qavBqJNyja2yf8,91
+persistent_cache/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+persistent_cache/caches/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+persistent_cache/caches/deep_learning.py,sha256=tJQrRJK2Sbv7tIGwnrnFAn8nP-Fh7ZgugocKcXeiMnU,126
+persistent_cache/caches/speedup_deep_learning.py,sha256=bywNXeEZsg8Rs2A1_w-ZrJi9Ew2TvNCz59YryGyV0NI,134
+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/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.1.0.dist-info → persistent_function_cache-0.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

persistent_cache/caches/base.py

@@ -1,4 +0,0 @@
-from persistent_cache.main import decorator
-from persistent_cache.reducers.base import Reducer
-
-cache = decorator.cache(Reducer)

persistent_function_cache-0.1.0.dist-info/RECORD

@@ -1,24 +0,0 @@
-persistent_cache/__init__.py,sha256=_FBWL489shwwqfZXVPYVEL5kflvjp7R5vjpsfOOWu-M,31
-persistent_cache/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-persistent_cache/caches/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-persistent_cache/caches/base.py,sha256=En-iJjKx4qdVaLJdFholxLvSDtemnOMWGmBblS4cPak,129
-persistent_cache/caches/deep_learning.py,sha256=IcQ0JgtRt-Ke3XMplzn5W5rfjMx6l3fEmF4xxfQYzYQ,138
-persistent_cache/caches/speedup_deep_learning.py,sha256=qJzFMkSJh08jbyKjzhwC1aeLxvEekhSOB-tTicn7arY,146
-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=XIobyDDtMx1KpVxcz9dKo6-QEsFmK9Xej5j6dFieXk4,1246
-persistent_cache/main/decorator.py,sha256=wzyqdcjAL-dnMAaDO7qWGUg0glSfdM0a2INEwmRV8ak,1209
-persistent_cache/main/hashing.py,sha256=XrWahhJ0XTzo7tPMz5Tr1mGUF7pDTqRLV10aiALs5pc,2342
-persistent_cache/models/__init__.py,sha256=1OeLZ6FZ5gAjlerAjc69Vx0AqWLSx6OSqNCpuzkCZQg,23
-persistent_cache/models/path.py,sha256=-HRJ4yqqmBPlax4H0KS8guhndBXNwCnl7WZXhtaWmGQ,441
-persistent_cache/reducers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-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=CJBW92UvAOdZcWXBRN8NPp5DbDzeRTJ9-Yri6RsoTx8,1934
-persistent_function_cache-0.1.0.dist-info/LICENSE,sha256=ENpNaBSvIV7ifD7iNz_-lBhImbiYowqPzBc5V5R8IhM,1070
-persistent_function_cache-0.1.0.dist-info/METADATA,sha256=6LshL16QqQ1S-DNk52BUhHXpIdFWdqSmIpiO-ZeWNRI,2174
-persistent_function_cache-0.1.0.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-persistent_function_cache-0.1.0.dist-info/entry_points.txt,sha256=fSZfuL6Wn42mZldojgGyg7dzSPCRVAuZox3w6dLd2ZI,88
-persistent_function_cache-0.1.0.dist-info/top_level.txt,sha256=Jj-Z9wxHRlRyDUxrfC9GeaV5-8hAf8R4LclQFZesxi8,17
-persistent_function_cache-0.1.0.dist-info/RECORD,,