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

stanislaw · web-flow · commit 6c21f3a9de3b · 2025-07-27T13:53:52.000+02:00
Code climate: mypy: fix several remaining union-attr issues
diff --git a/strictdoc/backend/sdoc/models/anchor.py b/strictdoc/backend/sdoc/models/anchor.py
@@ -55,11 +55,6 @@ def get_document(self) -> SDocDocumentIF:
     def get_parent_or_including_document(self) -> SDocDocumentIF:
         return self.parent_node().get_parent_or_including_document()
 
-    # FIXME: Remove this. Use get_parent_or_including_document() instead.
-    @property
-    def parent_or_including_document(self) -> SDocDocumentIF:
-        return self.get_parent_or_including_document()
-
     def get_including_document(self) -> Optional[SDocDocumentIF]:
         return self.parent_node().get_including_document()
 
diff --git a/strictdoc/backend/sdoc/models/node.py b/strictdoc/backend/sdoc/models/node.py
@@ -366,11 +366,6 @@ def get_debug_info(self) -> str:
             debug_components.append(f"document = {document.get_debug_info()}")
         return f"Requirement({', '.join(debug_components)})"
 
-    # FIXME: Remove this method. Use get_parent_or_including_document() instead.
-    @property
-    def parent_or_including_document(self) -> SDocDocumentIF:
-        return self.get_parent_or_including_document()
-
     def document_is_included(self) -> bool:
         assert self.ng_including_document_reference is not None
         return self.ng_including_document_reference.get_document() is not None
diff --git a/strictdoc/backend/sdoc/models/section.py b/strictdoc/backend/sdoc/models/section.py
@@ -105,8 +105,7 @@ def get_including_document(self) -> Optional[SDocDocumentIF]:
         assert self.ng_including_document_reference is not None
         return self.ng_including_document_reference.get_document()
 
-    @property
-    def parent_or_including_document(self) -> SDocDocumentIF:
+    def get_parent_or_including_document(self) -> SDocDocumentIF:
         assert self.ng_including_document_reference is not None
         including_document_or_none = (
             self.ng_including_document_reference.get_document()
diff --git a/strictdoc/export/html/form_objects/rows/row_with_grammar_element_form_object.py b/strictdoc/export/html/form_objects/rows/row_with_grammar_element_form_object.py
@@ -1,4 +1,3 @@
-# mypy: disable-error-code="union-attr"
 from dataclasses import dataclass
 from typing import Any, Dict, List
 
diff --git a/strictdoc/export/html/generators/view_objects/document_screen_view_object.py b/strictdoc/export/html/generators/view_objects/document_screen_view_object.py
@@ -1,4 +1,3 @@
-# mypy: disable-error-code="union-attr"
 from dataclasses import dataclass
 from datetime import datetime
 from typing import Any, Iterator, List, Optional, Sequence, Tuple, Union
@@ -305,6 +304,7 @@ def get_document_by_path(self, full_path: str) -> SDocDocument:
         )
 
     def get_grammar_elements(self) -> List[GrammarElement]:
+        assert self.document.grammar is not None
         return self.document.grammar.elements
 
     def table_of_contents(
diff --git a/strictdoc/export/html/generators/view_objects/search_screen_view_object.py b/strictdoc/export/html/generators/view_objects/search_screen_view_object.py
@@ -1,4 +1,3 @@
-# mypy: disable-error-code="union-attr"
 from dataclasses import dataclass
 from typing import Iterator, List, Optional, Union
 
diff --git a/strictdoc/export/html/generators/view_objects/source_file_view_object.py b/strictdoc/export/html/generators/view_objects/source_file_view_object.py
@@ -1,4 +1,3 @@
-# mypy: disable-error-code="union-attr"
 from dataclasses import dataclass
 from typing import Any, List, Optional, Union
 
diff --git a/strictdoc/export/html/renderers/link_renderer.py b/strictdoc/export/html/renderers/link_renderer.py
@@ -1,4 +1,3 @@
-# mypy: disable-error-code="union-attr"
 import html
 from typing import Any, Dict, Optional, Tuple, Union
 
@@ -104,11 +103,12 @@ def render_node_link(
         ), node
 
         if isinstance(node, SDocDocument):
-            context_level_or_none = (
-                context_document.meta.level
-                if context_document is not None
-                else None
-            )
+            context_level_or_none: Optional[int] = None
+            if context_document is not None:
+                assert context_document.meta is not None
+                context_level_or_none = context_document.meta.level
+
+            assert node.meta is not None
             document_link = node.meta.get_html_link(
                 document_type,
                 context_level_or_none,
@@ -133,21 +133,26 @@ def render_node_link(
             return f"#{local_link}"
 
         # Now two cases:
-        # - Context document exists and we want to take into account this
+        # - Context document exists, and we want to take into account this
         # document's depth.
         # - Context document does not exist, such as when we are on a Search
         # screen. In this case, the level is simply zero.
-        level: int = (
-            context_document.meta.level if context_document is not None else 0
-        )  # FIXME 0 or 1?
+        level: int = 0
+        if context_document is not None:
+            assert context_document.meta is not None
+            level = context_document.meta.level
+
         link_cache_key = (document_type, 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:
                 return document_type_cache[node]
         else:
             self.req_link_cache[link_cache_key] = {}
-        document_link = node.parent_or_including_document.meta.get_html_link(
+
+        parent_or_including_document = node.get_parent_or_including_document()
+        assert parent_or_including_document.meta is not None
+        document_link = parent_or_including_document.meta.get_html_link(
             document_type,
             level,
         )
@@ -167,10 +172,13 @@ def render_node_doxygen_link(
         """
 
         assert isinstance(node, (SDocNode, SDocSection, Anchor)), node
+
+        parent_or_including_document = node.get_parent_or_including_document()
+        assert parent_or_including_document is not None
+        assert parent_or_including_document.meta is not None
+
         local_link = self.render_local_anchor(node)
-        document_link = (
-            node.parent_or_including_document.meta.get_html_doc_link()
-        )
+        document_link = parent_or_including_document.meta.get_html_doc_link()
         requirement_link = f"{document_link}#{local_link}"
         return requirement_link
 
@@ -189,6 +197,7 @@ def render_requirement_link_from_source_file(
             self.req_link_cache[link_cache_key] = {}
 
         document = assert_cast(node.get_document(), SDocDocument)
+        assert document.meta is not None
         document_link = document.meta.get_html_link(
             DocumentType.DOCUMENT, source_file.level + 1
         )
@@ -206,6 +215,7 @@ def render_source_file_link(
         document: SDocDocument = assert_cast(
             requirement.ng_document_reference.get_document(), SDocDocument
         )
+        assert document.meta is not None
         path_prefix = document.meta.get_root_path_prefix()
         source_file_link = (
             f"{path_prefix}/_source_files/{requirement_source_path}.html"
diff --git a/strictdoc/export/html/templates/rst/anchor.jinja b/strictdoc/export/html/templates/rst/anchor.jinja
@@ -13,7 +13,7 @@
       Incoming link{% if incoming_links|length > 1 -%}s{%- endif %} from:
       {%- for incoming_link in incoming_links -%}
       {%- set incoming_link_parent_node = incoming_link.parent_node() -%}
-      {%- set incoming_link_href = link_renderer.render_node_link(incoming_link.parent_node(), anchor.parent_or_including_document, document_type) -%}
+      {%- set incoming_link_href = link_renderer.render_node_link(incoming_link.parent_node(), anchor.get_parent_or_including_document(), document_type) -%}
       <a href="{{ incoming_link_href }}">
         {{ incoming_link_parent_node.get_display_title() }}
       </a>
diff --git a/strictdoc/export/html/templates/screens/document/_shared/toc.jinja b/strictdoc/export/html/templates/screens/document/_shared/toc.jinja
@@ -36,7 +36,7 @@
                 {{ section.context.title_number_string if section.context.title_number_string else "&nbsp;"|safe * (section.ng_level * 2 - 1) }}
               </span>{{- section.title -}}
               {# TODO #fragment #}
-              {# {{ section.document_is_included() }} {{ section.parent_or_including_document.reserved_title }}/{{ section.get_document().reserved_title }} #}
+              {# {{ section.document_is_included() }} {{ section.get_parent_or_including_document().reserved_title }}/{{ section.get_document().reserved_title }} #}
             </a>
           {%- endif -%}
         {%- else -%}
@@ -52,7 +52,7 @@
           {%- if section.reserved_title is not none -%}
             {{- section.reserved_title -}}
             {# TODO #fragment #}
-            {# {{ section.document_is_included() }} {{ section.parent_or_including_document.reserved_title }}/{{ section.get_document().reserved_title }} #}
+            {# {{ section.document_is_included() }} {{ section.get_parent_or_including_document().reserved_title }}/{{ section.get_document().reserved_title }} #}
           {%- endif -%}
         </a>
         {%- endif -%}
diff --git a/strictdoc/export/html2pdf/html2pdf_generator.py b/strictdoc/export/html2pdf/html2pdf_generator.py
@@ -2,7 +2,6 @@
 @relation(SDOC-SRS-51, scope=file)
 """
 
-# mypy: disable-error-code="union-attr"
 import os
 from pathlib import Path
 from typing import List, Tuple
@@ -49,6 +48,8 @@ def export_tree(
         paths_to_print: List[Tuple[str, str]] = []
 
         for document_ in traceability_index.document_tree.document_list:
+            assert document_.meta is not None
+
             # Skip generating the included documents, unless the option is provided.
             if not project_config.export_included_documents:
                 if document_.document_is_included():
diff --git a/strictdoc/export/rst/document_rst_generator.py b/strictdoc/export/rst/document_rst_generator.py
@@ -1,10 +1,11 @@
-# mypy: disable-error-code="union-attr"
 import os
 from pathlib import Path
 
 from strictdoc.backend.sdoc.models.document import SDocDocument
+from strictdoc.core.document_meta import DocumentMeta
 from strictdoc.core.traceability_index import TraceabilityIndex
 from strictdoc.export.rst.writer import RSTWriter
+from strictdoc.helpers.cast import assert_cast
 
 
 class DocumentRSTGenerator:
@@ -19,14 +20,14 @@ def export_tree(
             document_content = DocumentRSTGenerator.export(
                 document, traceability_index
             )
-
+            document_meta = assert_cast(document.meta, DocumentMeta)
             output_folder = os.path.join(
                 output_rst_root,
-                document.meta.input_doc_dir_rel_path.relative_path,
+                document_meta.input_doc_dir_rel_path.relative_path,
             )
             Path(output_folder).mkdir(parents=True, exist_ok=True)
 
-            document_out_file = f"{document.meta.document_filename_base}.rst"
+            document_out_file = f"{document_meta.document_filename_base}.rst"
             output_path = os.path.join(output_folder, document_out_file)
 
             with open(output_path, "w", encoding="utf8") as file:
diff --git a/strictdoc/export/rst/rst_to_html_fragment_writer.py b/strictdoc/export/rst/rst_to_html_fragment_writer.py
@@ -1,4 +1,3 @@
-# mypy: disable-error-code="union-attr"
 import hashlib
 import io
 import os
@@ -47,6 +46,7 @@ def __init__(
         )
 
         if context_document is not None:
+            assert context_document.meta is not None
             WildcardEnhancedImage.current_reference_path = (
                 context_document.meta.output_document_dir_full_path
             )
diff --git a/strictdoc/export/spdx/spdx_generator.py b/strictdoc/export/spdx/spdx_generator.py
@@ -1,5 +1,4 @@
 # pragma: no cover file.
-# mypy: disable-error-code="union-attr"
 
 """
 Experimental code to generate SPDX.
@@ -141,6 +140,8 @@ def create_package(project_config: ProjectConfig) -> Package:
     def create_document_to_file(
         document: SDocDocument, document_bytes: bytes
     ) -> File:
+        assert document.meta is not None
+
         return File(
             spdx_id=f"SPDXRef-File-{get_spdx_ref(document)}",
             name=document.meta.document_filename,
@@ -181,6 +182,8 @@ def convert_requirement_to_snippet(
             document_bytes[requirement.ng_byte_start : requirement.ng_byte_end]
         )
         assert requirement.reserved_uid is not None
+        assert requirement.reserved_statement is not None
+
         return Snippet(
             spdx_id=requirement.reserved_uid,
             primary_purpose=SoftwarePurpose.DOCUMENTATION,
@@ -250,6 +253,7 @@ def export_tree(
         lookup_file_name_to_spdx_file: Dict[str, File] = {}
 
         for document_ in traceability_index.document_tree.document_list:
+            assert document_.meta is not None
             with open(document_.meta.input_doc_full_path, "rb") as input_file_:
                 document_bytes = input_file_.read()
 
@@ -282,7 +286,10 @@ def export_tree(
             )
 
             for node, _ in document_iterator.all_content():
-                if node.is_requirement():
+                if (
+                    isinstance(node, SDocNode)
+                    and node.node_type == "REQUIREMENT"
+                ):
                     if node.reserved_uid is None:
                         continue
 
@@ -293,7 +300,6 @@ def export_tree(
                     #
                     # Create SPDX Snippet from SDoc Requirement.
                     #
-                    assert isinstance(node, SDocNode)
                     spdx_snippet: Snippet = (
                         sdoc_spdx_converter.convert_requirement_to_snippet(
                             node, document_bytes, spdx_file
@@ -375,6 +381,9 @@ def export_tree(
                 document_
             )
             for node, _ in document_iterator.all_content():
+                if not isinstance(node, SDocNode):
+                    continue
+
                 if node.is_requirement():
                     if node.reserved_uid is None:
                         continue
diff --git a/strictdoc/export/spdx/spdx_to_sdoc_converter.py b/strictdoc/export/spdx/spdx_to_sdoc_converter.py
@@ -5,7 +5,6 @@
 highly experimental and most of this code will be removed.
 """
 
-# mypy: disable-error-code="union-attr"
 from typing import List, Union
 
 from spdx_tools.spdx3.model import RelationshipType, SpdxDocument

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# mypy: disable-error-code="union-attr"`
`2`	`1`	`from dataclasses import dataclass`
`3`	`2`	`from typing import Any, Dict, List`
`4`	`3`