F refactor high level api

Summary

This is a new version of the old high level API that was previously contained in apiutils. I completely refactored the structure of the entities, to make use of more up-to-date concepts:

• Usage can be completely offline now (including resolving references), e.g. without a running CaosDB which also allows for comprehensive unit tests.
• Clear separation between resolved and unresolved Entities.
• Transparent yaml serialization and deserialization
• Planned: Transparent support for multi properties.

The main motivation for reactivating and refactoring this module was to facilitate usage of complex entities wihtin simulations and data analysis scripts.

Please also see the included documentation (to be expanded) and lots of unit tests with examples.

Note: This MR includes commits from f-plantuml, f-merge-entities and f-copy-entity, so please review the corresponding MRs first.

Test Environment

There are many unit tests supplied.

Please also test the resolve functions e.g. CaosDBPythonEntity.resolve_references() manually.

Integration tests will be handed in in a later release.

I recommend at least two independent reviewers and this MR is of course still open for discussions and suggestions.

Check List for the Author

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• 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)
• 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/caosdb/high_level_api.py

@@ -78,6 +78,20 @@ def standard_type_for_high_level_type(high_level_record: "CaosDBPythonEntity",
     raise RuntimeError("Incompatible type.")
 
 
+def high_level_type_for_role(role: str):
+    if role == "Record":
+        return CaosDBPythonRecord
+    if role == "File":
+        return CaosDBPythonFile
+    if role == "Property":
+        return CaosDBPythonProperty
+    if role == "RecordType":
+        return CaosDBPythonRecordType
+    if role == "Entity":
+        return CaosDBPythonEntity
+    raise RuntimeError("Unknown role.")
+    
+
 def high_level_type_for_standard_type(standard_record: db.Entity):
     if type(standard_record) == db.Record:
         return CaosDBPythonRecord
@@ -586,8 +600,13 @@ class CaosDBPythonEntity(object):
         return [p for p in self.__dict__
                 if p not in self._forbidden]
 
-    def deserialize(self, serialization: dict):
-        raise NotImplementedError()
+    @staticmethod
+    def deserialize(serialization: dict):
+        """
+        Deserialize a yaml representation of an entity in high level API form.
+        """
+        pass
+        
 
     def serialize(self, without_metadata: bool = False):
         """
@@ -605,7 +624,7 @@ class CaosDBPythonEntity(object):
         fulldict = dict()
 
         # Add CaosDB role:
-        
+        fulldict["role"] = standard_type_for_high_level_type(self, True)
 
         for parent in self._parents:
             if isinstance(parent, CaosDBPythonEntity):