Merge pull request #2410 from strictdoc-project/stanislaw/markers

Code climate: mypy: fix several remaining union-attr issues

Author: stanislaw

strictdoc/backend/excel/export/excel_generator.py

@@ -13,7 +13,9 @@
 
 from strictdoc.backend.sdoc.models.document import SDocDocument
 from strictdoc.backend.sdoc.models.grammar_element import ReferenceType
-from strictdoc.backend.sdoc.models.model import SDocElementIF
+from strictdoc.backend.sdoc.models.model import (
+    SDocIteratedElementIF,
+)
 from strictdoc.backend.sdoc.models.node import SDocNode
 from strictdoc.backend.sdoc.models.reference import (
     FileReference,
@@ -236,7 +238,9 @@ def _export_single_document(
             os.unlink(document_out_file)
 
     @staticmethod
-    def _lookup_refs(document_contents: List[SDocElementIF]) -> Dict[str, int]:
+    def _lookup_refs(
+        document_contents: List[SDocIteratedElementIF],
+    ) -> Dict[str, int]:
         refs: Dict[str, int] = {}
         row = 1
 

strictdoc/backend/sdoc/error_handling.py

@@ -1,4 +1,3 @@
-# mypy: disable-error-code="union-attr"
 from typing import Optional, Union
 
 from textx import TextXSyntaxError
@@ -334,7 +333,7 @@ def invalid_marker_role(
     ) -> "StrictDocSemanticError":
         role_and_type = marker.role if marker.role is not None else "Any"
         return StrictDocSemanticError(
-            title=(f"File marker role is not registered: {role_and_type}."),
+            title=f"File marker role is not registered: {role_and_type}.",
             hint=f"Problematic requirement: {node.reserved_uid}.",
             example=None,
             line=marker.ng_source_line_begin,
@@ -368,6 +367,7 @@ def view_references_nonexisting_grammar_element(
         view_element: ViewElement,
         object_type: str,
     ) -> "StrictDocSemanticError":
+        assert document.meta is not None
         return StrictDocSemanticError(
             title=(
                 f"View element '{view_element.view_id}' references a non-existing"
@@ -391,6 +391,7 @@ def view_references_nonexisting_field(
         object_type: str,
         field_name: str,
     ) -> "StrictDocSemanticError":
+        assert document.meta is not None
         return StrictDocSemanticError(
             title=(
                 f"View element '{view_element.view_id}' references a non-existing"
@@ -412,6 +413,8 @@ def default_view_doesnt_exist(
         document_config: DocumentConfig,
         default_view: str,
     ) -> "StrictDocSemanticError":
+        assert document.meta is not None
+
         filename = document.meta.input_doc_full_path
 
         return StrictDocSemanticError(

strictdoc/backend/sdoc/models/document_grammar.py

@@ -1,4 +1,3 @@
-# mypy: disable-error-code="union-attr"
 from typing import Dict, List, Optional, Set
 
 from strictdoc.backend.sdoc.models.grammar_element import (

strictdoc/backend/sdoc/models/model.py

@@ -51,6 +51,7 @@ class SDocNodeFieldIF(ABC):
 
 class SDocNodeIF(ABC):
     reserved_mid: MID
+    mid_permanent: bool
     node_type: str
     section_contents: List["SDocElementIF"]
     ng_level: Optional[int]
@@ -96,6 +97,8 @@ def get_prefix(self) -> Optional[str]:
 
 
 class SDocSectionIF(ABC):
+    reserved_mid: MID
+    mid_permanent: bool
     parent: Union["SDocDocumentIF", "SDocSectionIF"]
     section_contents: List["SDocElementIF"]
     ng_level: Optional[int]
@@ -124,6 +127,8 @@ class SDocGrammarIF:
 
 
 class SDocDocumentIF(ABC):
+    reserved_mid: MID
+    mid_permanent: bool
     section_contents: List["SDocElementIF"]
     included_documents: List["SDocDocumentIF"]
     config: DocumentConfig
@@ -181,6 +186,13 @@ def section_contents(self) -> List[SDocDocumentIF]:
 ]
 
 
+SDocIteratedElementIF = Union[
+    SDocNodeIF,
+    SDocSectionIF,
+    SDocDocumentIF,
+]
+
+
 SDocExtendedElementIF = Union[
     SDocElementIF,
     SourceFileTraceabilityInfo,

strictdoc/backend/sdoc_source_code/models/range_marker.py

@@ -93,6 +93,9 @@ def __init__(
 
         # Line number of the marker in the source code.
         self.ng_source_line_begin: Optional[int] = None
+        # The column number is never used but keeping for compatibility with
+        # the other markers when used for error reporting.
+        self.ng_source_column_begin: Optional[int] = None
 
         self.ng_range_line_begin: Optional[int] = None
         self.ng_range_line_end: Optional[int] = None

strictdoc/core/document_iterator.py

@@ -7,6 +7,7 @@
     SDocDocumentFromFileIF,
     SDocDocumentIF,
     SDocElementIF,
+    SDocIteratedElementIF,
     SDocNodeIF,
     SDocSectionIF,
 )
@@ -71,7 +72,7 @@ def table_of_contents(
     def all_content(
         self,
         print_fragments: bool = False,
-    ) -> Iterator[Tuple[SDocElementIF, DocumentIterationContext]]:
+    ) -> Iterator[Tuple[SDocIteratedElementIF, DocumentIterationContext]]:
         root_node = self.document
 
         yield from self.all_node_content(
@@ -87,7 +88,7 @@ def all_node_content(
         print_fragments: bool = False,
         level_stack: Tuple[int, ...] = (),
         custom_level: bool = False,
-    ) -> Iterator[Tuple[SDocElementIF, DocumentIterationContext]]:
+    ) -> Iterator[Tuple[SDocIteratedElementIF, DocumentIterationContext]]:
         if isinstance(node, SDocSection):
             # If node is not whitelisted, we ignore it. Also, note that due to
             # this early return, all child nodes of this node are ignored

strictdoc/export/html/html_generator.py

@@ -1,4 +1,3 @@
-# mypy: disable-error-code="arg-type,union-attr"
 import importlib
 import os
 import sys
@@ -50,6 +49,7 @@
 from strictdoc.export.html.renderers.link_renderer import LinkRenderer
 from strictdoc.export.html.renderers.markup_renderer import MarkupRenderer
 from strictdoc.export.html.tools.html_embedded import HTMLEmbedder
+from strictdoc.helpers.cast import assert_cast
 from strictdoc.helpers.exception import StrictDocException
 from strictdoc.helpers.file_modification_time import get_file_modification_time
 from strictdoc.helpers.file_system import sync_dir
@@ -268,9 +268,12 @@ def export_assets(
 
         redundant_assets: Dict[str, List[SDocRelativePath]] = {}
         for document_ in traceability_index.document_tree.document_list:
+            assert document_.meta is not None
             for (
                 included_document_
             ) in document_.iterate_included_documents_depth_first():
+                assert included_document_.meta is not None
+
                 redundant_assets.setdefault(
                     document_.meta.input_doc_assets_dir_rel_path.relative_path_posix,
                     [],
@@ -279,6 +282,8 @@ def export_assets(
                     document_.meta.input_doc_assets_dir_rel_path.relative_path_posix
                 ].append(included_document_.meta.input_doc_assets_dir_rel_path)
 
+        assert traceability_index.asset_manager is not None
+
         asset_dir_: AssetDir
         for asset_dir_ in traceability_index.asset_manager.iterate():
             source_path = asset_dir_.full_path
@@ -322,14 +327,16 @@ def export_single_document_with_performance(
         if specific_documents is None:
             specific_documents = DocumentType.all()
 
-        input_doc_full_path = document.meta.input_doc_full_path
-        output_doc_full_path = document.meta.output_document_full_path
+        document_meta = assert_cast(document.meta, DocumentMeta)
+
+        input_doc_full_path = document_meta.input_doc_full_path
+        output_doc_full_path = document_meta.output_document_full_path
 
         if os.path.isfile(output_doc_full_path) and (
             get_file_modification_time(input_doc_full_path)
             < get_file_modification_time(output_doc_full_path)
             and not traceability_index.file_dependency_manager.must_generate(
-                document.meta.input_doc_full_path
+                document_meta.input_doc_full_path
             )
         ):
             with measure_performance(f"Skip: {document.title}"):

strictdoc/git/project_diff_analyzer.py

@@ -1,4 +1,3 @@
-# mypy: disable-error-code="union-attr"
 import hashlib
 import statistics
 from dataclasses import dataclass, field
@@ -356,6 +355,7 @@ def _iterate_one_index(
                         document.reserved_mid
                     ]
                 else:
+                    assert document.meta is not None
                     other_document_or_none = (
                         other_stats.map_rel_paths_to_docs.get(
                             document.meta.input_doc_rel_path.relative_path
@@ -952,6 +952,8 @@ def analyze_document(
         document: SDocDocument,
         document_tree_stats: ProjectTreeDiffStats,
     ) -> None:
+        assert document.meta is not None
+
         document_iterator = DocumentCachingIterator(document)
 
         map_nodes_to_hashers: Dict[Any, Any] = {document: hashlib.md5()}