Cleaned up from comments

Author: seanlaw

stumpy/cache.py

@@ -205,39 +205,40 @@ def _recompile():
     return
 
 
-def _save(cache_dir):
+def _save():
     """
     Save all njit functions
 
     Parameters
     ----------
-    cache_dir : str
-        The path to the numba cache directory
+    None
 
     Returns
     -------
     None
     """
     _enable()
-    _clear(cache_dir)
     _recompile()
 
     return
 
 
-def save(cache_dir=None):
+def save():
     """
-    Save/overwrite all the cache data files of
-    all-so-far compiled njit functions.
+    Save/overwrite all of the cached njit functions.
 
     Parameters
     ----------
-    cache_dir : str, default None
-        The path to the numba cache directory
+    None
 
     Returns
     -------
     None
+
+    Notes
+    -----
+    The cache is never cleared before saving/overwriting and may be explicitly
+    cleared by calling `cache.clear()` before saving.
     """
     if numba.config.DISABLE_JIT:
         msg = "Could not save/cache function because NUMBA JIT is disabled"
@@ -250,6 +251,6 @@ def save(cache_dir=None):
         msg += "The `stumpy` cache files may not be saved/cleared correctly!"
         warnings.warn(msg)
 
-    _save(cache_dir)
+    _save()
 
     return

tests/test_cache.py

@@ -1,3 +1,4 @@
+import numba
 import numpy as np
 
 from stumpy import cache, stump
@@ -14,14 +15,21 @@ def test_cache_save_after_clear():
 
     cache_dir = "stumpy/__pycache__"
 
-    cache.save(cache_dir)
+    cache.clear(cache_dir)
+    cache.save()
+
     stump(T, m)
     ref_cache = cache._get_cache(cache_dir)
 
+    if numba.config.DISABLE_JIT:
+        assert len(ref_cache) == 0
+    else:  # pragma: no cover
+        assert len(ref_cache) > 0
+
     cache.clear(cache_dir)
     assert len(cache._get_cache(cache_dir)) == 0
+    cache.save()
 
-    cache.save(cache_dir)
     stump(T, m)
     comp_cache = cache._get_cache(cache_dir)