pickle-debug 2.0__tar.gz → 2.1__tar.gz

{pickle_debug-2.0/src/pickle_debug.egg-info → pickle_debug-2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pickle_debug
-Version: 2.0
+Version: 2.1
 Summary: Store expensive objects from debugging
 Author: Gerard
 Author-email: gweatherby@uchc.edu
@@ -90,9 +90,10 @@ plain functions.
 
 ## API
 
-### `enable(directory)`
+### `enable(directory: str | Path | None)`
 Turn caching on, storing results in `directory` (a `str` or `Path`). The directory is created if
 needed and checked for writability. Raises `OSError` if it cannot be created or written.
+enable(None) disables caching.
 
 ### `cached(func)`
 Decorator. Returns a wrapper (using `functools.wraps`) that:

{pickle_debug-2.0 → pickle_debug-2.1}/README.md

@@ -78,9 +78,10 @@ plain functions.
 
 ## API
 
-### `enable(directory)`
+### `enable(directory: str | Path | None)`
 Turn caching on, storing results in `directory` (a `str` or `Path`). The directory is created if
 needed and checked for writability. Raises `OSError` if it cannot be created or written.
+enable(None) disables caching.
 
 ### `cached(func)`
 Decorator. Returns a wrapper (using `functools.wraps`) that:

{pickle_debug-2.0 → pickle_debug-2.1}/pyproject.toml

@@ -2,7 +2,7 @@
 name = "pickle_debug"
 description = "Store expensive objects from debugging"
 license = {text = "MIT" }
-version = "2.0"
+version = "2.1"
 dependencies = []
 requires-python= ">= 3.12"
 readme = "README.md"

{pickle_debug-2.0 → pickle_debug-2.1}/src/pickle_debug/__init__.py

@@ -18,16 +18,19 @@ _CACHE_DIRECTORY: Path | None = None
 _SUFFIX = '.pickle'
 
 
-def enable(directory: Path | str) -> None:
+def enable(directory: Path | str|None) -> None:
     """Enable caching in specified directory. Raises OSError if directory can't be created or written"""
     global _CACHE_DIRECTORY
-    directory = Path(directory)
-    directory.mkdir(parents=True, exist_ok=True)
-    # verify we can create and write files
-    with tempfile.TemporaryFile(dir=directory) as f:
-        f.write(b'test')
-    _CACHE_DIRECTORY = directory
-    pickle_debug_logger.debug(f"caching to {directory}")
+    if directory is not None:
+        directory = Path(directory)
+        directory.mkdir(parents=True, exist_ok=True)
+        # verify we can create and write files
+        with tempfile.TemporaryFile(dir=directory) as f:
+            f.write(b'test')
+        _CACHE_DIRECTORY = directory
+        pickle_debug_logger.debug(f"caching to {directory}")
+    else: 
+        _CACHE_DIRECTORY = None 
 
 
 def reset() -> None:

{pickle_debug-2.0 → pickle_debug-2.1/src/pickle_debug.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pickle_debug
-Version: 2.0
+Version: 2.1
 Summary: Store expensive objects from debugging
 Author: Gerard
 Author-email: gweatherby@uchc.edu
@@ -90,9 +90,10 @@ plain functions.
 
 ## API
 
-### `enable(directory)`
+### `enable(directory: str | Path | None)`
 Turn caching on, storing results in `directory` (a `str` or `Path`). The directory is created if
 needed and checked for writability. Raises `OSError` if it cannot be created or written.
+enable(None) disables caching.
 
 ### `cached(func)`
 Decorator. Returns a wrapper (using `functools.wraps`) that:

{pickle_debug-2.0 → pickle_debug-2.1}/src/pickle_debug.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ src/pickle_debug.egg-info/PKG-INFO
 src/pickle_debug.egg-info/SOURCES.txt
 src/pickle_debug.egg-info/dependency_links.txt
 src/pickle_debug.egg-info/top_level.txt
+src/test/ntest.py
 src/test/patch_test.py
 src/test/pd_test.py
 src/test/ttest.py

pickle_debug-2.1/src/test/ntest.py

@@ -0,0 +1,15 @@
+import time
+
+import pickle_debug
+
+
+@pickle_debug.cached
+def f(x, y=1):
+    print(f"call {x} {y}")
+    time.sleep(1.5)
+    return x + y
+
+
+pickle_debug.enable(None)
+print(f(1, 2))
+print(f(1, 2))