✨ Added 'tree' to Folder class

Author: kzscisoft

simvue/api/objects/folder.py

@@ -7,7 +7,6 @@
 
 """
 
-import pathlib
 import typing
 import datetime
 import json
@@ -72,6 +71,7 @@ def __init__(self, identifier: str | None = None, **kwargs) -> None:
             any additional arguments to be passed to the object initialiser
         """
         super().__init__(identifier, **kwargs)
+        self._properties.remove("tree")
 
     @classmethod
     @pydantic.validate_call
@@ -101,6 +101,32 @@ def get(
 
         return super().get(count=count, offset=offset, **_params)
 
+    @property
+    def tree(self) -> dict[str, object]:
+        """Return hierarchy for this folder.
+
+        Returns
+        -------
+        dict
+            a nested dictionary describing the hierarchy
+        """
+        _level: int = len(self.path.split("/"))
+        _folders = self.__class__.get(
+            filters=json.dumps([f"path contains {self.path}"])
+        )
+        _paths = [folder.path.split("/") for _, folder in _folders]
+        _paths = sorted(_paths, key=len)
+        _out_dict: dict[str, object] = {}
+        _modifier = None
+        for path in _paths:
+            if len(path) <= _level:
+                continue
+            _modifier = _out_dict
+            for element in path[1:]:
+                _modifier.setdefault(element, {})
+                _modifier = _modifier[element]
+        return _out_dict
+
     @property
     @staging_check
     def tags(self) -> list[str]:
@@ -115,7 +141,7 @@ def tags(self, tags: list[str]) -> None:
         self._staging["tags"] = tags
 
     @property
-    def path(self) -> pathlib.Path:
+    def path(self) -> str:
         """Return the path of this folder"""
         return self._get_attribute("path")
 

tests/unit/test_folder.py

@@ -147,3 +147,19 @@ def test_folder_get_properties() -> None:
 
     if _failed:
         raise AssertionError("\n" + "\n\t- ".join(": ".join(i) for i in _failed))
+
+
+@pytest.mark.api
+@pytest.mark.online
+def test_folder_tree() -> None:
+    N_FOLDERS: int = 10
+    _uuid: str = f"{uuid.uuid4()}".split("-")[0]
+    _root_folder_path: str = f"/simvue_unit_testing/objects/folder/{_uuid}"
+    for i in range(N_FOLDERS):
+        _path = f"{_root_folder_path}/test_folder_tree_{i}"
+        _folder = Folder.new(path=_path)
+        _folder.commit()
+    _, _root_folder = next(Folder.get(filters=json.dumps([f"path == {_root_folder_path}"])))
+    assert len(_root_folder.tree["simvue_unit_testing"]["objects"]["folder"][_uuid]) == N_FOLDERS
+    _root_folder.delete(recursive=True)
+