fix some of linter warnings (#238)

Author: AlexanderLanin

src/extensions/score_layout/__init__.py

@@ -47,9 +47,9 @@ def update_config(app: Sphinx, _config: Any):
             # Docs-as-code is the current module
             module = "_main"
         app.config.html_static_path.append(str(Path(r) / module / "src/assets"))
-        app.config.needs_flow_configs = {
-            "score_config": f"!include {Path(r) / module / 'src/assets/puml-theme-score.puml'}"
-        }
+
+        puml = Path(r) / module / "src/assets/puml-theme-score.puml"
+        app.config.needs_flow_configs = {"score_config": f"!include {puml}"}
 
     app.add_css_file("css/score.css", priority=500)
     app.add_css_file("css/score_needs.css", priority=500)

src/extensions/score_metamodel/tests/test_check_options.py

@@ -15,15 +15,14 @@
 from unittest.mock import Mock
 
 import pytest
+from attribute_plugin import add_test_properties
 from score_metamodel.checks.check_options import (
     check_extra_options,
     check_options,
 )
 from score_metamodel.tests import fake_check_logger, need
 from sphinx.application import Sphinx
 
-from attribute_plugin import add_test_properties
-
 
 class NeedTypeDict(TypedDict, total=False):
     directive: str

src/extensions/score_metamodel/tests/test_metamodel__init__.py

@@ -11,15 +11,14 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 import pytest
+from attribute_plugin import add_test_properties
 
 from src.extensions.score_metamodel.__init__ import (
     graph_checks,
     local_checks,
     parse_checks_filter,
 )
 
-from attribute_plugin import add_test_properties
-
 
 def dummy_local_check(app, need, log):
     pass

src/extensions/score_source_code_linker/__init__.py

@@ -357,12 +357,14 @@ def inject_links_into_needs(app: Sphinx, env: BuildEnvironment) -> None:
             # TODO: print github annotations as in https://github.com/eclipse-score/bazel_registry/blob/7423b9996a45dd0a9ec868e06a970330ee71cf4f/tools/verify_semver_compatibility_level.py#L126-L129
             for n in source_code_links.links.CodeLinks:
                 LOGGER.warning(
-                    f"{n.file}:{n.line}: Could not find {source_code_links.need} in documentation [CODE LINK]",
+                    f"{n.file}:{n.line}: Could not find {source_code_links.need} "
+                    "in documentation [CODE LINK]",
                     type="score_source_code_linker",
                 )
             for n in source_code_links.links.TestLinks:
                 LOGGER.warning(
-                    f"{n.file}:{n.line}: Could not find {source_code_links.need} in documentation [TEST LINK]",
+                    f"{n.file}:{n.line}: Could not find {source_code_links.need} "
+                    "in documentation [TEST LINK]",
                     type="score_source_code_linker",
                 )
             continue

src/extensions/score_source_code_linker/need_source_links.py

@@ -11,9 +11,9 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 """
-This file defines NeedSourceLinks as well as SourceCodeLinks.
-Both datatypes are used in the 'grouped cache' JSON that contains 'CodeLinks' and 'TestLinks'
-It also defines a decoder and encoder for SourceCodeLinks to enable JSON read/write
+This file defines NeedSourceLinks as well as SourceCodeLinks. Both datatypes are used in
+the 'grouped cache' JSON that contains 'CodeLinks' and 'TestLinks' It also defines a
+decoder and encoder for SourceCodeLinks to enable JSON read/write
 """
 
 # req-Id: tool_req__docs_test_link_testcase
@@ -56,9 +56,9 @@ class SourceCodeLinks:
 
 class SourceCodeLinks_JSON_Encoder(json.JSONEncoder):
     def default(self, o: object):
-        if isinstance(o, (SourceCodeLinks, NeedSourceLinks)):
+        if isinstance(o, SourceCodeLinks | NeedSourceLinks):
             return asdict(o)
-        if isinstance(o, (NeedLink, DataForTestLink)):
+        if isinstance(o, NeedLink | DataForTestLink):
             return asdict(o)
         if isinstance(o, Path):
             return str(o)
@@ -81,7 +81,8 @@ def SourceCodeLinks_JSON_Decoder(d: dict[str, Any]) -> SourceCodeLinks | dict[st
 def store_source_code_links_combined_json(
     file: Path, source_code_links: list[SourceCodeLinks]
 ):
-    # After `rm -rf _build` or on clean builds the directory does not exist, so we need to create it
+    # After `rm -rf _build` or on clean builds the directory does not exist, so we need
+    # to create it
     file.parent.mkdir(exist_ok=True)
     with open(file, "w") as f:
         json.dump(
@@ -99,9 +100,11 @@ def load_source_code_links_combined_json(file: Path) -> list[SourceCodeLinks]:
         object_hook=SourceCodeLinks_JSON_Decoder,
     )
     assert isinstance(links, list), (
-        "The combined source code linker links should be a list of SourceCodeLinks objects."
+        "The combined source code linker links should be "
+        "a list of SourceCodeLinks objects."
     )
     assert all(isinstance(link, SourceCodeLinks) for link in links), (
-        "All items in combined_source_code_linker_cache should be SourceCodeLinks objects."
+        "All items in combined_source_code_linker_cache should be "
+        "SourceCodeLinks objects."
     )
     return links

src/extensions/score_source_code_linker/testlink.py

@@ -194,10 +194,11 @@ def DataOfTestCase_JSON_Decoder(d: dict[str, Any]) -> DataOfTestCase | dict[str,
 
 def store_test_xml_parsed_json(file: Path, testlist: list[DataForTestLink]):
     """
-    TestCases that are 'skipped' do not have properties, therefore they will NOT be saved/transformed
-    to TestLinks.
+    TestCases that are 'skipped' do not have properties, therefore they will NOT be
+    saved/transformed to TestLinks.
     """
-    # After `rm -rf _build` or on clean builds the directory does not exist, so we need to create it
+    # After `rm -rf _build` or on clean builds the directory does not exist, so we need
+    # to create it
     file.parent.mkdir(exist_ok=True)
     with open(file, "w") as f:
         json.dump(
@@ -224,7 +225,8 @@ def load_test_xml_parsed_json(file: Path) -> list[DataForTestLink]:
 
 
 def store_data_of_test_case_json(file: Path, testneeds: list[DataOfTestCase]):
-    # After `rm -rf _build` or on clean builds the directory does not exist, so we need to create it
+    # After `rm -rf _build` or on clean builds the directory does not exist, so we need
+    # to create it
     file.parent.mkdir(exist_ok=True)
     with open(file, "w") as f:
         json.dump(

src/extensions/score_source_code_linker/tests/test_codelink.py

@@ -19,10 +19,10 @@
 from typing import Any
 
 import pytest
+from attribute_plugin import add_test_properties
 from sphinx_needs.data import NeedsMutable
 
 from src.extensions.score_metamodel.tests import need as test_need
-from attribute_plugin import add_test_properties
 
 # Import the module under test
 # Note: You'll need to adjust these imports based on your actual module structure
@@ -38,8 +38,6 @@
 )
 from src.helper_lib import (
     get_current_git_hash,
-    get_github_repo_info,
-    parse_remote_git_output,
 )
 from src.helper_lib.additional_functions import get_github_link
 

src/extensions/score_source_code_linker/tests/test_source_code_link_integration.py

@@ -10,6 +10,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
+import contextlib
 import json
 import os
 import shutil
@@ -46,7 +47,7 @@ def sphinx_base_dir(tmp_path_factory: TempPathFactory) -> Path:
 
 
 @pytest.fixture()
-def git_repo_setup(sphinx_base_dir) -> Path:
+def git_repo_setup(sphinx_base_dir: Path) -> Path:
     """Creating git repo, to make testing possible"""
 
     repo_path = sphinx_base_dir
@@ -68,7 +69,7 @@ def git_repo_setup(sphinx_base_dir) -> Path:
 
 
 @pytest.fixture()
-def create_demo_files(sphinx_base_dir, git_repo_setup):
+def create_demo_files(sphinx_base_dir: Path, git_repo_setup):
     repo_path = sphinx_base_dir
 
     # Create some source files with requirement IDs
@@ -141,7 +142,7 @@ def make_codelink_source_2():
     return (
         """
 # Another implementation file
-# Though we should make sure this 
+# Though we should make sure this
 # is at a different line than the other ID
 #"""
         + """ req-Id: TREQ_ID_1
@@ -214,7 +215,7 @@ def construct_gh_url() -> str:
 
 @pytest.fixture()
 def sphinx_app_setup(
-    sphinx_base_dir, create_demo_files, git_repo_setup
+    sphinx_base_dir: Path, create_demo_files, git_repo_setup
 ) -> Callable[[], SphinxTestApp]:
     def _create_app():
         base_dir = sphinx_base_dir
@@ -223,11 +224,9 @@ def _create_app():
         # CRITICAL: Change to a directory that exists and is accessible
         # This fixes the "no such file or directory" error in Bazel
         original_cwd = None
-        try:
+        # Current working directory doesn't exist, which is the problem
+        with contextlib.suppress(FileNotFoundError):
             original_cwd = os.getcwd()
-        except FileNotFoundError:
-            # Current working directory doesn't exist, which is the problem
-            pass
 
         # Change to the base_dir before creating SphinxTestApp
         os.chdir(base_dir)
@@ -243,11 +242,9 @@ def _create_app():
         finally:
             # Try to restore original directory, but don't fail if it doesn't exist
             if original_cwd is not None:
-                try:
+                # Original directory might not exist anymore in Bazel sandbox
+                with contextlib.suppress(FileNotFoundError, OSError):
                     os.chdir(original_cwd)
-                except (FileNotFoundError, OSError):
-                    # Original directory might not exist anymore in Bazel sandbox
-                    pass
 
     return _create_app
 
@@ -302,8 +299,7 @@ def basic_needs():
 
 
 @pytest.fixture()
-def example_source_link_text_all_ok(sphinx_base_dir):
-    repo_path = sphinx_base_dir
+def example_source_link_text_all_ok(sphinx_base_dir: Path):
     return {
         "TREQ_ID_1": [
             NeedLink(
@@ -334,8 +330,7 @@ def example_source_link_text_all_ok(sphinx_base_dir):
 
 
 @pytest.fixture()
-def example_test_link_text_all_ok(sphinx_base_dir):
-    repo_path = sphinx_base_dir
+def example_test_link_text_all_ok(sphinx_base_dir: Path):
     return {
         "TREQ_ID_1": [
             DataForTestLink(
@@ -392,8 +387,7 @@ def example_test_link_text_all_ok(sphinx_base_dir):
 
 
 @pytest.fixture()
-def example_source_link_text_non_existent(sphinx_base_dir):
-    repo_path = sphinx_base_dir
+def example_source_link_text_non_existent(sphinx_base_dir: Path):
     return [
         {
             "TREQ_ID_200": [
@@ -409,11 +403,11 @@ def example_source_link_text_non_existent(sphinx_base_dir):
     ]
 
 
-def make_source_link(needlinks):
+def make_source_link(needlinks: list[NeedLink]):
     return ", ".join(f"{get_github_link(n)}<>{n.file}:{n.line}" for n in needlinks)
 
 
-def make_test_link(testlinks):
+def make_test_link(testlinks: list[DataForTestLink]):
     return ", ".join(f"{get_github_link(n)}<>{n.name}" for n in testlinks)
 
 
@@ -424,12 +418,14 @@ def compare_json_files(file1: Path, expected_file: Path, object_hook):
     with open(expected_file) as f2:
         json2 = json.load(f2, object_hook=object_hook)
     assert len(json1) == len(json2), (
-        f"{file1}'s lenth are not the same as in the golden file lenght. Len of{file1}: {len(json1)}. Len of Golden File: {len(json2)}"
+        f"{file1}'s lenth are not the same as in the golden file lenght. "
+        f"Len of{file1}: {len(json1)}. Len of Golden File: {len(json2)}"
     )
     c1 = Counter(n for n in json1)
     c2 = Counter(n for n in json2)
     assert c1 == c2, (
-        f"Testfile does not have same needs as golden file. Testfile: {c1}\nGoldenFile: {c2}"
+        f"Testfile does not have same needs as golden file. "
+        f"Testfile: {c1}\nGoldenFile: {c2}"
     )
 
 
@@ -441,7 +437,8 @@ def compare_grouped_json_files(file1: Path, golden_file: Path):
         json2 = json.load(f2, object_hook=SourceCodeLinks_TEST_JSON_Decoder)
 
     assert len(json1) == len(json2), (
-        f"Input & Expected have different Lenghts. Input: {file1}: {len(json1)}, Expected: {golden_file}: {len(json2)}"
+        "Input & Expected have different Lenghts. "
+        f"Input: {file1}: {len(json1)}, Expected: {golden_file}: {len(json2)}"
     )
 
     json1_sorted = sorted(json1, key=lambda x: x.need)
@@ -468,11 +465,14 @@ def compare_grouped_json_files(file1: Path, golden_file: Path):
         )
 
 
+@pytest.mark.skip(
+    "Flaky test, see https://github.com/eclipse-score/docs-as-code/issues/226"
+)
 def test_source_link_integration_ok(
     sphinx_app_setup: Callable[[], SphinxTestApp],
-    example_source_link_text_all_ok: dict[str, list[str]],
-    example_test_link_text_all_ok: dict[str, list[str]],
-    sphinx_base_dir,
+    example_source_link_text_all_ok: dict[str, list[NeedLink]],
+    example_test_link_text_all_ok: dict[str, list[DataForTestLink]],
+    sphinx_base_dir: Path,
     git_repo_setup,
     create_demo_files,
 ):
@@ -536,7 +536,7 @@ def test_source_link_integration_ok(
 def test_source_link_integration_non_existent_id(
     sphinx_app_setup: Callable[[], SphinxTestApp],
     example_source_link_text_non_existent: dict[str, list[str]],
-    sphinx_base_dir,
+    sphinx_base_dir: Path,
     git_repo_setup,
     create_demo_files,
 ):

src/extensions/score_source_code_linker/tests/test_testlink.py

@@ -13,6 +13,8 @@
 import json
 from pathlib import Path
 
+from attribute_plugin import add_test_properties
+
 from src.extensions.score_source_code_linker.testlink import (
     DataForTestLink,
     DataForTestLink_JSON_Decoder,
@@ -21,7 +23,6 @@
     load_test_xml_parsed_json,
     store_test_xml_parsed_json,
 )
-from attribute_plugin import add_test_properties
 
 
 @add_test_properties(
@@ -72,8 +73,8 @@ def test_decoder_ignores_irrelevant_dicts():
 )
 def test_clean_text_removes_ansi_and_html_unescapes():
     """
-    Test if text clean works as intended.
-    It should remove ANSI color & text styles, as well as convert HTML things back to Chars
+    Test if text clean works as intended. It should remove ANSI color & text styles, as
+    well as convert HTML things back to Chars
     """
     raw = "\x1b[31m<b>Warning</b>\x1b[0m\nExtra line"
     cleaned = DataOfTestCase.clean_text(raw)
@@ -119,7 +120,7 @@ def test_testcaseneed_to_dict_multiple_links():
     test_type="requirements-based",
     derivation_technique="requirements-analysis",
 )
-def test_store_and_load_testlinks_roundtrip(tmp_path):
+def test_store_and_load_testlinks_roundtrip(tmp_path: Path):
     """Ensure that Encode/Decode is reversible"""
     file = tmp_path / "testlinks.json"