Fix pre-commit warnings

Author: a-zw

src/extensions/score_any_folder/__init__.py

@@ -35,13 +35,15 @@
 Misconfigured pairs (absolute paths, non-symlink path at the target location)
 are logged as errors and skipped.
 """
+
 from pathlib import Path
 
 from sphinx.application import Sphinx
 from sphinx.util.logging import getLogger
 
 logger = getLogger(__name__)
 
+_APP_ATTRIBUTE = "_score_any_folder_created_links"
 
 def setup(app: Sphinx) -> dict[str, str | bool]:
     app.add_config_value("score_any_folder_mapping", default={}, rebuild="env")
@@ -102,13 +104,13 @@ def _create_symlinks(app: Sphinx) -> None:
         created_links.add(link)
         logger.debug("score_any_folder: created symlink %s -> %s", link, source)
 
-    setattr(app, "_score_any_folder_created_links", created_links)
+    setattr(app, _APP_ATTRIBUTE, created_links)
 
 
 def _cleanup_symlinks(app: Sphinx, exception: Exception | None) -> None:
     del exception
 
-    created_links = getattr(app, "_score_any_folder_created_links", set())
+    created_links: set[Path] = getattr(app, _APP_ATTRIBUTE, set())
     for link in created_links:
         if not link.is_symlink():
             continue

src/extensions/score_any_folder/tests/test_score_any_folder.py

@@ -54,7 +54,7 @@ def make_sphinx_app(
 
     def _factory(mapping: dict[str, str]) -> SphinxTestApp:
         (docs_dir / "conf.py").write_text(
-            f'extensions = ["score_any_folder"]\n'
+            'extensions = ["score_any_folder"]\n'
             f"score_any_folder_mapping = {mapping!r}\n"
         )
         (docs_dir / "index.rst").write_text("Root\n====\n")
@@ -69,7 +69,9 @@ def _factory(mapping: dict[str, str]) -> SphinxTestApp:
 
 
 def test_symlink_exposes_files_at_target_path(
-    make_sphinx_app: Callable, docs_dir: Path, tmp_path: Path
+    make_sphinx_app: Callable[[dict[str, str]], SphinxTestApp],
+    docs_dir: Path,
+    tmp_path: Path,
 ) -> None:
     """Files in the source directory are readable via the symlinked target path."""
     src_docs = tmp_path / "src" / "module_docs"
@@ -83,7 +85,9 @@ def test_symlink_exposes_files_at_target_path(
 
 
 def test_symlink_is_idempotent(
-    make_sphinx_app: Callable, docs_dir: Path, tmp_path: Path
+    make_sphinx_app: Callable[[dict[str, str]], SphinxTestApp],
+    docs_dir: Path,
+    tmp_path: Path,
 ) -> None:
     """Build cleanup removes temporary links and a second build still succeeds."""
     src_docs = tmp_path / "external"
@@ -99,7 +103,9 @@ def test_symlink_is_idempotent(
 
 
 def test_stale_symlink_is_replaced(
-    make_sphinx_app: Callable, docs_dir: Path, tmp_path: Path
+    make_sphinx_app: Callable[[dict[str, str]], SphinxTestApp],
+    docs_dir: Path,
+    tmp_path: Path,
 ) -> None:
     """A symlink pointing to a stale target is replaced with the correct one."""
     correct_src = tmp_path / "correct"
@@ -114,21 +120,23 @@ def test_stale_symlink_is_replaced(
 
 
 def test_existing_non_symlink_logs_error_and_skips(
-    make_sphinx_app: Callable, docs_dir: Path, tmp_path: Path
+    make_sphinx_app: Callable[[dict[str, str]], SphinxTestApp],
+    docs_dir: Path,
+    tmp_path: Path,
 ) -> None:
     """A real directory at the target path is left untouched and an error is logged."""
     (tmp_path / "external").mkdir()
     real_dir = docs_dir / "module"
     real_dir.mkdir()
 
-    app = make_sphinx_app({"../external": "module"})
+    app: SphinxTestApp = make_sphinx_app({"../external": "module"})
 
     assert real_dir.is_dir() and not real_dir.is_symlink()
     assert "not a symlink" in app.warning.getvalue()
 
 
 def test_empty_mapping_is_a_no_op(
-    make_sphinx_app: Callable, docs_dir: Path
+    make_sphinx_app: Callable[[dict[str, str]], SphinxTestApp], docs_dir: Path
 ) -> None:
     """An empty mapping produces no symlinks and no errors."""
     make_sphinx_app({}).build()
@@ -137,7 +145,9 @@ def test_empty_mapping_is_a_no_op(
 
 
 def test_multiple_mappings(
-    make_sphinx_app: Callable, docs_dir: Path, tmp_path: Path
+    make_sphinx_app: Callable[[dict[str, str]], SphinxTestApp],
+    docs_dir: Path,
+    tmp_path: Path,
 ) -> None:
     """Multiple mapping entries each produce their own symlink."""
     for name in ("alpha", "beta"):
@@ -152,7 +162,9 @@ def test_multiple_mappings(
 
 
 def test_target_in_subfolder(
-    make_sphinx_app: Callable, docs_dir: Path, tmp_path: Path
+    make_sphinx_app: Callable[[dict[str, str]], SphinxTestApp],
+    docs_dir: Path,
+    tmp_path: Path,
 ) -> None:
     """A target path with intermediate directories creates the parent dirs."""
     src_docs = tmp_path / "external"

src/extensions/score_source_code_linker/xml_parser.py

@@ -234,7 +234,7 @@ def build_test_needs_from_files(
     tcns: list[DataOfTestCase] = []
     for file in xml_paths:
         # Last value can be ignored. The 'is_valid' function already prints infos
-        test_cases, tests_missing_all_props,_ = read_test_xml_file(file)
+        test_cases, tests_missing_all_props, _ = read_test_xml_file(file)
         non_prop_tests = ", ".join(n for n in tests_missing_all_props)
         if non_prop_tests:
             logger.info(f"Tests missing all properties: {non_prop_tests}")

src/helper_lib/test_helper_lib.py

@@ -29,7 +29,7 @@
 class _FakeConfig:
     """Minimal stand-in for sphinx.config.Config."""
 
-    def __init__(self, raw: dict):
+    def __init__(self, raw: dict[str, object]):
         self._raw_config = raw