F simple schema export

Summary

For https://gitlab.indiscale.com/caosdb/customers/dimr/management/-/issues/37. Export RecordTypes to jsonschema, e.g., for web form generation. Part 1, only primitive datatypes and lists of primitives.

Focus

The main magic is in the construction of the schemas for properties. Also check whether patterns and formats are handled well.

Test Environment

Unit tests should be sufficient, but feel free to test it on the RT of your choice.

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/json_schema_exporter.py

@@ -21,47 +21,31 @@
 #
 
 import re
+from typing import Optional
 
 import linkahead as db
+from linkahead.common.datatype import is_list_datatype, get_list_datatype
 
 
 def _make_required_list(rt: db.RecordType):
     """Return the list of names of properties with importance db.OBLIGATORY."""
-    required = []
-    for prop in rt.properties:
-        importance = rt.get_importance(prop.name)
-        if importance == db.OBLIGATORY:
-            required.append(prop.name)
-    return required
-
-
-def _extract_elemet_dtyp_from_list_dtype(list_dtype):
-
-    if not list_dtype.lower().startswith("list"):
+    return [prop.name for prop in rt.properties
+            if rt.get_importance(prop.name) == db.OBLIGATORY]
 
-        raise ValueError(f"Not a list dtype: {list_dtype}")
 
-    pattern = r"^[Ll][Ii][Ss][Tt](<(?P<dtype1>.*)>|\((?P<dtype2>.*)\))$"
-    comp = re.compile(pattern)
-    mtch = comp.match(list_dtype)
-    if mtch is None:
+def _make_prop_from_prop(prop: db.Property, additional_options_for_text_props: Optional[dict]):
+    """Return the JSON Schema segment for the given property
 
-        raise ValueError(f"Not a list dtype: {list_dtype}")
-
-    elif "dtype1" in mtch.groupdict() and mtch.groupdict()["dtype1"] is not None:
-        return mtch.groupdict()["dtype1"]
-
-    elif "dtype2" in mtch.groupdict() and mtch.groupdict()["dtype2"] is not None:
-        return mtch.groupdict()["dtype2"]
-
-    else:
-        raise ValueError(f"Not a list dtype: {list_dtype}")
-
-
-def _make_prop_from_prop(prop, additional_options_for_text_props):
+    Parameters
+    ----------
+    prop : db.Property
+           the property to be transformed
+    additional_options_for_text_props : Optional[dict]
+                                        dict that may contain the keys 'pattern' and 'format' to
+                                        further define the rules for the JSON Schema segment
+    """
 
     if prop.is_reference():
-
         raise NotImplementedError(
             "Reference properties are not supported in this version of the json schema exporter."
         )
@@ -69,11 +53,11 @@ def _make_prop_from_prop(prop, additional_options_for_text_props):
     if prop.datatype == db.TEXT or prop.datatype == db.DATETIME:
         text_format = None
         text_pattern = None
-        if prop.name in additional_options_for_text_props:
-            if "pattern" in additional_options_for_text_props[prop.name]:
-                text_pattern = additional_options_for_text_props[prop.name]["pattern"]
-            if "format" in additional_options_for_text_props[prop.name]:
-                text_format = additional_options_for_text_props[prop.name]["format"]
+        if additional_options_for_text_props:
+            if "pattern" in additional_options_for_text_props:
+                text_pattern = additional_options_for_text_props["pattern"]
+            if "format" in additional_options_for_text_props:
+                text_format = additional_options_for_text_props["format"]
             elif prop.datatype == db.DATETIME:
                 # Set the date or datetime format if only a pattern is given ...
                 text_format = ["date", "date-time"]
@@ -94,10 +78,10 @@ def _make_prop_from_prop(prop, additional_options_for_text_props):
         json_prop["type"] = "integer"
     elif prop.datatype == db.DOUBLE:
         json_prop["type"] = "number"
-    elif isinstance(prop.datatype, str) and prop.datatype.startswith("LIST"):
+    elif is_list_datatype(prop.datatype):
         json_prop["type"] = "array"
         list_element_prop = db.Property(
-            name=prop.name, datatype=_extract_elemet_dtyp_from_list_dtype(prop.datatype))
+            name=prop.name, datatype=get_list_datatype(prop.datatype, strict=True))
         json_prop["items"] = _make_prop_from_prop(
             list_element_prop, additional_options_for_text_props)
     else:
@@ -127,7 +111,7 @@ def _make_text_property(description="", text_format=None, text_pattern=None):
 
 def recordtype_to_json_schema(rt: db.RecordType, additional_properties: bool = True,
                               name_and_description_in_properties: bool = False,
-                              additional_options_for_text_props: dict = {}):
+                              additional_options_for_text_props: Optional[dict] = None):
     """Create a jsonschema from a given RecordType that can be used, e.g., to
     validate a json specifying a record of the given type.
 
@@ -152,6 +136,9 @@ def recordtype_to_json_schema(rt: db.RecordType, additional_properties: bool = T
 
     """
 
+    if additional_options_for_text_props is None:
+        additional_options_for_text_props = {}
+
     schema = {
         "$schema": "https://json-schema.org/draft/2019-09/schema",
         "type": "object"
@@ -176,7 +163,9 @@ def recordtype_to_json_schema(rt: db.RecordType, additional_properties: bool = T
                 "Creating a schema for multi-properties is not specified. "
                 f"Property {prop.name} occurs more than once."
             )
-        props[prop.name] = _make_prop_from_prop(prop, additional_options_for_text_props)
+        props[prop.name] = _make_prop_from_prop(prop, additional_options_for_text_props[prop.name]
+                                                if prop.name in additional_options_for_text_props
+                                                else None)
 
     schema["properties"] = props
     return schema