strictdoc 0.5.0__tar.gz → 0.6.1a1__tar.gz

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: strictdoc
-Version: 0.5.0
+Version: 0.6.1a1
 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/
@@ -22,22 +22,21 @@ Requires-Python: >=3.8
 Requires-Dist: beautifulsoup4==4.*,>=4.12.0
 Requires-Dist: docutils==0.*,>=0.16
 Requires-Dist: fastapi>=0.83.0
+Requires-Dist: html2print>=0.0.12
 Requires-Dist: html5lib>=1.1
 Requires-Dist: jinja2>=2.11.2
+Requires-Dist: openpyxl>=3.1.0
 Requires-Dist: pygments==2.*,>=2.10.0
 Requires-Dist: python-datauri==2.*,>=2.1.1
 Requires-Dist: python-multipart
 Requires-Dist: reqif==0.*,>=0.0.39
-Requires-Dist: requests
-Requires-Dist: selenium
 Requires-Dist: spdx-tools
-Requires-Dist: textx==3.*,>=3.0.0
+Requires-Dist: textx==4.*,>=4.0.0
 Requires-Dist: toml
 Requires-Dist: tree-sitter
 Requires-Dist: tree-sitter-cpp
 Requires-Dist: tree-sitter-python
 Requires-Dist: uvicorn[standard]>=0.14.0
-Requires-Dist: webdriver-manager
 Requires-Dist: websockets
 Requires-Dist: xlrd==2.*,>=2.0.1
 Requires-Dist: xlsxwriter==1.*,>=1.3.7

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/pyproject.toml

@@ -48,7 +48,7 @@ classifiers = [
 
 # @sdoc[SDOC-SRS-89]
 dependencies = [
-    "textx >= 3.0.0, == 3.*",
+    "textx >= 4.0.0, == 4.*",
     "jinja2 >= 2.11.2",
     # Reading project config from strictdoc.toml file.
     "toml",
@@ -72,6 +72,7 @@ dependencies = [
     # Excel
     "XlsxWriter >= 1.3.7, == 1.*",
     "xlrd >= 2.0.1, == 2.*",
+    "openpyxl >= 3.1.0",
 
     # ReqIF
     "reqif >= 0.0.39, == 0.*",
@@ -87,10 +88,7 @@ dependencies = [
     "WebSockets",
 
     # HTML2PDF dependencies
-    "selenium",
-    "webdriver-manager",
-    # requests is used by StrictDoc's custom HTML2PDF_HTTPClient.
-    "requests",
+    "html2print >= 0.0.12",
 ]
 # @sdoc[/SDOC-SRS-89]
 

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/__init__.py

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

strictdoc-0.6.1a1/strictdoc/backend/excel/import_/excel_sheet_proxy.py

@@ -0,0 +1,83 @@
+from enum import Enum
+from typing import List
+
+import openpyxl
+import xlrd
+
+from strictdoc.helpers.auto_described import auto_described
+
+
+class ExcelLibType(Enum):
+    XLRD = 1
+    OPENPYXL = 2
+
+
+@auto_described
+class ExcelSheetProxy:
+    """This proxy class allows to open either xls(xlrd) or xlsx(openpyxl) with the same interface"""
+
+    def __init__(self, file: str):
+        self.file = file
+        if file.endswith(".xlsx"):
+            self.workbook = openpyxl.load_workbook(file)
+            self.sheet = self.workbook.active
+            if self.sheet is None:
+                raise RuntimeError(
+                    "Couldn't open the first sheet of the workbook"
+                )
+            self.lib = ExcelLibType.OPENPYXL
+        elif file.endswith(".xls"):
+            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")
+
+    @property
+    def name(self) -> str:
+        """returns the name of the first sheet"""
+        if self.lib == ExcelLibType.OPENPYXL:
+            return str(self.sheet.title)
+        elif self.lib == ExcelLibType.XLRD:
+            return str(self.sheet.name)
+        return ""
+
+    @property
+    def ncols(self) -> int:
+        """the number of columns"""
+        ncols: int = 0
+        if self.lib == ExcelLibType.OPENPYXL:
+            ncols = self.sheet.max_column
+        elif self.lib == ExcelLibType.XLRD:
+            ncols = self.sheet.ncols
+        return ncols
+
+    @property
+    def nrows(self) -> int:
+        """the number of rows"""
+        nrows: int = 0
+        if self.lib == ExcelLibType.OPENPYXL:
+            nrows = self.sheet.max_row
+        elif self.lib == ExcelLibType.XLRD:
+            nrows = self.sheet.nrows
+        return nrows
+
+    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 ""
+            )
+        elif self.lib == ExcelLibType.XLRD:
+            cell_value = self.sheet.cell_value(row, col)
+        return cell_value
+
+    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]]
+        elif self.lib == ExcelLibType.XLRD:
+            row_values = self.sheet.row_values(row)
+        return row_values

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/backend/excel/import_/excel_to_sdoc_converter.py

@@ -1,9 +1,8 @@
 # mypy: disable-error-code="no-untyped-call,no-untyped-def"
 import os
-from typing import List, NamedTuple, Optional, Tuple
-
-import xlrd
+from typing import List, NamedTuple, Optional, Tuple, Union
 
+from strictdoc.backend.excel.import_.excel_sheet_proxy import ExcelSheetProxy
 from strictdoc.backend.sdoc.models.document import SDocDocument
 from strictdoc.backend.sdoc.models.document_config import DocumentConfig
 from strictdoc.backend.sdoc.models.document_grammar import (
@@ -42,24 +41,25 @@ def safe_name(dangerous_name):
 class ExcelToSDocConverter:
     @staticmethod
     # optional argument title is present for external scripts to assign a title
-    def convert(excel_file, title=None) -> SDocDocument:
-        excel_workbook = xlrd.open_workbook(filename=excel_file, on_demand=True)
-        xlrd_sheet: xlrd.sheet.Sheet = excel_workbook.sheet_by_index(0)
+    def convert(
+        excel_file: str, title: Union[str, None] = None
+    ) -> SDocDocument:
+        sheet = ExcelSheetProxy(excel_file)
 
         excel_file_name = os.path.basename(excel_file)
         if title is None:
-            title = excel_file_name + " sheet " + xlrd_sheet.name
+            title = excel_file_name + " sheet " + sheet.name
 
-        all_header_columns = list(range(xlrd_sheet.ncols))
+        all_header_columns = list(range(sheet.ncols))
 
         for i in range(16):  # the first 16 rows should do ¯\_(ツ)_/¯
-            if xlrd_sheet.row_values(0)[0].strip() != "":
+            if sheet.row_values(i)[0].strip() != "":
                 header_row_idx = i
                 break
         else:
             raise NotImplementedError
 
-        header_row = xlrd_sheet.row_values(header_row_idx)
+        header_row = sheet.row_values(header_row_idx)
         safe_header_row = [safe_name(x) for x in header_row]
 
         statement_column = None
@@ -105,8 +105,8 @@ class ExcelToSDocConverter:
         document = ExcelToSDocConverter.create_document(
             title, extra_header_pairs
         )
-        for i in range(header_row_idx + 1, xlrd_sheet.nrows):
-            row_values = xlrd_sheet.row_values(i)
+        for i in range(header_row_idx + 1, sheet.nrows):
+            row_values = sheet.row_values(i)
             requirement = ExcelToSDocConverter.create_requirement(
                 row_values, document, columns
             )

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/backend/reqif/reqif_import.py

@@ -21,9 +21,9 @@ class ReqIFImport:
     ) -> List[SDocDocument]:
         converter = ReqIFImport.select_reqif_profile(import_config)
 
-        assert os.path.isfile(
+        assert os.path.isfile(import_config.input_path), (
             import_config.input_path
-        ), import_config.input_path
+        )
 
         if import_config.input_path.endswith(".reqifz"):
             reqifz_bundle: ReqIFZBundle = ReqIFZParser.parse(

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/backend/sdoc/error_handling.py

@@ -128,9 +128,9 @@ class StrictDocSemanticError(Exception):
         problematic_field: SDocNodeField,
         path_to_sdoc_file: str,
     ):
-        assert isinstance(
-            problematic_field, SDocNodeField
-        ), f"{problematic_field}"
+        assert isinstance(problematic_field, SDocNodeField), (
+            f"{problematic_field}"
+        )
         requirement_dump = node.dump_fields_as_parsed()
         grammar_dump = document_grammar.dump_fields(node.node_type)
         return StrictDocSemanticError(

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/backend/sdoc/models/node.py

@@ -60,9 +60,9 @@ class SDocNodeField:
         multiline: bool,
     ) -> "SDocNodeField":
         assert isinstance(field_name, str) and len(field_name) > 0, field_name
-        assert (
-            isinstance(field_value, str) and len(field_value) > 0
-        ), field_value
+        assert isinstance(field_value, str) and len(field_value) > 0, (
+            field_value
+        )
 
         return SDocNodeField(
             parent=parent,
@@ -223,9 +223,9 @@ class SDocNode(SDocObject):
         field: SDocNodeField = self.ordered_fields_lookup[
             RequirementFieldName.TAGS
         ][0]
-        assert (
-            not field.is_multiline()
-        ), f"Field {RequirementFieldName.TAGS} must be a single-line field."
+        assert not field.is_multiline(), (
+            f"Field {RequirementFieldName.TAGS} must be a single-line field."
+        )
         tags = field.get_text_value().split(", ")
         return tags
 
@@ -262,6 +262,9 @@ class SDocNode(SDocObject):
     def is_requirement(self) -> bool:
         return True
 
+    def is_normative_node(self) -> bool:
+        return not self.is_text_node()
+
     def is_text_node(self) -> bool:
         return self.node_type == "TEXT"
 
@@ -286,9 +289,9 @@ class SDocNode(SDocObject):
         document: Optional[SDocDocument] = (
             self.ng_document_reference.get_document()
         )
-        assert (
-            document is not None
-        ), "A valid requirement must always have a reference to the document."
+        assert document is not None, (
+            "A valid requirement must always have a reference to the document."
+        )
         return document
 
     def get_document(self) -> Optional[SDocDocument]:
@@ -325,9 +328,9 @@ class SDocNode(SDocObject):
         document: Optional[SDocDocument] = (
             self.ng_document_reference.get_document()
         )
-        assert (
-            document is not None
-        ), "A valid requirement must always have a reference to the document."
+        assert document is not None, (
+            "A valid requirement must always have a reference to the document."
+        )
         return document
 
     def document_is_included(self) -> bool:

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/backend/sdoc/models/object_factory.py

@@ -74,9 +74,9 @@ class SDocObjectFactory:
                 )
             )
         if statement_multiline is not None:
-            assert isinstance(
-                statement_multiline, str
-            ), f"{statement_multiline}"
+            assert isinstance(statement_multiline, str), (
+                f"{statement_multiline}"
+            )
             fields.append(
                 SDocNodeField.create_from_string(
                     parent=None,

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/backend/sdoc/models/section.py

@@ -110,9 +110,9 @@ class SDocSection(SDocObject):
         document: Optional[SDocDocument] = (
             self.ng_document_reference.get_document()
         )
-        assert (
-            document is not None
-        ), "A valid requirement must always have a reference to the document."
+        assert document is not None, (
+            "A valid requirement must always have a reference to the document."
+        )
         return document
 
     def document_is_included(self):
@@ -130,6 +130,12 @@ class SDocSection(SDocObject):
     def is_section(self):
         return True
 
+    def has_any_text_nodes(self):
+        return any(
+            not node_.is_section and node_.node_type == "TEXT"
+            for node_ in self.section_contents
+        )
+
     @property
     def is_root(self) -> bool:
         return self.document.config.root is True

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/backend/sdoc/processor.py

@@ -168,9 +168,9 @@ class SDocParsingProcessor:
                 )
 
     def process_document_from_file(self, document_from_file: DocumentFromFile):
-        assert isinstance(
-            document_from_file, DocumentFromFile
-        ), document_from_file
+        assert isinstance(document_from_file, DocumentFromFile), (
+            document_from_file
+        )
 
         # Windows paths are backslashes, so using abspath in addition.
         resolved_path_to_fragment_file = os.path.abspath(

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/backend/sdoc/writer.py

@@ -109,6 +109,11 @@ class SDWriter:
                 output += f"VERSION: {version}"
                 output += "\n"
 
+            date = document_config.date
+            if date is not None:
+                output += f"DATE: {date}"
+                output += "\n"
+
             classification = document_config.classification
             if classification is not None:
                 output += f"CLASSIFICATION: {classification}"
@@ -256,9 +261,9 @@ class SDWriter:
         document_iterator: DocumentCachingIterator,
         convert_free_text_to_text: bool = False,
     ):
-        assert isinstance(
-            document_iterator, DocumentCachingIterator
-        ), document_iterator
+        assert isinstance(document_iterator, DocumentCachingIterator), (
+            document_iterator
+        )
 
         if isinstance(root_node, SDocDocument):
             output = ""

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/backend/sdoc_source_code/reader.py

@@ -32,9 +32,9 @@ class ParseContext:
 
 
 def req_processor(req: Req):
-    assert isinstance(
-        req, Req
-    ), f"Expected req to be Req, got: {req}, {type(req)}"
+    assert isinstance(req, Req), (
+        f"Expected req to be Req, got: {req}, {type(req)}"
+    )
     location = get_location(req)
     assert location
     req.ng_source_line = location["line"]

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/cli/cli_arg_parser.py

@@ -60,7 +60,7 @@ class ManageAutoUIDCommandConfig:
 
 
 class ImportExcelCommandConfig:
-    def __init__(self, input_path, output_path, parser):
+    def __init__(self, input_path: str, output_path: str, parser):
         self.input_path = input_path
         self.output_path = output_path
         self.parser = parser

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/core/actions/export_action.py

@@ -51,9 +51,9 @@ class ExportAction:
 
     @timing_decorator("Export SDoc")
     def export(self) -> None:
-        assert (
-            self.traceability_index is not None
-        ), "The index must be built at this point."
+        assert self.traceability_index is not None, (
+            "The index must be built at this point."
+        )
         if (
             "html" in self.project_config.export_formats
             or "html-standalone" in self.project_config.export_formats

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/core/asset_manager.py

@@ -11,9 +11,9 @@ class AssetDir:
     relative_path: SDocRelativePath
 
     def __post_init__(self):
-        assert isinstance(
-            self.relative_path, SDocRelativePath
-        ), self.relative_path
+        assert isinstance(self.relative_path, SDocRelativePath), (
+            self.relative_path
+        )
 
 
 class AssetManager:

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/core/document_finder.py

@@ -115,9 +115,9 @@ class DocumentFinder:
 
         doc_file: File
         for doc_file, file_tree_mount_folder, document in found_documents:
-            assert isinstance(
-                file_tree_mount_folder, str
-            ), file_tree_mount_folder
+            assert isinstance(file_tree_mount_folder, str), (
+                file_tree_mount_folder
+            )
 
             if isinstance(document, DocumentGrammar):
                 map_grammars_by_filenames[doc_file.file_name] = document

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/core/document_meta.py

@@ -38,18 +38,18 @@ class DocumentMeta:
             output_document_dir_rel_path = "doc_project"
         )
         """
-        assert isinstance(
-            input_doc_rel_path, SDocRelativePath
-        ), input_doc_rel_path
-        assert isinstance(
-            input_doc_dir_rel_path, SDocRelativePath
-        ), input_doc_dir_rel_path
-        assert isinstance(
-            input_doc_assets_dir_rel_path, SDocRelativePath
-        ), input_doc_assets_dir_rel_path
-        assert isinstance(
-            output_document_dir_rel_path, SDocRelativePath
-        ), output_document_dir_rel_path
+        assert isinstance(input_doc_rel_path, SDocRelativePath), (
+            input_doc_rel_path
+        )
+        assert isinstance(input_doc_dir_rel_path, SDocRelativePath), (
+            input_doc_dir_rel_path
+        )
+        assert isinstance(input_doc_assets_dir_rel_path, SDocRelativePath), (
+            input_doc_assets_dir_rel_path
+        )
+        assert isinstance(output_document_dir_rel_path, SDocRelativePath), (
+            output_document_dir_rel_path
+        )
 
         self.level: int = level
         self.file_tree_mount_folder = file_tree_mount_folder

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/core/environment.py

@@ -103,14 +103,3 @@ class SDocRuntimeEnvironment:
         return os.path.join(
             self.path_to_strictdoc, "strictdoc", "export", "html"
         )
-
-    def get_path_to_html2pdf(self):
-        if self.is_binary_dist:
-            return os.path.join(self.path_to_strictdoc, "html2pdf.py")
-        return os.path.join(
-            self.path_to_strictdoc,
-            "strictdoc",
-            "export",
-            "html2pdf",
-            "html2pdf.py",
-        )

{strictdoc-0.5.0 → strictdoc-0.6.1a1}/strictdoc/core/file_traceability_index.py

@@ -50,7 +50,7 @@ class FileTraceabilityIndex:
 
         # This is only public non-static functions from languages like C.
         self.map_all_function_names_to_definition_functions: Dict[
-            str, Function
+            str, List[Function]
         ] = {}
 
         # "file.py" -> (
@@ -241,70 +241,77 @@ class FileTraceabilityIndex:
                     and function_.name
                     in self.map_all_function_names_to_definition_functions
                 ):
-                    definition_function: Optional[Function]
+                    definition_functions: List[Function] = []
                     if not function_.is_public():
                         definition_function = traceability_info_.ng_map_names_to_definition_functions.get(
-                            function_.name
+                            function_.name, None
                         )
+                        if definition_function is not None:
+                            definition_functions.append(definition_function)
                     else:
-                        definition_function = (
+                        mapped_definition_functions = (
                             self.map_all_function_names_to_definition_functions[
                                 function_.name
                             ]
                         )
-                    if definition_function is None:
+                        definition_functions.extend(mapped_definition_functions)
+                    if len(definition_functions) == 0:
                         continue
-                    definition_function_trace_info: SourceFileTraceabilityInfo = definition_function.parent
 
-                    for marker_ in function_.markers:
-                        function_marker = ForwardFunctionRangeMarker(
-                            parent=None,
-                            reqs_objs=marker_.reqs_objs,
-                            scope="function",
-                        )
-                        function_marker.ng_source_line_begin = (
-                            definition_function.line_begin
-                        )
-                        function_marker.ng_source_column_begin = 1
-                        function_marker.ng_range_line_begin = (
-                            definition_function.line_begin
-                        )
-                        function_marker.ng_range_line_end = (
-                            definition_function.line_end
-                        )
-                        function_marker.ng_marker_line = (
-                            definition_function.line_begin
-                        )
-                        function_marker.ng_marker_column = 1
-                        function_marker.set_description(
-                            f"function {function_.display_name}"
-                        )
+                    for definition_function_ in definition_functions:
+                        definition_function_trace_info: SourceFileTraceabilityInfo = definition_function_.parent
 
-                        for req_uid_ in marker_.reqs:
-                            markers = definition_function_trace_info.ng_map_reqs_to_markers.setdefault(
-                                req_uid_, []
+                        for marker_ in function_.markers:
+                            function_marker = ForwardFunctionRangeMarker(
+                                parent=None,
+                                reqs_objs=marker_.reqs_objs,
+                                scope="function",
                             )
-                            markers.append(function_marker)
-
-                            path_to_info = reversed_trace_info[
-                                definition_function_trace_info
-                            ]
-                            self.map_reqs_uids_to_paths.setdefault(
-                                req_uid_, OrderedSet()
+                            function_marker.ng_source_line_begin = (
+                                definition_function_.line_begin
                             )
-                            self.map_reqs_uids_to_paths[req_uid_].add(
-                                path_to_info
+                            function_marker.ng_source_column_begin = 1
+                            function_marker.ng_range_line_begin = (
+                                definition_function_.line_begin
                             )
-
-                            node = traceability_index.get_node_by_uid(req_uid_)
-                            self.map_paths_to_reqs.setdefault(
-                                path_to_info, OrderedSet()
+                            function_marker.ng_range_line_end = (
+                                definition_function_.line_end
+                            )
+                            function_marker.ng_marker_line = (
+                                definition_function_.line_begin
+                            )
+                            function_marker.ng_marker_column = 1
+                            function_marker.set_description(
+                                f"function {function_.display_name}"
                             )
-                            self.map_paths_to_reqs[path_to_info].add(node)
 
-                        definition_function_trace_info.markers.append(
-                            function_marker
-                        )
+                            for req_uid_ in marker_.reqs:
+                                markers = definition_function_trace_info.ng_map_reqs_to_markers.setdefault(
+                                    req_uid_, []
+                                )
+                                markers.append(function_marker)
+
+                                path_to_info = reversed_trace_info[
+                                    definition_function_trace_info
+                                ]
+                                self.map_reqs_uids_to_paths.setdefault(
+                                    req_uid_, OrderedSet()
+                                )
+                                self.map_reqs_uids_to_paths[req_uid_].add(
+                                    path_to_info
+                                )
+
+                                node = traceability_index.get_node_by_uid(
+                                    req_uid_
+                                )
+                                self.map_paths_to_reqs.setdefault(
+                                    path_to_info, OrderedSet()
+                                )
+                                self.map_paths_to_reqs[path_to_info].add(node)
+
+                            definition_function_trace_info.markers.append(
+                                function_marker
+                            )
 
         for (
             traceability_info_
@@ -440,14 +447,13 @@ class FileTraceabilityIndex:
             marker_type: RangeMarkerType
 
             if FunctionAttribute.DEFINITION in function_.attributes:
-                assert (
-                    function_.name
-                    not in self.map_all_function_names_to_definition_functions
-                ), function_.name
                 if function_.is_public():
+                    self.map_all_function_names_to_definition_functions.setdefault(
+                        function_.name, []
+                    )
                     self.map_all_function_names_to_definition_functions[
                         function_.name
-                    ] = function_
+                    ].append(function_)
 
             if (
                 source_file.in_doctree_source_file_rel_path_posix