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

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

Author: stanislaw

.link_health.yml

@@ -15,6 +15,7 @@ exceptions:
   - url: https://github.com/mull-project/FileCheck.py/blob/main/pyproject.toml
   - url: https://github.com/strictdoc-project/strictdoc/blob/main/docs/strictdoc_01_user_guide.sdoc
   - url: https://github.com/strictdoc-project/strictdoc/blob/5c94aab96da4ca21944774f44b2c88509be9636e/tasks.py
+  - url: https://github.com/strictdoc-project/strictdoc/blob/6f57747e6a1b5b3cb29c0047f9df5959da64ebb1/docs/sdoc_project_statistics.py
   - url: https://github.com/strictdoc-project/strictdoc/blob/main/strictdoc/backend/sdoc/grammar/grammar.py
   - url: https://github.com/textX/textX/blob/master/LICENSE.txt
   - url: https://github.com/sphinx-doc/sphinx/blob/master/LICENSE.rst

strictdoc/backend/sdoc/models/document_config.py

@@ -30,10 +30,10 @@ def __init__(
         self,
         *,
         parent: Optional["DocumentConfig"] = None,
-        entries: Optional[List[DocumentCustomMetadataKeyValuePair]],
+        entries: List[DocumentCustomMetadataKeyValuePair],
     ) -> None:
         _ = parent
-        self.entries = entries
+        self.entries: List[DocumentCustomMetadataKeyValuePair] = entries
 
 
 @auto_described

strictdoc/backend/sdoc/models/model.py

@@ -52,9 +52,10 @@ class SDocNodeFieldIF(ABC):
 class SDocNodeIF(ABC):
     reserved_mid: MID
     node_type: str
+    section_contents: List["SDocElementIF"]
     ng_level: Optional[int]
     ng_resolved_custom_level: Optional[str]
-    section_contents: List["SDocElementIF"]
+    ng_whitelisted: bool
 
     # FIXME: Get rid of @property everywhere.
     @property
@@ -96,9 +97,10 @@ def get_prefix(self) -> Optional[str]:
 
 class SDocSectionIF(ABC):
     parent: Union["SDocDocumentIF", "SDocSectionIF"]
+    section_contents: List["SDocElementIF"]
     ng_level: Optional[int]
     ng_resolved_custom_level: Optional[str]
-    section_contents: List["SDocElementIF"]
+    ng_whitelisted: bool
 
     @abstractmethod
     def get_document(self) -> Optional["SDocDocumentIF"]:
@@ -122,13 +124,14 @@ class SDocGrammarIF:
 
 
 class SDocDocumentIF(ABC):
+    section_contents: List["SDocElementIF"]
+    included_documents: List["SDocDocumentIF"]
     config: DocumentConfig
     grammar: Optional[SDocGrammarIF]
     meta: Optional[DocumentMeta]
-    section_contents: List["SDocElementIF"]
-    included_documents: List["SDocDocumentIF"]
     is_bundle_document: bool
     ng_level: Optional[int]
+    ng_whitelisted: bool
 
     @abstractmethod
     def get_prefix(self) -> str:
@@ -156,6 +159,7 @@ def ng_resolved_custom_level(self) -> Optional[str]:
 class SDocDocumentFromFileIF(ABC):
     parent: Union[SDocDocumentIF, SDocSectionIF]
     ng_resolved_custom_level: Optional[str]
+    ng_whitelisted: bool
 
     @abstractmethod
     def iterate_nodes(

strictdoc/backend/sdoc/models/section.py

@@ -2,7 +2,6 @@
 @relation(SDOC-SRS-99, scope=file)
 """
 
-# mypy: disable-error-code="union-attr"
 from typing import List, Optional, Union
 
 from strictdoc.backend.sdoc.document_reference import DocumentReference
@@ -99,19 +98,23 @@ def get_display_title(self, include_toc_number: bool = True) -> str:
         return self.title
 
     def get_document(self) -> Optional[SDocDocumentIF]:
+        assert self.ng_document_reference is not None
         return self.ng_document_reference.get_document()
 
     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:
+        assert self.ng_including_document_reference is not None
         including_document_or_none = (
             self.ng_including_document_reference.get_document()
         )
         if including_document_or_none is not None:
             return including_document_or_none
 
+        assert self.ng_document_reference is not None
         document: Optional[SDocDocumentIF] = (
             self.ng_document_reference.get_document()
         )
@@ -121,6 +124,7 @@ def parent_or_including_document(self) -> SDocDocumentIF:
         return 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
 
     def is_requirement(self) -> bool:
@@ -130,8 +134,9 @@ def is_section(self) -> bool:
         return True
 
     def has_any_text_nodes(self) -> bool:
+        # FIXME: Remove using __class__.
         return any(
-            node_.__class__.__name__ == "SDocNode" and node_.node_type == "TEXT"
+            node_.__class__.__name__ == "SDocNode" and node_.node_type == "TEXT"  # type: ignore[union-attr]
             for node_ in self.section_contents
         )
 

strictdoc/backend/sdoc/writer.py

@@ -1,4 +1,3 @@
-# mypy: disable-error-code="union-attr"
 import os.path
 from pathlib import Path
 from typing import Dict, List, Tuple
@@ -438,6 +437,8 @@ def _print_section(
     def _print_requirement_fields(
         self, section_content: SDocNode, document: SDocDocument
     ) -> str:
+        assert document.grammar is not None
+
         output = ""
 
         current_view: ViewElement = document.view.get_current_view(

strictdoc/helpers/form_data.py

@@ -1,6 +1,5 @@
-# mypy: disable-error-code="union-attr"
 import re
-from typing import Dict, List, Tuple, Union
+from typing import Dict, List, Match, Optional, Tuple, Union
 
 from typing_extensions import TypeAlias
 
@@ -98,7 +97,10 @@ def parse_form_data(
     result_dict: ParsedFormData = {}
 
     for key, value in form_data:
-        first_match = re.match(rf"({FIELD_NAME})", key)
+        first_match: Optional[Match[str]] = re.match(rf"({FIELD_NAME})", key)
+
+        assert first_match is not None, "first_match must not be None."
+
         match_groups = first_match.groups()
         assert len(match_groups) == 1