strictdoc 0.9.0a1__tar.gz → 0.9.2__tar.gz

{strictdoc-0.9.0a1 → strictdoc-0.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: strictdoc
-Version: 0.9.0a1
+Version: 0.9.2
 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.9.0a1 → strictdoc-0.9.2}/strictdoc/__init__.py

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

{strictdoc-0.9.0a1 → strictdoc-0.9.2}/strictdoc/backend/excel/export/excel_generator.py

@@ -74,9 +74,12 @@ class ExcelGenerator:
                 }
             )
 
-            row = 1  # Header-Row
+            # Header row.
+            row = 1
+
             fields = project_config.excel_export_fields
-            # TODO: Check if all fields are defined by the DocumentGrammar
+
+            # FIXME: Check if all fields are defined by the DocumentGrammar.
             columns = ExcelGenerator._init_columns_width(fields)
 
             document_iterator = traceability_index.get_document_iterator(
@@ -85,9 +88,7 @@ class ExcelGenerator:
             all_nodes = list(
                 map(
                     lambda node_with_context_: node_with_context_[0],
-                    document_iterator.all_content(
-                        print_fragments=False, print_fragments_from_files=False
-                    ),
+                    document_iterator.all_content(print_fragments=False),
                 )
             )
             req_uid_rows = ExcelGenerator._lookup_refs(all_nodes)
@@ -95,17 +96,15 @@ class ExcelGenerator:
             if len(req_uid_rows):
                 for node, _ in traceability_index.get_document_iterator(
                     document
-                ).all_content(
-                    print_fragments=False, print_fragments_from_files=False
-                ):
+                ).all_content(print_fragments=False):
                     if not node.is_requirement() or not node.reserved_uid:
-                        # only export the requirements with uid
+                        # Only export the requirements with UID.
                         continue
 
                     for idx, field in enumerate(fields, start=0):
                         field_uc = field.upper()
 
-                        # Special treatment for ParentReqReference and Comments
+                        # Special treatment for ParentReqReference and Comments.
                         if field_uc in (
                             "RELATIONS:PARENT",
                             "PARENT",
@@ -115,7 +114,7 @@ class ExcelGenerator:
                                 ReferenceType.PARENT
                             )
                             if len(parent_refs) > 0:
-                                # TODO Allow multiple parent refs
+                                # FIXME: Allow multiple parent refs.
                                 ref = parent_refs[0]
                                 columns[field][MAX_WIDTH_KEY] = max(
                                     len(ref.ref_uid),
@@ -136,7 +135,7 @@ class ExcelGenerator:
                                     worksheet.write(row, idx, ref.ref_uid)
                         elif field_uc in ("COMMENT", "COMMENTS"):
                             # Using a transition marker to separate multiple
-                            # comments
+                            # comments.
                             comment_fields = node.get_comment_fields()
                             if len(comment_fields) > 0:
                                 comment_row_value: str = ""
@@ -159,7 +158,7 @@ class ExcelGenerator:
                             if len(node.relations) > 0:
                                 relations_components = []
                                 # Using a transition marker to separate
-                                # multiple references
+                                # multiple references.
                                 for ref in node.relations:
                                     if isinstance(ref, ParentReqReference):
                                         relations_components.append(
@@ -208,8 +207,8 @@ class ExcelGenerator:
 
                     row += 1
 
-                # add a table around all this data, allowing filtering and
-                # ordering in Excel
+                # Add a table around all this data, allowing filtering and
+                # ordering in Excel.
                 worksheet.add_table(
                     0,
                     0,
@@ -218,12 +217,12 @@ class ExcelGenerator:
                     {"columns": ExcelGenerator._init_headers(fields)},
                 )
 
-                # enforce columns width
+                # Enforce columns width.
                 ExcelGenerator._set_columns_width(
                     workbook, worksheet, columns, fields
                 )
             else:
-                # no requirement with UID
+                # No requirement with UID.
                 print(  # noqa: T201
                     "No requirement with UID, nothing to export into excel"
                 )
@@ -239,7 +238,7 @@ class ExcelGenerator:
         for content_node in document_contents:
             if isinstance(content_node, SDocNode):
                 if content_node.reserved_uid:
-                    # only export the requirements with uid, allowing tracking
+                    # Only export the requirements with uid, allowing tracking.
                     row += 1
                     refs[content_node.reserved_uid] = row
 

{strictdoc-0.9.0a1 → strictdoc-0.9.2}/strictdoc/backend/excel/import_/excel_sheet_proxy.py

@@ -5,6 +5,7 @@ import openpyxl
 import xlrd
 
 from strictdoc.helpers.auto_described import auto_described
+from strictdoc.helpers.cast import assert_cast
 
 
 class ExcelLibType(Enum):
@@ -15,7 +16,7 @@ class ExcelLibType(Enum):
 @auto_described
 class ExcelSheetProxy:
     """
-    This proxy class allows to open either xls(xlrd) or xlsx(openpyxl) with the same interface.
+    An adapter class to open xls(xlrd) or xlsx(openpyxl) with the same interface.
     """
 
     def __init__(self, file: str):
@@ -23,7 +24,7 @@ class ExcelSheetProxy:
         if file.endswith(".xlsx"):
             self.workbook = openpyxl.load_workbook(file)
             self.sheet = self.workbook.active
-            if self.sheet is None:
+            if self.sheet is None:  # pragma: no cover
                 raise RuntimeError(
                     "Couldn't open the first sheet of the workbook"
                 )
@@ -32,8 +33,8 @@ class ExcelSheetProxy:
             self.workbook = xlrd.open_workbook(file, on_demand=True)
             self.sheet = self.workbook.sheet_by_index(0)
             self.lib = ExcelLibType.XLRD
-        else:
-            raise ValueError("Unsupported file format")
+        else:  # pragma: no cover
+            raise AssertionError("Unsupported file format")
 
     @property
     def name(self) -> str:
@@ -44,52 +45,46 @@ class ExcelSheetProxy:
             return str(self.sheet.title)
         elif self.lib == ExcelLibType.XLRD:
             return str(self.sheet.name)
-        return ""
+        raise AssertionError
 
     @property
     def ncols(self) -> int:
         """
         The number of columns.
         """
-        ncols: int = 0
         if self.lib == ExcelLibType.OPENPYXL:
-            ncols = self.sheet.max_column
+            return assert_cast(self.sheet.max_column, int)
         elif self.lib == ExcelLibType.XLRD:
-            ncols = self.sheet.ncols
-        return ncols
+            return assert_cast(self.sheet.ncols, int)
+        raise AssertionError
 
     @property
     def nrows(self) -> int:
         """
         The number of rows.
         """
-        nrows: int = 0
         if self.lib == ExcelLibType.OPENPYXL:
-            nrows = self.sheet.max_row
+            return assert_cast(self.sheet.max_row, int)
         elif self.lib == ExcelLibType.XLRD:
-            nrows = self.sheet.nrows
-        return nrows
+            return assert_cast(self.sheet.nrows, int)
+        raise AssertionError
 
     def get_cell_value(self, row: int, col: int) -> str:
         """
         Returns the value at row/col as string.
         """
-        cell_value: str = ""
         if self.lib == ExcelLibType.OPENPYXL:
-            cell_value = (
-                self.sheet.cell(row=row + 1, column=col + 1).value or ""
-            )
+            return self.sheet.cell(row=row + 1, column=col + 1).value or ""
         elif self.lib == ExcelLibType.XLRD:
-            cell_value = self.sheet.cell_value(row, col)
-        return cell_value
+            return assert_cast(self.sheet.cell_value(row, col), str)
+        raise AssertionError
 
     def row_values(self, row: int) -> List[str]:
         """
         Returns a full row as list.
         """
-        row_values: List[str] = []
         if self.lib == ExcelLibType.OPENPYXL:
-            row_values = [(cell.value or "") for cell in self.sheet[row + 1]]
+            return [(cell.value or "") for cell in self.sheet[row + 1]]
         elif self.lib == ExcelLibType.XLRD:
-            row_values = self.sheet.row_values(row)
-        return row_values
+            return assert_cast(self.sheet.row_values(row), list)
+        raise AssertionError

{strictdoc-0.9.0a1 → strictdoc-0.9.2}/strictdoc/backend/excel/import_/excel_to_sdoc_converter.py

@@ -40,10 +40,14 @@ def safe_name(dangerous_name):
 
 class ExcelToSDocConverter:
     @staticmethod
-    # optional argument title is present for external scripts to assign a title
     def convert(
         excel_file: str, title: Union[str, None] = None
     ) -> SDocDocument:
+        """
+        Convert a provided Excel file to an SDoc document.
+
+        Optional argument title is present for external scripts to assign a title.
+        """
         sheet = ExcelSheetProxy(excel_file)
 
         excel_file_name = os.path.basename(excel_file)
@@ -52,12 +56,13 @@ class ExcelToSDocConverter:
 
         all_header_columns = list(range(sheet.ncols))
 
-        for i in range(16):  # the first 16 rows should do ¯\_(ツ)_/¯
+        # The first 16 rows should do ¯\_(ツ)_/¯.
+        for i in range(16):
             if sheet.row_values(i)[0].strip() != "":
                 header_row_idx = i
                 break
         else:
-            raise NotImplementedError  # pragma: no cover
+            raise NotImplementedError
 
         header_row = sheet.row_values(header_row_idx)
         safe_header_row = [safe_name(x) for x in header_row]

{strictdoc-0.9.0a1 → strictdoc-0.9.2}/strictdoc/backend/reqif/p01_sdoc/reqif_to_sdoc_converter.py

@@ -22,12 +22,16 @@ from strictdoc.backend.sdoc.models.document_grammar import (
     DocumentGrammar,
     GrammarElement,
 )
+from strictdoc.backend.sdoc.models.model import (
+    SDocDocumentIF,
+    SDocNodeIF,
+    SDocSectionIF,
+)
 from strictdoc.backend.sdoc.models.node import SDocNode, SDocNodeField
 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,
     GrammarElementFieldSingleChoice,
@@ -62,7 +66,7 @@ class P01_ReqIFToSDocConverter:
     def convert_reqif_bundle(
         reqif_bundle: ReqIFBundle,
         enable_mid: bool,
-        import_markup: str,
+        import_markup: Optional[str],
     ) -> List[SDocDocument]:
         context = P01_ReqIFToSDocBuildContext(
             enable_mid=enable_mid, import_markup=import_markup
@@ -97,19 +101,6 @@ class P01_ReqIFToSDocConverter:
             documents.append(document)
         return documents
 
-    @staticmethod
-    def is_spec_object_requirement(_):
-        return True
-
-    @staticmethod
-    def is_spec_object_section(
-        spec_object: ReqIFSpecObject, reqif_bundle: ReqIFBundle
-    ):
-        spec_object_type = reqif_bundle.lookup.get_spec_type_by_ref(
-            spec_object.spec_object_type
-        )
-        return spec_object_type.long_name == "SECTION"
-
     @staticmethod
     def convert_requirement_field_from_reqif(field_name: str) -> str:
         if field_name in ReqIFRequirementReservedField.SET:
@@ -123,10 +114,26 @@ class P01_ReqIFToSDocConverter:
         reqif_bundle: ReqIFBundle,
         context: P01_ReqIFToSDocBuildContext,
     ):
-        document = P01_ReqIFToSDocConverter.create_document(
-            specification=specification, context=context
+        # This lookup object is used to first collect the spec object type identifiers
+        # that are actually used by this document. This is needed to ensure that a
+        # StrictDoc document is not created with irrelevant grammar elements that
+        # actually belong to other Specifications in this ReqIF bundle.
+        # Using Dict as an ordered set.
+        spec_object_type_identifiers_used_by_this_document: OrderedSet[str] = (
+            OrderedSet()
         )
-        document.section_contents = []
+        section_spec_types = set()
+        for hierarchy_ in reqif_bundle.iterate_specification_hierarchy(
+            specification,
+        ):
+            spec_object = reqif_bundle.get_spec_object_by_ref(
+                hierarchy_.spec_object
+            )
+            spec_object_type_identifiers_used_by_this_document.add(
+                spec_object.spec_object_type
+            )
+            if hierarchy_.children is not None:
+                section_spec_types.add(spec_object.spec_object_type)
 
         for (
             spec_object_type_
@@ -134,84 +141,61 @@ class P01_ReqIFToSDocConverter:
             if not isinstance(spec_object_type_, ReqIFSpecObjectType):
                 continue
 
-            # FIXME: [[NODE]]
-            if spec_object_type_.long_name == "SECTION":
-                continue
-
             grammar_element: GrammarElement = P01_ReqIFToSDocConverter.create_grammar_element_from_spec_object_type(
                 spec_object_type=spec_object_type_,
                 reqif_bundle=reqif_bundle,
+                is_composite=spec_object_type_.identifier in section_spec_types,
             )
             context.map_spec_object_type_identifier_to_grammar_node_tags[
                 spec_object_type_.identifier
             ] = grammar_element
 
-        # This lookup object is used to first collect the spec object type identifiers
-        # that are actually used by this document. This is needed to ensure that a
-        # StrictDoc document is not created with irrelevant grammar elements that
-        # actually belong to other Specifications in this ReqIF bundle.
-        # Using Dict as an ordered set.
-        spec_object_type_identifiers_used_by_this_document: OrderedSet[str] = (
-            OrderedSet()
+        document = P01_ReqIFToSDocConverter.create_document(
+            specification=specification, context=context
         )
+        document.section_contents = []
 
-        def node_converter_lambda(
-            current_hierarchy_,
-            current_section_,
+        node_stack: List[Union[SDocDocumentIF, SDocNodeIF]] = [document]
+
+        for hierarchy_ in reqif_bundle.iterate_specification_hierarchy(
+            specification,
         ):
-            spec_object = reqif_bundle.get_spec_object_by_ref(
-                current_hierarchy_.spec_object
-            )
-            spec_object_type_identifiers_used_by_this_document.add(
-                spec_object.spec_object_type
-            )
+            while len(node_stack) > hierarchy_.level:
+                node_stack.pop()
 
-            is_section = P01_ReqIFToSDocConverter.is_spec_object_section(
-                spec_object,
-                reqif_bundle=reqif_bundle,
-            )
+            parent_node = node_stack[-1]
 
-            converted_node: Union[SDocSection, SDocNode]
-            if is_section:
-                converted_node = (
-                    P01_ReqIFToSDocConverter.create_section_from_spec_object(
-                        spec_object=spec_object,
-                        context=context,
-                        parent_section=current_section_,
-                        level=current_hierarchy_.level,
-                        reqif_bundle=reqif_bundle,
-                    )
-                )
-            else:
-                converted_node = P01_ReqIFToSDocConverter.create_requirement_from_spec_object(
+            spec_object = reqif_bundle.get_spec_object_by_ref(
+                hierarchy_.spec_object
+            )
+            converted_node: SDocNode = (
+                P01_ReqIFToSDocConverter.create_requirement_from_spec_object(
                     spec_object=spec_object,
                     context=context,
-                    parent_section=current_section_,
+                    parent_section=parent_node,
                     reqif_bundle=reqif_bundle,
-                    level=current_hierarchy_.level,
+                    level=hierarchy_.level,
                 )
-            current_section_.section_contents.append(converted_node)
+            )
+            parent_node.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,
-        )
+            if spec_object.spec_object_type in section_spec_types:
+                node_stack.append(converted_node)
 
         elements: List[GrammarElement] = []
         for (
-            spec_object_type_identifier_
-        ) in spec_object_type_identifiers_used_by_this_document:
-            spec_object_type: ReqIFSpecObjectType = (
-                reqif_bundle.lookup.get_spec_type_by_ref(
-                    spec_object_type_identifier_
-                )
-            )
-            if spec_object_type.long_name == "SECTION":
+            spec_object_type_
+        ) in reqif_bundle.core_content.req_if_content.spec_types:
+            if not isinstance(spec_object_type_, ReqIFSpecObjectType):
                 continue
+
+            spec_object_type_identifier_ = spec_object_type_.identifier
+            if (
+                spec_object_type_identifier_
+                not in spec_object_type_identifiers_used_by_this_document
+            ):
+                continue
+
             grammar_element = (
                 context.map_spec_object_type_identifier_to_grammar_node_tags[
                     spec_object_type_identifier_
@@ -229,7 +213,10 @@ class P01_ReqIFToSDocConverter:
             grammar = DocumentGrammar(parent=document, elements=elements)
             grammar.is_default = False
         else:
+            # This case is mainly a placeholder for simple edge cases such as
+            # an empty [DOCUMENT] where there are no grammar or nodes declared.
             grammar = DocumentGrammar.create_default(parent=document)
+
         document.grammar = grammar
 
         return document
@@ -239,6 +226,7 @@ class P01_ReqIFToSDocConverter:
         *,
         spec_object_type: ReqIFSpecObjectType,
         reqif_bundle: ReqIFBundle,
+        is_composite: bool,
     ):
         fields: List[
             Union[
@@ -247,6 +235,7 @@ class P01_ReqIFToSDocConverter:
                 GrammarElementFieldSingleChoice,
             ]
         ] = []
+
         for attribute in spec_object_type.attribute_definitions:
             field_name = (
                 P01_ReqIFToSDocConverter.convert_requirement_field_from_reqif(
@@ -316,9 +305,7 @@ class P01_ReqIFToSDocConverter:
         requirement_element = GrammarElement(
             parent=None,
             tag=create_safe_requirement_tag_string(spec_object_type.long_name),
-            # FIXME: MERGE NODES
-            #        When the migration is done, make the nodes to be always recursive.
-            property_is_composite="",
+            property_is_composite="True" if is_composite else "",
             property_prefix="",
             property_view_style="",
             fields=fields,
@@ -352,86 +339,13 @@ class P01_ReqIFToSDocConverter:
         document.grammar = DocumentGrammar.create_default(document)
         return document
 
-    @staticmethod
-    def create_section_from_spec_object(
-        *,
-        spec_object: ReqIFSpecObject,
-        context: P01_ReqIFToSDocBuildContext,
-        parent_section: Union[SDocSection, SDocDocument],
-        level: int,
-        reqif_bundle: ReqIFBundle,
-    ) -> SDocSection:
-        spec_object_type = reqif_bundle.lookup.get_spec_type_by_ref(
-            spec_object.spec_object_type
-        )
-        attribute_map: Dict[str, SpecAttributeDefinition] = (
-            spec_object_type.attribute_map
-        )
-        assert attribute_map is not None
-        for attribute in spec_object.attributes:
-            field_name_or_none: Optional[str] = attribute_map[
-                attribute.definition_ref
-            ].long_name
-            if field_name_or_none is None:
-                raise NotImplementedError  # pragma: no cover
-            field_name: str = field_name_or_none
-            if field_name == ReqIFChapterField.CHAPTER_NAME:
-                section_title = attribute.value
-                break
-        else:
-            raise NotImplementedError(  # pragma: no cover
-                spec_object, attribute_map
-            )
-
-        # Sanitize the title. Titles can also come from XHTML attributes with
-        # custom newlines such as:
-        #             <ATTRIBUTE-VALUE-XHTML>
-        #               <THE-VALUE>
-        #                 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=parent_section,
-            mid=section_mid,
-            uid=None,
-            custom_level=None,
-            title=section_title,
-            requirement_prefix=None,
-            section_contents=[],
-        )
-        section.ng_level = level
-
-        if ReqIFChapterField.TEXT in spec_object.attribute_map:
-            free_text = unescape(
-                spec_object.attribute_map[ReqIFChapterField.TEXT].value
-            )
-            node_field = SDocNodeField.create_from_string(
-                None,
-                field_name="STATEMENT",
-                field_value=free_text,
-                multiline=True,
-            )
-            node: SDocNode = SDocNode(
-                parent=section,
-                node_type="TEXT",
-                fields=[node_field],
-                relations=[],
-            )
-            node_field.parent = node
-            section.section_contents.append(node)
-
-        return section
-
     @staticmethod
     def create_requirement_from_spec_object(
         spec_object: ReqIFSpecObject,
         context: P01_ReqIFToSDocBuildContext,
-        parent_section: Union[SDocSection, SDocDocument],
+        parent_section: Union[SDocSectionIF, SDocDocumentIF, SDocNodeIF],
         reqif_bundle: ReqIFBundle,
-        level,
+        level: int,
     ) -> SDocNode:
         fields = []
         spec_object_type = reqif_bundle.lookup.get_spec_type_by_ref(
@@ -447,7 +361,7 @@ class P01_ReqIFToSDocConverter:
                 attribute.definition_ref
             ].long_name
             if long_name_or_none is None:
-                raise NotImplementedError  # pragma: no cover
+                raise NotImplementedError
             field_name: str = long_name_or_none
             if attribute.attribute_type == SpecObjectAttributeType.ENUMERATION:
                 sdoc_field_name = P01_ReqIFToSDocConverter.convert_requirement_field_from_reqif(
@@ -479,7 +393,7 @@ class P01_ReqIFToSDocConverter:
 
                         break
                 else:
-                    raise NotImplementedError  # pragma: no cover
+                    raise NotImplementedError
 
                 enum_values = ", ".join(enum_values_resolved)
                 fields.append(
@@ -548,6 +462,10 @@ class P01_ReqIFToSDocConverter:
             node_type=grammar_element.tag,
             fields=fields,
             relations=[],
+            is_composite=grammar_element.property_is_composite is True,
+            node_type_close=grammar_element.tag
+            if grammar_element.property_is_composite
+            else None,
         )
         requirement.ng_level = level
         for field_ in fields: