ENH: JsonSchemaExporter accepts do_not_create parameter.

Summary

• DataModel.get_deep(name: str)
• Refactoring of json schema exporter.
• New parameter for json schema exporter.

Look at the new test function, this should explain the meaning.

Please do not delete the source branch after merging, we will probably still need it.

Focus

Does the get_deep() function look reasonable?

Test Environment

Run the unit tests, especially pytest unittests/test_json_schema_exporter.py -k options

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 caosdb/customers/dimr/management#65
• 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

@@ -22,7 +22,7 @@
 """Module for converting a data model into a json schema compatible dictionary.
 """
 
-from typing import Any, Optional
+from typing import Any, List, Optional
 
 import linkahead as db
 from linkahead.common.datatype import get_list_datatype, is_list_datatype
 
 
 class JsonSchemaExporter:
     """A class which collects everything needed for the conversion.
@@ -36,4+36,4 @@
                  name_and_description_in_properties: bool = False,
                  additional_options_for_text_props: dict = None,
                  units_in_description: bool = True,
-                 do_not_create: list[str] = None,
+                 do_not_create: List[str] = None,
                  ):
         """Set up a JsonSchemaExporter, which can then be applied on RecordTypes.
 
@@ -210,7+210,7 @@
             if val.name:
                 vals.append(f"{val.id}, {val.name}")
             else:
                 vals.append(f"{val.id}")
 
         return vals
 
@@ -272,7+272,7 @@
                               name_and_description_in_properties: bool = False,
                               additional_options_for_text_props: Optional[dict] = None,
                               units_in_description: bool = True,
-                              do_not_create: list[str] = None):
+                              do_not_create: List[str] = 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.