added method to forcibly clear the cach of a mtime_cached_property

ArcanaFramework · Sep 4, 2024 · df5bb4a · df5bb4a
1 parent 2ec11a8
commit df5bb4a
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/fileformats/core/tests/test_utils.py b/fileformats/core/tests/test_utils.py
@@ -391,3 +391,16 @@ def test_mtime_cached_property(tmp_path: Path):
     time.sleep(2)
     fspath.write_text("world")
     assert file.cached_prop == 1
+
+
+def test_mtime_cached_property_force_clear(tmp_path: Path):
+    fspath = tmp_path / "file_1.txt"
+    fspath.write_text("hello")
+
+    file = MtimeTestFile(fspath)
+
+    file.flag = 0
+    assert file.cached_prop == 0
+    file.flag = 1
+    MtimeTestFile.cached_prop.clear(file)
+    assert file.cached_prop == 1
diff --git a/fileformats/core/utils.py b/fileformats/core/utils.py
@@ -266,6 +266,10 @@ def __init__(self, func: ty.Callable[..., ty.Any]):
     def _cache_name(self) -> str:
         return f"_{self.func.__name__}_mtime_cache"
 
+    def clear(self, instance: "fileformats.core.FileSet") -> None:
+        """Forcibly clear the cache"""
+        del instance.__dict__[self._cache_name]
+
     def __get__(
         self,
         instance: ty.Optional["fileformats.core.FileSet"],