strictdoc 0.0.54a1__tar.gz → 0.0.55__tar.gz

{strictdoc-0.0.54a1 → strictdoc-0.0.55}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.54a1
+Version: 0.0.55
 Summary: StrictDoc is open-source software for technical documentation and requirements management.
 Project-URL: Changelog, https://github.com/strictdoc-project/strictdoc/blob/main/CHANGELOG.md
 Project-URL: Homepage, https://strictdoc.readthedocs.io/en/stable/

{strictdoc-0.0.54a1 → strictdoc-0.0.55}/strictdoc/__init__.py

@@ -1,6 +1,6 @@
 from strictdoc.core.environment import SDocRuntimeEnvironment
 
-__version__ = "0.0.54a1"
+__version__ = "0.0.55"
 
 
 environment = SDocRuntimeEnvironment(__file__)

{strictdoc-0.0.54a1 → strictdoc-0.0.55}/strictdoc/backend/excel/excel_import.py

@@ -1,3 +1,4 @@
+# mypy: disable-error-code="no-untyped-def"
 from strictdoc.backend.excel.import_.excel_to_sdoc_converter import (
     ExcelToSDocConverter,
 )

{strictdoc-0.0.54a1 → strictdoc-0.0.55}/strictdoc/backend/excel/export/excel_generator.py

@@ -1,3 +1,4 @@
+# mypy: disable-error-code="arg-type,no-untyped-def,type-arg,union-attr,var-annotated"
 import os
 from pathlib import Path
 from typing import Dict, List

{strictdoc-0.0.54a1 → strictdoc-0.0.55}/strictdoc/backend/excel/import_/excel_to_sdoc_converter.py

@@ -1,3 +1,4 @@
+# mypy: disable-error-code="no-untyped-call,no-untyped-def"
 import os
 from typing import List, NamedTuple, Optional, Tuple
 

{strictdoc-0.0.54a1 → strictdoc-0.0.55}/strictdoc/backend/reqif/p01_sdoc/reqif_to_sdoc_converter.py

@@ -1,3 +1,4 @@
+# mypy: disable-error-code="no-untyped-def,union-attr,operator"
 from typing import Dict, List, Optional, Set, Union
 
 from reqif.models.reqif_data_type import ReqIFDataTypeDefinitionEnumeration
@@ -21,29 +22,47 @@ from strictdoc.backend.sdoc.models.document_config import DocumentConfig
 from strictdoc.backend.sdoc.models.document_grammar import (
     DocumentGrammar,
     GrammarElement,
+    create_default_relations,
 )
 from strictdoc.backend.sdoc.models.free_text import FreeText
 from strictdoc.backend.sdoc.models.node import SDocNode, SDocNodeField
-from strictdoc.backend.sdoc.models.reference import ParentReqReference
+from strictdoc.backend.sdoc.models.reference import (
+    ParentReqReference,
+    Reference,
+)
 from strictdoc.backend.sdoc.models.section import SDocSection
 from strictdoc.backend.sdoc.models.type_system import (
     GrammarElementFieldMultipleChoice,
+    GrammarElementFieldReference,
     GrammarElementFieldSingleChoice,
     GrammarElementFieldString,
 )
 from strictdoc.helpers.string import unescape
 
 
-class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
+class P01_ReqIFToSDocBuildContext:
+    def __init__(self, *, enable_mid: bool, import_markup: Optional[str]):
+        self.enable_mid: bool = enable_mid
+        self.import_markup: Optional[str] = import_markup
+
+
+class P01_ReqIFToSDocConverter:
     @staticmethod
-    def convert_reqif_bundle(reqif_bundle: ReqIFBundle) -> List[SDocDocument]:
-        # TODO: Should we rather show an error that there are no specifications?
+    def convert_reqif_bundle(
+        reqif_bundle: ReqIFBundle,
+        enable_mid: bool,
+        import_markup: str,
+    ) -> List[SDocDocument]:
+        context = P01_ReqIFToSDocBuildContext(
+            enable_mid=enable_mid, import_markup=import_markup
+        )
+
         if (
             reqif_bundle.core_content is None
             or reqif_bundle.core_content.req_if_content is None
             or len(reqif_bundle.core_content.req_if_content.specifications) == 0
         ):
-            return [P01_ReqIFToSDocConverter.create_document(title=None)]
+            return []
 
         documents: List[SDocDocument] = []
         for (
@@ -52,6 +71,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
             document = P01_ReqIFToSDocConverter._create_document_from_reqif_specification(
                 specification=specification,
                 reqif_bundle=reqif_bundle,
+                context=context,
             )
             documents.append(document)
         return documents
@@ -92,72 +112,57 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
         *,
         specification: ReqIFSpecification,
         reqif_bundle: ReqIFBundle,
+        context: P01_ReqIFToSDocBuildContext,
     ):
         document = P01_ReqIFToSDocConverter.create_document(
-            title=specification.long_name
+            specification=specification, context=context
         )
         elements: List[GrammarElement] = []
         document.section_contents = []
-        section_stack = [document]
         used_spec_object_types_ids: Set[str] = set()
 
-        for current_hierarchy in reqif_bundle.iterate_specification_hierarchy(
-            specification
+        def node_converter_lambda(
+            current_hierarchy_,
+            current_section_,
         ):
-            current_section = section_stack[-1]
-
             spec_object = reqif_bundle.get_spec_object_by_ref(
-                current_hierarchy.spec_object
+                current_hierarchy_.spec_object
             )
             used_spec_object_types_ids.add(spec_object.spec_object_type)
-            if P01_ReqIFToSDocConverter.is_spec_object_section(
+
+            is_section = P01_ReqIFToSDocConverter.is_spec_object_section(
                 spec_object,
                 reqif_bundle=reqif_bundle,
-            ):
-                section = (
+            )
+
+            converted_node: Union[SDocSection, SDocNode]
+            if is_section:
+                converted_node = (
                     P01_ReqIFToSDocConverter.create_section_from_spec_object(
-                        spec_object,
-                        current_hierarchy.level,
+                        spec_object=spec_object,
+                        context=context,
+                        level=current_hierarchy_.level,
                         reqif_bundle=reqif_bundle,
                     )
                 )
-                if current_hierarchy.level > current_section.ng_level:
-                    current_section.section_contents.append(section)
-                    section_stack.append(section)
-                elif current_hierarchy.level < current_section.ng_level:
-                    for _ in range(
-                        0,
-                        (current_section.ng_level - current_hierarchy.level)
-                        + 1,
-                    ):
-                        assert len(section_stack) > 0
-                        section_stack.pop()
-                        current_section = section_stack[-1]
-                    current_section.section_contents.append(section)
-                    section_stack.append(section)
-                else:
-                    section_stack.pop()
-                    current_section = section_stack[-1]
-                    current_section.section_contents.append(section)
-                    section_stack.append(section)
-            elif P01_ReqIFToSDocConverter.is_spec_object_requirement(
-                spec_object
-            ):
-                requirement: SDocNode = P01_ReqIFToSDocConverter.create_requirement_from_spec_object(
+            else:
+                converted_node = P01_ReqIFToSDocConverter.create_requirement_from_spec_object(
                     spec_object=spec_object,
-                    parent_section=section_stack[-1],
+                    context=context,
+                    parent_section=current_section_,
                     reqif_bundle=reqif_bundle,
-                    level=current_hierarchy.level,
+                    level=current_hierarchy_.level,
                 )
-                for _ in range(
-                    0, (current_section.ng_level - current_hierarchy.level) + 1
-                ):
-                    assert len(section_stack) > 0
-                    section_stack.pop()
-                    current_section = section_stack[-1]
-                current_section.section_contents.append(requirement)
-            else:
-                raise NotImplementedError(spec_object) from None
+            current_section_.section_contents.append(converted_node)
+
+            return converted_node, is_section
+
+        reqif_bundle.iterate_specification_hierarchy_for_conversion(
+            specification,
+            document,
+            lambda s: s.ng_level,
+            node_converter_lambda,
+        )
 
         # See SDOC_IMPL_1.
         if (
@@ -186,6 +191,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                     reqif_bundle=reqif_bundle,
                 )
                 elements.append(grammar_element)
+        grammar: DocumentGrammar
         if len(elements) > 0:
             grammar = DocumentGrammar(parent=document, elements=elements)
             grammar.is_default = False
@@ -201,7 +207,14 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
         spec_object_type: ReqIFSpecObjectType,
         reqif_bundle: ReqIFBundle,
     ):
-        fields = []
+        fields: List[
+            Union[
+                GrammarElementFieldString,
+                GrammarElementFieldMultipleChoice,
+                GrammarElementFieldSingleChoice,
+                GrammarElementFieldReference,
+            ]
+        ] = []
         for attribute in spec_object_type.attribute_definitions:
             field_name = (
                 P01_ReqIFToSDocConverter.convert_requirement_field_from_reqif(
@@ -268,15 +281,34 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
         requirement_element = GrammarElement(
             parent=None, tag="REQUIREMENT", fields=fields, relations=[]
         )
+        requirement_element.relations = create_default_relations(
+            requirement_element
+        )
         return requirement_element
 
     @staticmethod
-    def create_document(title: Optional[str]) -> SDocDocument:
+    def create_document(
+        *,
+        specification: ReqIFSpecification,
+        context: P01_ReqIFToSDocBuildContext,
+    ) -> SDocDocument:
         document_config = DocumentConfig.default_config(None)
-        document_title = title if title else "<No title>"
+        document_config.enable_mid = (
+            context.enable_mid if context.enable_mid else None
+        )
+        document_title = (
+            specification.long_name
+            if specification.long_name is not None
+            else "<No title>"
+        )
         document = SDocDocument(
             None, document_title, document_config, None, None, [], []
         )
+        if context.enable_mid:
+            document.reserved_mid = specification.identifier
+        if context.import_markup is not None:
+            document_config.markup = context.import_markup
+
         document.grammar = DocumentGrammar.create_default(document)
         # FIXME: One day this will go away.
         document.ng_at_least_one_relations_field = False
@@ -284,7 +316,11 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
 
     @staticmethod
     def create_section_from_spec_object(
-        spec_object: ReqIFSpecObject, level, reqif_bundle: ReqIFBundle
+        *,
+        spec_object: ReqIFSpecObject,
+        context: P01_ReqIFToSDocBuildContext,
+        level: int,
+        reqif_bundle: ReqIFBundle,
     ) -> SDocSection:
         spec_object_type = reqif_bundle.lookup.get_spec_type_by_ref(
             spec_object.spec_object_type
@@ -324,9 +360,12 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
         #                 Some value
         #               </THE-VALUE>
         section_title = section_title.strip().replace("\n", " ")
+
+        section_mid = spec_object.identifier if context.enable_mid else None
+
         section = SDocSection(
             parent=None,
-            mid=None,
+            mid=section_mid,
             uid=None,
             custom_level=None,
             title=section_title,
@@ -340,6 +379,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
     @staticmethod
     def create_requirement_from_spec_object(
         spec_object: ReqIFSpecObject,
+        context: P01_ReqIFToSDocBuildContext,
         parent_section: Union[SDocSection, SDocDocument],
         reqif_bundle: ReqIFBundle,
         level,
@@ -410,6 +450,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
             attribute_multiline_value = None
             if (
                 "\n" in attribute_value
+                or attribute.attribute_type == SpecObjectAttributeType.XHTML
                 or field_name == ReqIFRequirementReservedField.TEXT
                 or field_name == ReqIFRequirementReservedField.COMMENT_NOTES
             ):
@@ -430,21 +471,23 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
                     field_value_references=None,
                 )
             )
+
+        requirement_mid = spec_object.identifier if context.enable_mid else None
         requirement = SDocNode(
             parent=parent_section,
             requirement_type="REQUIREMENT",
-            mid=None,
+            mid=requirement_mid,
             fields=fields,
         )
         requirement.ng_level = level
         # FIXME: One day this will go away.
-        requirement.ng_uses_old_refs_field = True
+        requirement.ng_uses_old_refs_field = False
 
         if foreign_key_id_or_none is not None:
             spec_object_parents = reqif_bundle.get_spec_object_parents(
                 spec_object.identifier
             )
-            parent_refs = []
+            parent_refs: List[Reference] = []
             for spec_object_parent in spec_object_parents:
                 parent_spec_object_parent = (
                     reqif_bundle.lookup.get_spec_object_by_ref(