code-climate: address remaining var-annotated

Author: thseiler

strictdoc/backend/excel/export/excel_generator.py

@@ -1,4 +1,4 @@
-# mypy: disable-error-code="arg-type,no-untyped-def,type-arg,union-attr,var-annotated"
+# mypy: disable-error-code="arg-type,no-untyped-def,type-arg,union-attr"
 import os
 from pathlib import Path
 from typing import Dict, List
@@ -239,7 +239,7 @@ def _lookup_refs(document_contents: List) -> Dict[str, int]:
 
     @staticmethod
     def _init_columns_width(fields: List[str]):
-        columns = {}
+        columns: Dict[str, Dict[str, int]] = {}
 
         for field in fields:
             columns[field] = {}

strictdoc/backend/sdoc_source_code/models/source_file_info.py

@@ -1,5 +1,7 @@
-# mypy: disable-error-code="no-untyped-def,type-arg,var-annotated"
-from typing import Dict, List, Optional, Union
+# mypy: disable-error-code="no-untyped-def,type-arg"
+from typing import Dict, List, Optional, Sequence, Union
+
+from typing_extensions import TypeAlias
 
 from strictdoc.backend.sdoc_source_code.models.function import Function
 from strictdoc.backend.sdoc_source_code.models.function_range_marker import (
@@ -14,6 +16,10 @@
 from strictdoc.helpers.auto_described import auto_described
 from strictdoc.helpers.file_stats import SourceFileStats
 
+RelationMarkerType: TypeAlias = Union[
+    FunctionRangeMarker, LineMarker, RangeMarker, ForwardRangeMarker
+]
+
 
 @auto_described
 class SourceFileTraceabilityInfo:
@@ -34,9 +40,13 @@ def __init__(self, g_parts: List):
         #  "REQ-001": [RangeMarker(...), ...],           # noqa: ERA001
         #  "REQ-002": [RangeMarker(...), ...],           # noqa: ERA001
         # }                                              # noqa: ERA001
-        self.ng_map_reqs_to_markers = {}
+        self.ng_map_reqs_to_markers: Dict[
+            str, Sequence[RelationMarkerType]
+        ] = {}
 
-        self.ng_map_names_to_markers: Dict[str, List] = {}
+        self.ng_map_names_to_markers: Dict[
+            str, Sequence[RelationMarkerType]
+        ] = {}
         self.ng_map_names_to_definition_functions: Dict[str, Function] = {}
 
         #
@@ -53,11 +63,7 @@ def __init__(self, g_parts: List):
         self._coverage: float = 0
         self.covered_functions: int = 0
 
-        self.markers: List[
-            Union[
-                FunctionRangeMarker, LineMarker, RangeMarker, ForwardRangeMarker
-            ]
-        ] = []
+        self.markers: List[RelationMarkerType] = []
 
     def get_coverage(self):
         return self._coverage

strictdoc/backend/sdoc_source_code/reader.py

@@ -1,4 +1,4 @@
-# mypy: disable-error-code="no-redef,no-untyped-call,no-untyped-def,type-arg,var-annotated"
+# mypy: disable-error-code="no-redef,no-untyped-call,no-untyped-def,type-arg"
 import sys
 import traceback
 from functools import partial

strictdoc/backend/sdoc_source_code/reader_c.py

@@ -1,4 +1,4 @@
-# mypy: disable-error-code="no-redef,no-untyped-call,no-untyped-def,type-arg,var-annotated"
+# mypy: disable-error-code="no-redef,no-untyped-call,no-untyped-def,type-arg"
 import sys
 import traceback
 from typing import List, Optional, Sequence, Union

strictdoc/backend/sdoc_source_code/reader_python.py

@@ -1,4 +1,4 @@
-# mypy: disable-error-code="no-redef,no-untyped-call,no-untyped-def,type-arg,var-annotated"
+# mypy: disable-error-code="no-redef,no-untyped-call,no-untyped-def,type-arg"
 import sys
 import traceback
 from itertools import islice

strictdoc/core/file_tree.py

@@ -1,4 +1,4 @@
-# mypy: disable-error-code="no-any-return,no-untyped-call,no-untyped-def,var-annotated"
+# mypy: disable-error-code="no-any-return,no-untyped-call,no-untyped-def"
 import collections
 import functools
 import os
@@ -35,7 +35,7 @@ def __init__(self, level, full_path, rel_path: SDocRelativePath):
         self.rel_path: SDocRelativePath = rel_path
         self.file_name = os.path.basename(self.full_path)
         self.files = [self]
-        self.subfolder_trees = []
+        self.subfolder_trees: List[Folder] = []
 
     def __repr__(self):
         return f"File: {self.full_path}"

strictdoc/core/project_config.py

@@ -1,4 +1,4 @@
-# mypy: disable-error-code="arg-type,attr-defined,no-any-return,no-untyped-call,no-untyped-def,var-annotated,type-arg"
+# mypy: disable-error-code="arg-type,attr-defined,no-any-return,no-untyped-call,no-untyped-def,type-arg"
 import datetime
 import os
 import re
@@ -210,7 +210,7 @@ def default_config(environment: SDocRuntimeEnvironment):
             source_root_path=None,
             include_source_paths=[],
             exclude_source_paths=[],
-            test_report_root_dict=[],
+            test_report_root_dict={},
             html2pdf_template=None,
             bundle_document_version=ProjectConfig.DEFAULT_BUNDLE_DOCUMENT_VERSION,
             bundle_document_date=ProjectConfig.DEFAULT_BUNDLE_DOCUMENT_COMMIT_DATE,
@@ -424,12 +424,12 @@ def _load_from_dictionary(
         project_features = ProjectConfig.DEFAULT_FEATURES
         server_host = ProjectConfig.DEFAULT_SERVER_HOST
         server_port = ProjectConfig.DEFAULT_SERVER_PORT
-        include_doc_paths = []
-        exclude_doc_paths = []
+        include_doc_paths: List[str] = []
+        exclude_doc_paths: List[str] = []
         source_root_path = None
-        include_source_paths = []
-        exclude_source_paths = []
-        test_report_root_dict = {}
+        include_source_paths: List[str] = []
+        exclude_source_paths: List[str] = []
+        test_report_root_dict: Dict[str, str] = {}
         html2pdf_template: Optional[str] = None
         bundle_document_version = ProjectConfig.DEFAULT_BUNDLE_DOCUMENT_VERSION
         bundle_document_date = ProjectConfig.DEFAULT_BUNDLE_DOCUMENT_COMMIT_DATE

strictdoc/core/source_tree.py

@@ -1,4 +1,4 @@
-# mypy: disable-error-code="no-untyped-def,var-annotated"
+# mypy: disable-error-code="no-untyped-def"
 import os
 from enum import Enum
 from typing import Dict, List, Sequence
@@ -21,7 +21,7 @@ class SourceFileType(Enum):
     RST = [".rst"]
     SDOC = [".sdoc"]
 
-    UNKNOWN = []
+    UNKNOWN: List[str] = []
 
     @classmethod
     def create_from_path(cls, path_to_file: str) -> "SourceFileType":
@@ -54,7 +54,7 @@ def create_from_path(cls, path_to_file: str) -> "SourceFileType":
 
     @staticmethod
     def all() -> List[str]:  # noqa: A003
-        all_extensions = []
+        all_extensions: List[str] = []
         for enum_value in SourceFileType:
             all_extensions += enum_value.value
         return all_extensions

strictdoc/core/tree_cycle_detector.py

@@ -1,7 +1,9 @@
-# mypy: disable-error-code="no-untyped-call,no-untyped-def,var-annotated"
+# mypy: disable-error-code="no-untyped-call,no-untyped-def"
 from collections import deque
+from typing import Deque, Tuple
 
 from strictdoc.backend.sdoc.errors.document_tree_error import DocumentTreeError
+from strictdoc.backend.sdoc.models.model import SDocNodeIF
 
 BEFORE = 1
 AFTER = 2
@@ -11,10 +13,10 @@ class TreeCycleDetector:
     def __init__(self):
         self.checked = set()
 
-    def check_node(self, node, links_function):
+    def check_node(self, node: SDocNodeIF, links_function):
         if node in self.checked:
             return
-        stack = deque()
+        stack: Deque[Tuple[SDocNodeIF, int]] = deque()
         stack.append((node, BEFORE))
         visited = set()
         while stack:
@@ -46,7 +48,7 @@ class SingleShotTreeCycleDetector:
     def check_node(self, new_uid, node, links_function):
         checked = set()
 
-        stack = deque()
+        stack: Deque[Tuple[SDocNodeIF, int]] = deque()
         stack.append((node, BEFORE))
         visited = {new_uid}
         while stack:

strictdoc/export/html/renderers/link_renderer.py

@@ -1,6 +1,6 @@
-# mypy: disable-error-code="arg-type,no-untyped-call,no-untyped-def,union-attr,var-annotated"
+# mypy: disable-error-code="arg-type,no-untyped-call,no-untyped-def,union-attr"
 import html
-from typing import Optional, Union
+from typing import Dict, Optional, Tuple, Union
 
 from strictdoc.backend.sdoc.models.anchor import Anchor
 from strictdoc.backend.sdoc.models.document import SDocDocument
@@ -24,8 +24,11 @@ def __init__(self, *, root_path, static_path: str):
             if len(root_path) > 0
             else f"{static_path}"
         )
-        self.local_anchor_cache = {}
-        self.req_link_cache = {}
+        self.local_anchor_cache: Dict[str, str] = {}
+        self.req_link_cache: Dict[
+            Tuple[DocumentType, int],
+            Dict[Union[SDocDocument, SDocNode, SDocSection, Anchor], str],
+        ] = {}
 
     def render_url(self, url: str) -> str:
         url = html.escape(url)
@@ -165,7 +168,7 @@ def render_requirement_link_from_source_file(self, node, source_file):
         assert isinstance(node, SDocNode)
         assert isinstance(source_file, SourceFile)
         local_link = self.render_local_anchor(node)
-        link_cache_key = ("document", source_file.level)
+        link_cache_key = (DocumentType.document(), source_file.level)
         if link_cache_key in self.req_link_cache:
             document_type_cache = self.req_link_cache[link_cache_key]
             if node in document_type_cache:

strictdoc/export/json/json_generator.py

@@ -1,4 +1,4 @@
-# mypy: disable-error-code="arg-type,attr-defined,no-any-return,no-untyped-def,type-arg,var-annotated,union-attr,operator"
+# mypy: disable-error-code="arg-type,attr-defined,no-any-return,no-untyped-def,type-arg,union-attr,operator"
 import json
 import os.path
 from enum import Enum
@@ -219,7 +219,7 @@ def get_level_string_(node_) -> str:
             return subnode_dict
 
         elif isinstance(node, SDocDocument):
-            node_dict = {JSONKey.NODES: []}
+            node_dict: Dict[str, List[Dict]] = {JSONKey.NODES: []}
 
             current_number = 0
             for subnode_ in node.section_contents:

strictdoc/export/spdx/spdx_to_sdoc_converter.py

@@ -1,5 +1,5 @@
-# mypy: disable-error-code="arg-type,no-untyped-call,no-untyped-def,var-annotated,union-attr"
-from typing import Union
+# mypy: disable-error-code="arg-type,no-untyped-call,no-untyped-def,union-attr"
+from typing import List, Union
 
 from spdx_tools.spdx3.model import RelationshipType, SpdxDocument
 from spdx_tools.spdx3.model.software import File, Package, Snippet
@@ -12,6 +12,7 @@
 )
 from strictdoc.backend.sdoc.models.node import (
     SDocNode,
+    SDocNodeField,
 )
 from strictdoc.backend.sdoc.models.reference import (
     ChildReqReference,
@@ -243,7 +244,7 @@ def _convert_file(
         sdoc_document: SDocDocument,
         sdoc_parent: Union[SDocSection, SDocDocument],
     ) -> SDocNode:
-        fields = []
+        fields: List[SDocNodeField] = []
         requirement = SDocNode(
             parent=sdoc_parent,
             node_type="SPDX_FILE",
@@ -295,7 +296,7 @@ def _convert_snippet(
         sdoc_parent: Union[SDocSection, SDocDocument],
         spdx_container: SPDXSDocContainer,
     ) -> SDocNode:
-        fields = []
+        fields: List[SDocNodeField] = []
         requirement = SDocNode(
             parent=sdoc_parent,
             node_type="SPDX_SNIPPET",

strictdoc/helpers/form_data.py

@@ -1,6 +1,12 @@
-# mypy: disable-error-code="no-untyped-call,no-untyped-def,type-arg,union-attr,var-annotated"
+# mypy: disable-error-code="no-untyped-call,no-untyped-def,type-arg,union-attr"
 import re
-from typing import List, Tuple, Union
+from typing import Dict, List, Tuple, Union
+
+from typing_extensions import TypeAlias
+
+FormDataDictType: TypeAlias = Union[
+    Dict[str, "FormDataDictType"], List["FormDataDictType"]
+]
 
 
 def _set_value_by_key_path(obj, parts, value):
@@ -51,8 +57,8 @@ def _set_value_by_key_path(obj, parts, value):
 FIELD_NAME = "[A-Za-z0-9_]*"
 
 
-def parse_form_data(form_data: List[Tuple]):
-    result_dict = {}
+def parse_form_data(form_data: List[Tuple]) -> Dict[str, FormDataDictType]:
+    result_dict: Dict[str, FormDataDictType] = {}
 
     for key, value in form_data:
         first_match = re.match(rf"({FIELD_NAME})", key)

tests/integration/self_testing/commands/export/01_strictdoc_smoke_test/test.itest

@@ -103,7 +103,7 @@ RUN: %check_exists --file "%S/Output/html/_source_files/strictdoc/core/traceabil
 
 RUN: %cat %S/Output/html/strictdoc/docs/strictdoc_21_L2_StrictDoc_Requirements.html | filecheck %s --check-prefix CHECK-3-REQUIREMENTS
 CHECK-3-REQUIREMENTS: href="../../_source_files/strictdoc/core/traceability_index_builder.py.html#SDOC-SRS-30#{{.*}}#{{.*}}"
-CHECK-3-REQUIREMENTS: href="../../_source_files/strictdoc/core/tree_cycle_detector.py.html#SDOC-SRS-30#1#73"
+CHECK-3-REQUIREMENTS: href="../../_source_files/strictdoc/core/tree_cycle_detector.py.html#SDOC-SRS-30#1#75"
 
 RUN: %cat "%S/Output/html/_source_files/strictdoc/core/tree_cycle_detector.py.html" | filecheck %s --check-prefix CHECK-TREE-CYCLE-DETECTOR
 CHECK-TREE-CYCLE-DETECTOR: href="../../../strictdoc/docs/strictdoc_21_L2_StrictDoc_Requirements.html#SDOC-SRS-30"