Implement list_fill_paths for IMAS-Core (HDF5 backend)

Author: maarten-ic

imas/backends/imas_core/al_context.py

@@ -174,6 +174,17 @@ def list_all_occurrences(self, ids_name: str) -> List[int]:
             return list(occurrences)
         return []
 
+    def list_filled_paths(self, path: str) -> List[str]:
+        """List all filled paths in an IDS.
+
+        Args:
+            path: IDS and occurrence as a string: <IDS>[/<occurrence>]
+        """
+        status, result = ll_interface.list_filled_paths(self.ctx, path)
+        if status != 0:
+            raise LowlevelError(f"list filled paths for {path!r}", status)
+        return result
+
     def close(self):
         """Close this ALContext."""
         ll_interface.end_action(self.ctx)

imas/backends/imas_core/db_entry_al.py

@@ -365,7 +365,17 @@ def list_all_occurrences(self, ids_name: str) -> List[int]:
         return occurrence_list
 
     def list_filled_paths(self, ids_name: str, occurrence: int) -> List[str]:
-        raise NotImplementedError()
+        if self._db_ctx is None:
+            raise RuntimeError("Database entry is not open.")
+        ll_path = ids_name
+        if occurrence != 0:
+            ll_path += f"/{occurrence}"
+        paths = self._db_ctx.list_filled_paths(ll_path)
+        if not paths:
+            raise DataEntryException(
+                f"IDS {ids_name!r}, occurrence {occurrence} is empty."
+            )
+        return paths
 
     def _check_uda_warnings(self, lazy: bool) -> None:
         """Various checks / warnings for the UDA backend."""

imas/backends/imas_core/imas_interface.py

@@ -166,6 +166,11 @@ def begin_timerange_action(
     ):
         raise self._minimal_version("5.4")
 
+    # New method in AL 5.7
+
+    def list_filled_paths(self, ctx, path):
+        raise self._minimal_version("5.7")
+
 
 # Dummy documentation for interface:
 for funcname in dir(LowlevelInterface):

imas/test/test_list_filled_paths.py

@@ -1,13 +1,13 @@
 import pytest
 
 import imas
-from imas.backends.imas_core.imas_interface import ll_interface
+from imas_core import _al_lowlevel
 from imas.exception import DataEntryException
 from imas.ids_defs import IDS_TIME_MODE_HOMOGENEOUS, IDS_TIME_MODE_INDEPENDENT
 
 
-if not hasattr(ll_interface, "list_all_occurrences"):
-    marker = pytest.mark.xfail(reason="list_all_occurrences not available in imas_core")
+if not hasattr(_al_lowlevel, "al_list_filled_paths"):
+    marker = pytest.mark.xfail(reason="list_filled_paths not available in imas_core")
 else:
     marker = []
 
@@ -61,6 +61,9 @@ def test_list_filled_paths(testuri):
         # Other occurrence should still raise an error:
         with pytest.raises(DataEntryException):
             dbentry.list_filled_paths("core_profiles", 1)
+        # Until we write data to the occurrence:
+        dbentry.put(cp, 3)
+        assert set(filled_paths) == set(dbentry.list_filled_paths("core_profiles", 3))
 
 
 def test_list_filled_paths_autoconvert(testuri):