Merge pull request #153 from LilSpazJoekp/fix-cache

Fix import issue when loading cache in certain environments

Author: LilSpazJoekp

CHANGES.rst

@@ -29,6 +29,7 @@ Unreleased
   4. Default of 88
 - Image and Unicode substitution definitions were not being formatted correctly.
 - Files specified in pyproject are now parsed correctly.
+- Fixed issue when loading cache in certain environments.
 
 **Removed**
 

docstrfmt/util.py

@@ -82,7 +82,7 @@ def _get_cache_filename(self) -> Path:
             / f"cache.{f'{docstring_trailing_line}_{format_python_code_blocks}_{include_txt}_{line_length}_{mode}'}.pickle"
         )
 
-    def _read_cache(self) -> dict[Path, tuple[float, int]]:
+    def _read_cache(self) -> dict[str, tuple[float, int]]:
         """Read the cache file."""
         cache_file = self._get_cache_filename()
         if not cache_file.exists():
@@ -101,9 +101,12 @@ def gen_todo_list(self, files: list[str]) -> tuple[set[Path], set[Path]]:
         """Generate the list of files to process."""
         todo, done = set(), set()
         for file in (Path(f).resolve() for f in files):
-            if self.cache.get(file) != self._get_file_info(file) or self.ignore_cache:
+            if (
+                self.cache.get(str(file)) != self._get_file_info(file)
+                or self.ignore_cache
+            ):
                 todo.add(file)
-            else:  # pragma: no cover
+            else:
                 done.add(file)
         return todo, done
 
@@ -114,7 +117,7 @@ def write_cache(self, files: list[Path]) -> None:
             self.cache_dir.mkdir(parents=True, exist_ok=True)
             new_cache = {
                 **self.cache,
-                **{file.resolve(): self._get_file_info(file) for file in files},
+                **{str(file.resolve()): self._get_file_info(file) for file in files},
             }
             with tempfile.NamedTemporaryFile(
                 dir=str(cache_file.parent), delete=False

tests/test_main.py

@@ -675,6 +675,26 @@ def test_globbing(runner, file):
     assert result.output.endswith("were reformatted.\nDone! 🎉\n")
 
 
+@pytest.mark.parametrize("file", test_files)
+def test_cache(runner, file):
+    args = [
+        "-e",
+        "tests/test_files/error_files/",
+        "-e",
+        "tests/test_files/test_encoding.rst",
+        "-l",
+        80,
+        file,
+    ]
+    result = runner.invoke(main, args=args)
+    assert result.exit_code == 0
+    assert result.output.endswith("were reformatted.\nDone! 🎉\n")
+
+    result = runner.invoke(main, args=args)
+    assert result.exit_code == 0
+    assert result.output.endswith("was checked.\nDone! 🎉\n")
+
+
 def test_comment_preserve_single_line(runner):
     file = "..  A comment in a single line is not placed on the next one.\n"
     fixed = ".. A comment in a single line is not placed on the next one.\n"