Merge pull request #2269 from strictdoc-project/stanislaw/code-climate/address-type-arg-simple

code-climate: mypy: address type-arg: SourceFileTraceabilityInfo/Parts

Author: stanislaw

strictdoc/backend/sdoc_source_code/models/function_range_marker.py

@@ -1,4 +1,4 @@
-# mypy: disable-error-code="no-untyped-def,type-arg"
+# mypy: disable-error-code="no-untyped-def"
 from copy import copy
 from enum import Enum
 from typing import List, Optional

strictdoc/backend/sdoc_source_code/models/range_marker.py

@@ -1,4 +1,3 @@
-# mypy: disable-error-code="no-untyped-def,type-arg"
 from typing import Any, List, Optional
 
 from strictdoc.backend.sdoc_source_code.models.requirement_marker import Req
@@ -14,7 +13,7 @@ def __init__(
         reqs_objs: List[Req],
         scope: str = "",
         role: Optional[str] = None,
-    ):
+    ) -> None:
         assert isinstance(reqs_objs, list)
         self.parent: Any = parent
         assert len(begin_or_end) > 0 or scope is not None
@@ -115,12 +114,15 @@ def get_description(self) -> Optional[str]:
 @auto_described
 class ForwardRangeMarker:
     def __init__(
-        self, start_or_end: bool, reqs_objs: List, role: Optional[str] = None
-    ):
+        self,
+        start_or_end: bool,
+        reqs_objs: List[Req],
+        role: Optional[str] = None,
+    ) -> None:
         assert len(reqs_objs) > 0
         self.start_or_end: bool = start_or_end
 
-        self.reqs_objs: List[str] = reqs_objs
+        self.reqs_objs: List[Req] = reqs_objs
         self.reqs: List[str] = list(map(lambda req: req.uid, reqs_objs))
 
         self.role: Optional[str] = (
@@ -156,7 +158,9 @@ def is_forward(self) -> bool:
 
 @auto_described
 class ForwardFileMarker(ForwardRangeMarker):
-    def __init__(self, reqs_objs: List, role: Optional[str] = None):
+    def __init__(
+        self, reqs_objs: List[Req], role: Optional[str] = None
+    ) -> None:
         super().__init__(True, reqs_objs, role)
 
     def get_description(self) -> Optional[str]:

strictdoc/backend/sdoc_source_code/models/source_file_info.py

@@ -1,5 +1,5 @@
-# mypy: disable-error-code="no-untyped-def,type-arg"
-from typing import Dict, List, Optional, Sequence, Union
+# mypy: disable-error-code="no-untyped-def"
+from typing import Any, Dict, List, Optional, Sequence, Union
 
 from typing_extensions import TypeAlias
 
@@ -23,15 +23,20 @@
 
 @auto_described
 class SourceFileTraceabilityInfo:
-    def __init__(self, g_parts: List):
+    def __init__(self, g_parts: List[Any]):  # noqa: ARG002
         """
         At the init time, only the backward RangeMarkers are available from
         a source file. At runtime, the ForwardRangeMarkers are mixed in
         from the Requirement/FileReference links. This is why the .markers
         is a union.
+
+        Note that g_parts is only used by the textX grammar to allow the
+        definition of the child grammar elements. All other instance variables
+        of this class are not using or based on g_parts. Instead, they are
+        populated during the textX processing step, e.g., via
+        general_language_marker_processors.py.
         """
 
-        self.g_parts: List = g_parts
         self.source_file: Optional[SourceFile] = None
         self.functions: List[Function] = []
 

strictdoc/backend/sdoc_source_code/reader.py

@@ -1,8 +1,8 @@
-# mypy: disable-error-code="no-untyped-call,no-untyped-def,type-arg"
+# mypy: disable-error-code="no-untyped-call,no-untyped-def"
 import sys
 import traceback
 from functools import partial
-from typing import List, Optional
+from typing import List, Optional, TypedDict
 
 from textx import get_location, metamodel_from_str
 
@@ -24,6 +24,12 @@
 from strictdoc.helpers.textx import drop_textx_meta
 
 
+class TextXLocation(TypedDict):
+    line: int
+    col: int
+    filename: str
+
+
 def req_processor(req: Req):
     assert isinstance(req, Req), (
         f"Expected req to be Req, got: {req}, {type(req)}"
@@ -95,7 +101,7 @@ def create_end_without_begin_error(location):
 def create_unmatch_range_error(unmatched_ranges: List[RangeMarker]):
     assert isinstance(unmatched_ranges, list)
     assert len(unmatched_ranges) > 0
-    range_locations: List = []
+    range_locations: List[TextXLocation] = []
     for unmatched_range in unmatched_ranges:
         location = get_location(unmatched_range)
         range_locations.append(location)