Draft: ENH: file system: core

Summary

Insert a meaningful description for this merge request here: What is the new/changed behavior? Which bug has been fixed? Are there related issues?

Focus

Point the reviewer to the core of the code change. Where should they start reading? What should they focus on (e.g. security, performance, maintainability, user-friendliness, compliance with the specs, finding more corner cases, concrete questions)?

Test Environment

How to set up a test environment for manual testing?

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)
• 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/apiutils.py

@@ -381,7 +381,10 @@ def _single_convert_to_python_object(robj, entity):
     return robj
 
 
-def _single_convert_to_entity(entity, robj, **kwargs):
+def _single_convert_to_entity(entity, robj, recursive_depth, **kwargs):
+    """
+    recursive_depth: disabled if 0
+    """
     if robj._id is not None:
         entity.id = robj._id
 
@@ -407,16 +410,16 @@ def _single_convert_to_entity(entity, robj, **kwargs):
             else:
                 entity.add_parent(id=parent)
 
-    def add_property(entity, prop, name, recursive=False, datatype=None):
+    def add_property(entity, prop, name, _recursive=False, datatype=None):
         if datatype is None:
-            raise ArgumentError("datatype must not be None")
+            raise RuntimeError("Datatype must not be None.")
 
         if isinstance(prop, CaosDBPythonEntity):
             entity.add_property(name=name, value=str(
                 prop._id), datatype=datatype)
 
-            if recursive and not prop.do_not_expand:
-                return convert_to_entity(prop, recursive=recursive)
+            if _recursive and not prop.do_not_expand:
+                return convert_to_entity(prop, recursive=_recursive)
             else:
                 return []
         else:
@@ -426,6 +429,11 @@ def _single_convert_to_entity(entity, robj, **kwargs):
 
             return []
 
+    if recursive_depth == 0:
+        recursive = False
+    else:
+        recursive = True
+
     for prop in robj._properties:
         value = robj.__getattribute__(prop)
 
@@ -439,7 +447,7 @@ def _single_convert_to_entity(entity, robj, **kwargs):
 
                         if recursive and not v.do_not_expand:
                             children.append(convert_to_entity(
-                                v, recursive=recursive))
+                                v, recursive=recursive_depth-1))
                     else:
                         if isinstance(v, float) or isinstance(v, int):
                             lst.append(str(v))