pickle-function-cache 0.1.6__tar.gz → 0.1.7__tar.gz

{pickle_function_cache-0.1.6 → pickle_function_cache-0.1.7}/PKG-INFO

@@ -1,8 +1,7 @@
 Metadata-Version: 2.4
 Name: pickle-function-cache
-Version: 0.1.6
+Version: 0.1.7
 Summary: Caching of function results in a pickle file.
-License-Expression: MIT
 License-File: LICENSE.txt
 Author: Oleksandr Zelentsov
 Author-email: oleksandrzelentsov@gmail.com

{pickle_function_cache-0.1.6 → pickle_function_cache-0.1.7}/pickle_function_cache.py

@@ -14,7 +14,8 @@ OMIT_CACHE = (
 
 @dataclass(frozen=True)
 class ArgsContainer:
-    """Represents args and kwargs sent to a function."""
+    """Represents args and kwargs sent to a function.
+    Frozen to be able to serialize easily."""
 
     args: tuple[Any]
     kwargs: tuple[tuple[str, Any]]
@@ -27,7 +28,10 @@ class ArgsContainer:
         )
 
 
-def find_cache_file(filename: str, start_path: str | None = None) -> str:
+def find_file_in_parents(filename: str, start_path: str | None = None) -> str:
+    """
+    Find a file by specified name in a directory or any of its parent directories.
+    """
     cwd = Path(start_path or os.getcwd()).resolve()
     if cwd.is_file():
         cwd = cwd.parent
@@ -66,7 +70,7 @@ class Cache:
                 return {}
 
     def get_instance(self) -> dict:
-        """Returns the cache."""
+        """Returns the cached values, deserialized."""
         if self._cache is None:
             if self.filename in self._filename_caches:
                 self._cache = self._filename_caches[self.filename]
@@ -90,28 +94,17 @@ class Cache:
         pass
 
     def sync_global_cache(self):
+        """Record the cached values into the class variable."""
         cache = self.get_instance()
         self._filename_caches[self.filename] = cache
 
     @classmethod
     def invalidate_cache(cls, filename):
+        """Remove the file and remove the recorded data."""
         del cls._filename_caches[filename]
         os.unlink(filename)
 
 
-def set_cached_response(cache_filename, function_name, value, *args, **kwargs):
-    cache_instance = Cache(filename=cache_filename)
-    cache = cache_instance.get_instance()
-    if not isinstance(function_name, str):
-        function_name = function_name.__name__
-    if function_name not in cache:
-        cache[function_name] = {}
-
-    arguments = ArgsContainer.from_args_kwargs(*args, **kwargs)
-    cache[function_name][arguments] = value
-    cache_instance.save_instance()
-
-
 if OMIT_CACHE:
 
     def cache_responses(cache_filename):
@@ -121,6 +114,7 @@ if OMIT_CACHE:
         return decor
 
 else:
+
     def cache_responses(cache_filename):
         """Decorate a function with this and the function will get its result cached in a file."""
 

{pickle_function_cache-0.1.6 → pickle_function_cache-0.1.7}/pyproject.toml

@@ -1,12 +1,11 @@
 [project]
 name = "pickle-function-cache"
-version = "0.1.6"
+version = "0.1.7"
 description = "Caching of function results in a pickle file."
 authors = [
     {name = "Oleksandr Zelentsov", email = "oleksandrzelentsov@gmail.com"}
 ]
 readme = "README.md"
-license = "MIT"
 requires-python = ">=3.10"
 dependencies = []