specitems 1.4.0__tar.gz → 1.4.2__tar.gz

{specitems-1.4.0 → specitems-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: specitems
-Version: 1.4.0
+Version: 1.4.2
 Summary: Provides interfaces to work with specification items.
 Keywords: certification,documentation,markdown,qualification,requirements-management,traceability
 Author: The specitems Authors

{specitems-1.4.0 → specitems-1.4.2}/pyproject.toml

@@ -4,7 +4,7 @@
 
 [project]
 name = "specitems"
-version = "1.4.0"
+version = "1.4.2"
 description = "Provides interfaces to work with specification items."
 authors = [
     {name = "The specitems Authors", email = "specthings@embedded-brains.de"}

{specitems-1.4.0 → specitems-1.4.2}/src/specitems/contentmarkdown.py

@@ -46,12 +46,17 @@ def _md_escape(match: Match) -> str:
     return f"\\{match.group(0)}"
 
 
+def _simple_row(row: Iterable[str], maxi: Iterable[int]) -> str:
+    line = " | ".join(f"{cell:{width}}" for cell, width in zip(row, maxi))
+    return f" | {line} |"
+
+
 class MarkdownContent(TextContent):
     """ This class builds MyST Markdown content. """
 
     # pylint: disable=too-many-public-methods
     def __init__(self,
-                 section_level: int = 1,
+                 section_level: int = 0,
                  the_license: str | set[str] | None = None):
         super().__init__(section_level, the_license)
         self.set_pop_indent_gap(True)
@@ -91,10 +96,13 @@ class MarkdownContent(TextContent):
     def add_label(self, label: str) -> None:
         self.add(f"({label.strip()})=")
 
-    def add_header(self, name, level=1, label=None) -> None:
+    def add_header(self,
+                   name: str,
+                   level: int = 0,
+                   label: Optional[str] = None) -> None:
         if label is not None:
             self.add_label(label)
-        self.add([f"{level * '#'} {name.strip()}", ""])
+        self.add([f"#{level * '#'} {name.strip()}", ""])
 
     def add_rubric(self, name: str) -> None:
         self.add(["```{eval-rst}", f".. rubric:: {name}", "```", ""])
@@ -125,10 +133,28 @@ class MarkdownContent(TextContent):
                          font_size: Optional[str | int] = None) -> None:
         if not rows:
             return
-        with self.directive("eval-rst"):
-            table = SphinxContent()
-            table.add_simple_table(rows, widths, font_size)
-            self.add(table)
+        if not widths and font_size is None:
+            escaped_rows: list[tuple[str, ...]] = []
+            maxi = tuple(map(len, rows[0]))
+            for row in rows:
+                escaped_row = tuple(cell.replace("|", "\\|") for cell in row)
+                escaped_rows.append(escaped_row)
+                row_lengths = tuple(map(len, escaped_row))
+                maxi = tuple(map(max, zip(maxi, row_lengths)))
+
+            # At least three dashes are required for a table
+            maxi = tuple(max(width, 3) for width in maxi)
+
+            sep = " | ".join(f"{'-' * width}" for width in maxi)
+            sep = f" | {sep} |"
+            lines = [_simple_row(escaped_rows[0], maxi), sep]
+            lines.extend(_simple_row(row, maxi) for row in escaped_rows[1:])
+            self.add(lines)
+        else:
+            with self.directive("eval-rst"):
+                table = SphinxContent()
+                table.add_simple_table(rows, widths, font_size)
+                self.add(table)
 
     def add_grid_table(self,
                        rows: Sequence[Iterable[str | int]],