Draft: Automatic XLSX export

Summary

Added a function to automatically export records from an Iterable to xlsx.
Addresses #143 / https://gitlab.indiscale.com/caosdb/customers/dimr/management/-/issues/269

Focus

Does this lack any features that are necessary and might have been missed during planning? Can this be used in the intended workflow?

Test Environment

Manual tests, ideally against test data I might not have available.
Additionally, if this needs to work on Windows and there is a working VM somewhere, this should probably also be tested there, as afaik NamedTemporaryFiles are somewhat error-prone on Win.

Check List for the Author

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate developer documentation
• Appropriate user documentation
• Tests (or not necessary)
• Annotations in code (Gitlab comments)

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?

src/caosadvancedtools/table_json_conversion/fill_xlsx.py

@@ -24,15 +24,16 @@ from __future__ import annotations
 
 import datetime
 import pathlib
+import warnings
 from types import SimpleNamespace
 from typing import Any, Optional, TextIO, Union
 from warnings import warn
 
-from jsonschema import FormatChecker, validate
 from jsonschema.exceptions import ValidationError
 from openpyxl import load_workbook, Workbook
 from openpyxl.cell.cell import ILLEGAL_CHARACTERS_RE
 
+from .validation_utils import _validate_jsonschema
 from .xlsx_utils import (
     array_schema_from_model_schema,
     get_foreign_key_columns,
@@ -354,15 +355,17 @@ validation_schema: dict, optional
 
     # Validation
     if validation_schema is not None:
-        validation_schema = array_schema_from_model_schema(read_or_dict(validation_schema))
+        # convert to array_schema if given schema is a model_schema
+        if 'properties' in validation_schema and validation_schema['properties'].values():
+            if list(validation_schema['properties'].values())[0]["type"] != "array":
+                validation_schema = array_schema_from_model_schema(read_or_dict(validation_schema))
         try:
-            # FIXME redefine checker for datetime
-            validate(data, validation_schema, format_checker=FormatChecker())
+            _validate_jsonschema(data, validation_schema)
         except ValidationError as verr:
             print(verr.message)
             raise verr
     else:
-        print("No validation schema given, continue at your own risk.")
+        warnings.warn("No validation schema given, continue at your own risk.")
 
     # Filling the data
     result_wb = load_workbook(template)

[I. Nüske]

Use datetime-compatible helper function instead.

[I. Nüske]

Changed to warnings.warn for filtering, and because the warnings in these files generally are done with warnings.warn. Should these also be replaced with logs?