ENH: xlsx template generator

Summary

Allows to create XLSX templates

Focus

Test Environment

unit test (including one for all dimr schemas which is to be removed)

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/caosadvancedtools/table_json_conversion/fill_xlsx.py

+#!/usr/bin/env python3
+# encoding: utf-8
+#
+# This file is a part of the LinkAhead Project.
+#
+# Copyright (C) 2024 Indiscale GmbH <info@indiscale.com>
+# Copyright (C) 2024 Henrik tom Wörden <h.tomwoerden@indiscale.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+from openpyxl import load_workbook
+
+from .table_generator import ColumnType, RowType
+
+
+def _fill_leaves(json_doc: dict, workbook):
+    for key, value in json_doc:
+        if not isinstance(value, list):
+            value = [value]
+        for el in value:
+            if isinstance(el, dict):
+                _fill_leaves(el, workbook)
+            workbook.cell(1, 2, el)
+
+
+def _get_row_type_column(worksheet):
+    for col in worksheet.columns:
+        for cell in col:
+            if cell.value == RowType.COL_TYPE.name:
+                return cell.column
+    raise ValueError("The column which defines row types (COL_TYPE, PATH, ...) is missing")
+
+
+def _get_path_rows(worksheet):
+    rows = []
+    rt_col = _get_row_type_column(worksheet)
+    for cell in list(worksheet.columns)[rt_col-1]:
+        print(cell.value)
+        if cell.value == RowType.PATH.name:
+            rows.append(cell.row)
+    return rows
+
+
+def _generate_path_col_mapping(workbook):
+    rt_col = _get_row_type_column(workbook)
+
+    for col in workbook.columns:
+        pass
+
+
+def fill_template(template_path: str, json_path: str, result_path: str) -> None:
+    """
+    Fill the contents of the JSON document stored at ``json_path`` into the template stored at
+    ``template_path`` and store the result under ``result_path``.
+    """
+    template = load_workbook(template_path)
+    # For each top level key in the json we iterate the values (if it is an array). Those are the
+    # root elements that belong to a particular sheet.
+    #       After treating a root element, the row index for the corresponding sheet needs to be
+    #       increased
+    #       When we finished treating an object that goes into a lower ranked sheet (see below), we
+    #       increase the row index of that sheet.
+    #
+
+    # We can generate a hierarchy of sheets in the beginning (using the paths). The lower sheets
+    # are for objects referenced by objects in higher ranked sheets.
+    # We can detect the sheet corresponding to a root element by looking at the first path element:
+    # The first path element must be the root element every where.
+    # Suggestion:
+    # row indices: Dict[str, int] string is the sheet name
+    # sheet_hirarchy: List[Tuple[str]]  elements are sheet names
+    #
+    # Question:
+    # We can create an internal representation where we assign as sheet_names the same names that
+    # are used in table generator. Or should we create another special row that contains this
+    # somehow?
+
+    template.save(result_path)

[Henrik tom Wörden]

This contains first steps towards an implementation that fills xlsx templates. Not part of this MR