Add to existing model

Summary

Adding the YAML model to an existing data model.

Focus

No unexpected other behaviour? Does it do what it should?

Test Environment

pytest unittests/ -k existing_model

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 #110 (closed)
• 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/models/parser.py

@@ -140,18 +140,18 @@ class JsonSchemaDefinitionError(RuntimeError):
         super().__init__(msg)
 
 
-def parse_model_from_yaml(filename):
+def parse_model_from_yaml(filename, existing_model=None):
     """Shortcut if the Parser object is not needed."""
     parser = Parser()
 
-    return parser.parse_model_from_yaml(filename)
+    return parser.parse_model_from_yaml(filename, existing_model=existing_model)
 
 
-def parse_model_from_string(string):
+def parse_model_from_string(string, existing_model=None):
     """Shortcut if the Parser object is not needed."""
     parser = Parser()
 
-    return parser.parse_model_from_string(string)
+    return parser.parse_model_from_string(string, existing_model=existing_model)
 
 
 def parse_model_from_json_schema(
@@ -207,7 +207,7 @@ class Parser(object):
         self.model = {}
         self.treated = []
 
-    def parse_model_from_yaml(self, filename):
+    def parse_model_from_yaml(self, filename, existing_model=None):
         """Create and return a data model from the given file.
 
         Parameters
@@ -223,9 +223,9 @@ class Parser(object):
         with open(filename, 'r') as outfile:
             ymlmodel = yaml.load(outfile, Loader=SafeLineLoader)
 
-        return self._create_model_from_dict(ymlmodel)
+        return self._create_model_from_dict(ymlmodel, existing_model=existing_model)
 
-    def parse_model_from_string(self, string):
+    def parse_model_from_string(self, string, existing_model=None):
         """Create and return a data model from the given YAML string.
 
         Parameters
@@ -240,9 +240,9 @@ class Parser(object):
         """
         ymlmodel = yaml.load(string, Loader=SafeLineLoader)
 
-        return self._create_model_from_dict(ymlmodel)
+        return self._create_model_from_dict(ymlmodel, existing_model=existing_model)
 
-    def _create_model_from_dict(self, ymlmodel):
+    def _create_model_from_dict(self, ymlmodel, existing_model=None):
         """Create and return a data model out of the YAML dict `ymlmodel`.
 
         Parameters
@@ -250,6 +250,9 @@ class Parser(object):
         ymlmodel : dict
           The dictionary parsed from a YAML file.
 
+        existing_model : dict, optional
+          An existing model to which the ymlmodel shall be added.
+
         Returns
         -------
         out : DataModel
@@ -259,6 +262,9 @@ class Parser(object):
         if not isinstance(ymlmodel, dict):
             raise ValueError("Yaml file should only contain one dictionary!")
 
+        if existing_model is not None:
+            self.model.update(existing_model)
+
         # Extern keyword:
         # The extern keyword can be used to include Properties and RecordTypes
         # from existing CaosDB datamodels into the current model.