pytest-pickle-cache 0.1.0__tar.gz → 0.1.1__tar.gz

{pytest_pickle_cache-0.1.0 → pytest_pickle_cache-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-pickle-cache
-Version: 0.1.0
+Version: 0.1.1
 Summary: A pytest plugin for caching test results using pickle.
 Project-URL: Documentation, https://daizutabi.github.io/pytest-pickle-cache/
 Project-URL: Source, https://github.com/daizutabi/pytest-pickle-cache

{pytest_pickle_cache-0.1.0 → pytest_pickle_cache-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pytest-pickle-cache"
-version = "0.1.0"
+version = "0.1.1"
 authors = [{ name = "daizutabi", email = "daizutabi@gmail.com" }]
 description = "A pytest plugin for caching test results using pickle."
 readme = "README.md"

{pytest_pickle_cache-0.1.0 → pytest_pickle_cache-0.1.1}/src/pytest_pickle_cache/plugin.py

@@ -21,7 +21,18 @@ def use_cache(request: pytest.FixtureRequest) -> Callable[[str, Callable], Any]:
     and deserialized using pickle and base64 encoding.
     """
 
-    def use_cache(key: str, create: Callable[[], object]) -> Any:
+    def use_cache(key: str, create: Callable[[], Any]) -> Any:
+        """Retrieve a cached result or execute the function if not cached.
+
+        Args:
+            key (str): The key to identify the cached result.
+            func (Callable[[], Any]): The function to execute if the result is
+                not cached. The result of the function is serialized and stored
+                in the cache for future use.
+
+        Returns:
+            Any: The cached result or the result of the executed function.
+        """
         try:
             if value := request.config.cache.get(key, None):
                 return pickle.loads(base64.b64decode(value))