Merge pull request #2246 from thseiler/code-climate/is-requirement

code-climate: remove @Property from is_requirement() & co

Author: stanislaw

strictdoc/backend/excel/export/excel_generator.py

@@ -90,7 +90,7 @@ def _export_single_document(
                 ).all_content(
                     print_fragments=False, print_fragments_from_files=False
                 ):
-                    if not node.is_requirement or not node.reserved_uid:
+                    if not node.is_requirement() or not node.reserved_uid:
                         # only export the requirements with uid
                         continue
 

strictdoc/backend/reqif/p01_sdoc/sdoc_to_reqif_converter.py

@@ -249,13 +249,13 @@ def convert_document_tree(
             for node_ in document_iterator.all_content(
                 print_fragments=False, print_fragments_from_files=False
             ):
-                if node_.is_composite_requirement:
+                if node_.is_composite_requirement():
                     raise NotImplementedError(
                         "Exporting composite requirements is not "
                         "supported yet.",
                         node_,
                     )
-                if node_.is_section:
+                if node_.is_section():
                     section: SDocSection = assert_cast(node_, SDocSection)
                     # fmt: off
                     spec_object = (
@@ -294,7 +294,7 @@ def convert_document_tree(
                         parents[hierarchy] = current_hierarchy_parent
                     current_hierarchy = hierarchy
 
-                elif node_.is_requirement:
+                elif node_.is_requirement():
                     requirement = assert_cast(node_, SDocNode)
                     spec_object = cls._convert_requirement_to_spec_object(
                         requirement=requirement,

strictdoc/backend/sdoc/models/document.py

@@ -81,19 +81,16 @@ def __init__(
     def uid(self) -> Optional[str]:
         return self.config.uid
 
-    @property
     def is_section(self) -> bool:
         return True
 
     @property
     def is_root_included_document(self) -> bool:
         return self.document_is_included()
 
-    @property
     def is_requirement(self) -> bool:
         return False
 
-    @property
     def is_composite_requirement(self) -> bool:
         return False
 

strictdoc/backend/sdoc/models/node.py

@@ -301,9 +301,6 @@ def rationale(self) -> Optional[str]:
             RequirementFieldName.RATIONALE, singleline_only=False
         )
 
-    # Other properties
-    # FIXME: Remove @property.
-    @property
     def is_requirement(self) -> bool:
         return True
 
@@ -313,26 +310,15 @@ def is_normative_node(self) -> bool:
     def is_text_node(self) -> bool:
         return self.node_type == "TEXT"
 
-    # FIXME: Remove @property.
-    @property
     def is_section(self) -> bool:
         return False
 
-    # FIXME: Remove @property.
-    @property
     def is_document(self) -> bool:
         return False
 
-    # FIXME: Remove @property.
-    @property
     def is_composite_requirement(self) -> bool:
         return False
 
-    # FIXME: Remove this, use get_document().
-    @property
-    def document(self) -> Optional[SDocDocumentIF]:
-        return self.get_document()
-
     def get_document(self) -> Optional[SDocDocumentIF]:
         assert self.ng_document_reference is not None, self
         return self.ng_document_reference.get_document()
@@ -695,7 +681,6 @@ def __init__(
     ) -> None:
         super().__init__(parent, **fields)
 
-    @property
     def is_composite_requirement(self) -> bool:
         return True
 

strictdoc/backend/sdoc/models/object_factory.py

@@ -134,7 +134,9 @@ def create_requirement(
         if isinstance(parent, SDocDocument):
             requirement.ng_document_reference.set_document(parent)
         else:
-            requirement.ng_document_reference.set_document(parent.document)
+            requirement.ng_document_reference.set_document(
+                parent.get_document()
+            )
         return requirement
 
     @staticmethod

strictdoc/backend/sdoc/models/section.py

@@ -12,6 +12,7 @@
     SDocSectionIF,
 )
 from strictdoc.helpers.auto_described import auto_described
+from strictdoc.helpers.cast import assert_cast
 from strictdoc.helpers.mid import MID
 
 
@@ -76,10 +77,9 @@ def get_node_type_string(self) -> Optional[str]:
 
     def get_debug_info(self) -> str:
         debug_components: List[str] = [f"TITLE = '{self.title}'"]
-        if self.document is not None:
-            debug_components.append(
-                f"document = {self.document.get_debug_info()}"
-            )
+        document: Optional[SDocDocumentIF] = self.get_document()
+        if document is not None:
+            debug_components.append(f"document = {document.get_debug_info()}")
         return f"Section({', '.join(debug_components)})"
 
     @property
@@ -91,11 +91,6 @@ def get_display_title(self, include_toc_number: bool = True) -> str:
             return f"{self.context.title_number_string}. {self.title}"
         return self.title
 
-    # FIXME: Remove this method, use get_document() instead.
-    @property
-    def document(self) -> Optional[SDocDocumentIF]:
-        return self.ng_document_reference.get_document()
-
     def get_document(self) -> Optional[SDocDocumentIF]:
         return self.ng_document_reference.get_document()
 
@@ -121,15 +116,12 @@ def parent_or_including_document(self) -> SDocDocumentIF:
     def document_is_included(self):
         return self.ng_including_document_reference.get_document() is not None
 
-    @property
     def is_requirement(self):
         return False
 
-    @property
     def is_composite_requirement(self):
         return False
 
-    @property
     def is_section(self):
         return True
 
@@ -141,7 +133,10 @@ def has_any_text_nodes(self):
 
     @property
     def is_root(self) -> bool:
-        return self.document.config.root is True
+        document: SDocDocumentIF = assert_cast(
+            self.get_document(), SDocDocumentIF
+        )
+        return document.config.root is True
 
     def get_requirement_prefix(self) -> str:
         if self.requirement_prefix is not None:

strictdoc/core/file_traceability_index.py

@@ -612,8 +612,10 @@ def marker_comparator(marker):
 
                 # validate here, SDocNode.relations doesn't track marker roles
                 node = traceability_index.get_node_by_uid(req_uid_)
-                assert node.document and node.document.grammar
-                grammar_element = node.document.grammar.elements_by_type[
+                document = node.get_document()
+                assert document is not None
+                assert document.grammar is not None
+                grammar_element = document.grammar.elements_by_type[
                     node.node_type
                 ]
                 for marker in markers_:

strictdoc/core/query_engine/query_object.py

@@ -200,7 +200,7 @@ def _evaluate_node_field_expression(
         self, node, expression: NodeFieldExpression
     ) -> Optional[str]:
         field_name = expression.field_name
-        if node.is_requirement and node.node_type == "REQUIREMENT":
+        if node.is_requirement() and node.node_type == "REQUIREMENT":
             requirement: SDocNode = assert_cast(node, SDocNode)
             requirement_document: SDocDocument = assert_cast(
                 requirement.get_document(), SDocDocument
@@ -217,7 +217,7 @@ def _evaluate_node_field_expression(
             if field_value is not None:
                 return field_value
             return None
-        elif node.is_section:
+        elif node.is_section():
             section: SDocSection = assert_cast(node, SDocSection)
             if field_name == "UID":
                 return section.reserved_uid

strictdoc/core/traceability_index_builder.py

@@ -452,7 +452,7 @@ def create_from_document_tree(
                         rhs_node=node,
                     )
 
-                if node.is_requirement:
+                if node.is_requirement():
                     requirement: SDocNode = assert_cast(node, SDocNode)
                     if requirement.reserved_tags is not None:
                         for tag in requirement.reserved_tags:
@@ -486,7 +486,7 @@ def create_from_document_tree(
                 print_fragments=False,
                 print_fragments_from_files=False,
             ):
-                if not node.is_requirement:
+                if not node.is_requirement():
                     continue
 
                 requirement: SDocNode = node
@@ -628,7 +628,7 @@ def create_from_document_tree(
                 print_fragments=False,
                 print_fragments_from_files=False,
             ):
-                if not node.is_requirement:
+                if not node.is_requirement():
                     continue
                 requirement: Union[SDocNode, SDocCompositeNode] = assert_cast(
                     node, (SDocNode, SDocCompositeNode)
@@ -803,7 +803,7 @@ def _filter_nodes(
                                     node.parent.blacklist_if_needed()
 
                         elif (
-                            node.is_requirement
+                            node.is_requirement()
                             and not requirements_query_object.evaluate(node)
                         ):
                             node.ng_whitelisted = False
@@ -816,7 +816,7 @@ def _filter_nodes(
                                 ]
                                 == node
                             ):
-                                if node.parent.is_section:
+                                if node.parent.is_section():
                                     node.parent.blacklist_if_needed()
 
             except (AttributeError, NameError, TypeError) as attribute_error_:

strictdoc/core/transforms/update_grammar_element.py

@@ -84,7 +84,7 @@ def perform(self) -> bool:
         document_iterator = self.traceability_index.document_iterators[document]
 
         for node in document_iterator.all_content():
-            if not node.is_requirement:
+            if not node.is_requirement():
                 continue
 
             requirement: SDocNode = assert_cast(node, SDocNode)