Update HDF5 browser: improved tree view layout, multiple file support

Author: PierreRaybaut

.vscode/launch.json

@@ -13,12 +13,15 @@
             "envFile": "${workspaceFolder}/.env",
             "python": "${config:python.defaultInterpreterPath}",
             "justMyCode": false,
-            // "args": [
-            //     "${workspaceFolder}/cdl/data/tests/reordering_test.h5",
-            // ],
+            "args": [
+                // "--h5browser",
+                // "${workspaceFolder}/cdl/data/tests/empty.h5"
+                // "${workspaceFolder}/cdl/data/tests/reordering_test.h5",
+                // "${workspaceFolder}/cdl/data/tests/reordering_test.h5,/DataLab_Sig/g001: /s003: wiener(s002)/xydata",
+            ],
             "env": {
                 // "DEBUG": "1",
-                // "LANG": "en",
+                "LANG": "en",
                 "QT_COLOR_MODE": "light",
             }
         },
@@ -59,8 +62,8 @@
             "env": {
                 // "DEBUG": "1",
                 // "TEST_SEGFAULT_ERROR": "1",
-                // "LANG": "en",
-                // "QT_COLOR_MODE": "light",
+                "LANG": "en",
+                "QT_COLOR_MODE": "light",
             }
         },
         {
@@ -80,6 +83,8 @@
             ],
             "env": {
                 // "DEBUG": "1",
+                "LANG": "en",
+                "QT_COLOR_MODE": "light",
             }
         },
         {

CHANGELOG.md

@@ -14,11 +14,13 @@ for future and past milestones.
   * Editable parameters: number of bins, lower and upper bounds
 * HDF5 browser:
   * Improved tree view layout (more compact and readable)
+  * Multiple files can now be opened at once, using the file selection dialog box
   * Added tabs with information below the graphical preview:
     * Group info: path, textual preview, etc.
     * Attributes info: name, value
   * Added "Show only supported data" check box: when checked, only supported data
     (signals and images) are shown in the tree view
+  * Added "Show values" check box, to show/hide the values in the tree view
 * Macro Panel:
   * Macro commands are now numbered, starting from 1, like signals and images
 * Remote control API (`RemoteProxy` and `LocalProxy`):

cdl/core/gui/h5io.py

@@ -70,11 +70,15 @@ def open_file(self, filename: str, import_all: bool, reset_all: bool) -> None:
                 # KeyError was encoutered when deserializing datasets (DataLab data
                 # model is not compatible with this version)
                 progress.close()
-            self.import_file(filename, import_all, reset_all)
+            self.import_files([filename], import_all, reset_all)
 
     def __add_object_from_node(self, node: BaseNode) -> None:
         """Add DataLab object from h5 node"""
         obj = node.get_native_object()
+        if obj is None:
+            # TODO: Add a warning message to be shown after all imports?
+            # (e.g. "No supported data available in HDF5 file(s)."
+            return
         self.uint32_wng = self.uint32_wng or node.uint32_wng
         if isinstance(obj, SignalObj):
             self.mainwindow.signalpanel.add_object(obj)
@@ -88,39 +92,46 @@ def __eventually_show_warnings(self) -> None:
                 self.mainwindow, _("Warning"), _("Clipping uint32 data to int32.")
             )
 
-    def import_file(self, filename: str, import_all: bool, reset_all: bool) -> None:
-        """Import HDF5 file"""
+    def import_files(
+        self, filenames: list[str], import_all: bool, reset_all: bool
+    ) -> None:
+        """Import HDF5 files"""
         h5browser = H5BrowserDialog(self.mainwindow)
-
-        with qt_try_loadsave_file(self.mainwindow, filename, "load"):
-            h5browser.setup(filename)
-            if execenv.unattended:
-                # Unattended mode: import all datasets (for testing)
-                import_all = True
-            if not import_all and not exec_dialog(h5browser):
-                h5browser.cleanup()
-                return
-            if import_all:
-                nodes = h5browser.get_all_nodes()
-            else:
-                nodes = h5browser.get_nodes()
-            if nodes is None:
-                h5browser.cleanup()
-                return
-            if reset_all:
-                self.mainwindow.reset_all()
-            with create_progress_bar(
-                self.mainwindow, self.__progbartitle(filename), len(nodes)
-            ) as progress:
+        for filename in filenames:
+            with qt_try_loadsave_file(self.mainwindow, filename, "load"):
+                h5browser.open_file(filename)
+        if h5browser.is_empty():
+            if not execenv.unattended:
+                QW.QMessageBox.warning(
+                    self.mainwindow,
+                    _("Warning"),
+                    _("No supported data available in HDF5 file(s)."),
+                )
+            return
+        if execenv.unattended:
+            # Unattended mode: import all datasets (for testing)
+            import_all = True
+        if not import_all and not exec_dialog(h5browser):
+            return
+        if import_all:
+            nodes = h5browser.get_all_nodes()
+        else:
+            nodes = h5browser.get_nodes()
+        if nodes is None:
+            return
+        if reset_all:
+            self.mainwindow.reset_all()
+        with qt_try_loadsave_file(self.mainwindow, "*.h5", "load"):
+            with create_progress_bar(self.mainwindow, "", len(nodes)) as progress:
                 self.uint32_wng = False
                 for idx, node in enumerate(nodes):
+                    progress.setLabelText(self.__progbartitle(node.h5file.filename))
                     progress.setValue(idx + 1)
                     QW.QApplication.processEvents()
                     if progress.wasCanceled():
                         break
                     self.__add_object_from_node(node)
-            h5browser.cleanup()
-            self.__eventually_show_warnings()
+        self.__eventually_show_warnings()
 
     def import_dataset_from_file(self, filename: str, dsetname: str) -> None:
         """Import dataset from HDF5 file"""

cdl/core/gui/main.py

@@ -422,10 +422,10 @@ def add_label_with_title(
     def run_macro(self, number_or_title: int | str | None = None) -> None:
         """Run macro.
 
-       Args:
-            number: Number of the macro (starting at 1). Defaults to None (run
-             current macro, or does nothing if there is no macro).
-         """
+        Args:
+             number: Number of the macro (starting at 1). Defaults to None (run
+              current macro, or does nothing if there is no macro).
+        """
         self.macropanel.run_macro(number_or_title)
 
     @remote_controlled
@@ -1327,11 +1327,19 @@ def open_h5_files(
             basedir = Conf.main.base_dir.get()
             with qth.save_restore_stds():
                 h5files, _fl = getopenfilenames(self, _("Open"), basedir, "HDF5 (*.h5)")
+        filenames, dsetnames = [], []
         for fname_with_dset in h5files:
             if "," in fname_with_dset:
                 filename, dsetname = fname_with_dset.split(",")
+                dsetnames.append(dsetname)
             else:
-                filename, dsetname = fname_with_dset, None
+                filename = fname_with_dset
+                dsetnames.append(None)
+            filenames.append(filename)
+        if import_all is None and all([dsetname is None for dsetname in dsetnames]):
+            self.browse_h5_files(filenames, reset_all)
+            return
+        for filename, dsetname in zip(filenames, dsetnames):
             if import_all is None and dsetname is None:
                 self.import_h5_file(filename, reset_all)
             else:
@@ -1343,6 +1351,20 @@ def open_h5_files(
                         self.h5inputoutput.import_dataset_from_file(filename, dsetname)
             reset_all = False
 
+    def browse_h5_files(self, filenames: list[str], reset_all: bool) -> None:
+        """Browse HDF5 files
+
+        Args:
+            filenames (list): HDF5 filenames
+            reset_all (bool): Reset all application data before importing
+
+        Returns:
+            None
+        """
+        for filename in filenames:
+            self.__check_h5file(filename, "load")
+        self.h5inputoutput.import_files(filenames, False, reset_all)
+
     @remote_controlled
     def import_h5_file(self, filename: str, reset_all: bool | None = None) -> None:
         """Import HDF5 file into DataLab
@@ -1357,7 +1379,7 @@ def import_h5_file(self, filename: str, reset_all: bool | None = None) -> None:
         """
         with qth.qt_try_loadsave_file(self, filename, "load"):
             filename = self.__check_h5file(filename, "load")
-            self.h5inputoutput.import_file(filename, False, reset_all)
+            self.h5inputoutput.import_files([filename], False, reset_all)
 
     # This method is intentionally *not* remote controlled
     # (see TODO regarding RemoteClient.add_object method)

cdl/core/io/h5/common.py

@@ -147,7 +147,7 @@ def __init__(self, filename):
         self.h5file = h5py.File(filename)
         self.__nodes = {}
         self.root = RootNode(self.h5file)
-        self.__nodes[self.root.id] = self.root.dset
+        self.__nodes[self.root.id] = self.root
         self.root.collect_children(self.__nodes)
         NODE_FACTORY.run_post_triggers(self)