Fix console freeze when loading/saving HDF5 files from internal console

Fixes #275

(cherry picked from commit 08d4012)

Author: PierreRaybaut

datalab/control/baseproxy.py

@@ -206,6 +206,41 @@ def import_h5_file(self, filename: str, reset_all: bool | None = None) -> None:
             reset_all: Reset all application data. Defaults to None.
         """
 
+    @abc.abstractmethod
+    def load_h5_workspace(self, h5files: list[str], reset_all: bool = False) -> None:
+        """Load native DataLab HDF5 workspace files without any GUI elements.
+
+        This method can be safely called from scripts (e.g., internal console,
+        macros) as it does not create any Qt widgets, dialogs, or progress bars.
+
+        .. warning::
+
+            This method only supports native DataLab HDF5 files. For importing
+            arbitrary HDF5 files (non-native), use :meth:`open_h5_files` or
+            :meth:`import_h5_file` instead.
+
+        Args:
+            h5files: List of native DataLab HDF5 filenames
+            reset_all: Reset all application data before importing. Defaults to False.
+
+        Raises:
+            ValueError: If a file is not a valid native DataLab HDF5 file
+        """
+
+    @abc.abstractmethod
+    def save_h5_workspace(self, filename: str) -> None:
+        """Save current workspace to a native DataLab HDF5 file without GUI elements.
+
+        This method can be safely called from scripts (e.g., internal console,
+        macros) as it does not create any Qt widgets, dialogs, or progress bars.
+
+        Args:
+            filename: HDF5 filename to save to
+
+        Raises:
+            IOError: If file cannot be saved
+        """
+
     @abc.abstractmethod
     def load_from_files(self, filenames: list[str]) -> None:
         """Open objects from files in current panel (signals/images).

datalab/control/proxy.py

@@ -300,6 +300,38 @@ def add_annotations_from_items(
         """
         self._datalab.add_annotations_from_items(items, refresh_plot, panel)
 
+    def load_h5_workspace(
+        self, h5files: list[str] | str, reset_all: bool = True
+    ) -> None:
+        """Load HDF5 workspace files without showing file dialog.
+
+        This method loads one or more DataLab native HDF5 files directly, bypassing
+        the file dialog. It is safe to call from the internal console or any context
+        where Qt dialogs would cause threading issues.
+
+        Args:
+            h5files: Path(s) to HDF5 file(s). Can be a single path string or a list
+             of paths
+            reset_all: If True (default), reset workspace before loading.
+             If False, append to existing workspace
+
+        Raises:
+            ValueError: if file is not a DataLab native HDF5 file
+        """
+        self._datalab.load_h5_workspace(h5files, reset_all)
+
+    def save_h5_workspace(self, filename: str) -> None:
+        """Save workspace to HDF5 file without showing file dialog.
+
+        This method saves the current workspace to a DataLab native HDF5 file
+        directly, bypassing the file dialog. It is safe to call from the internal
+        console or any context where Qt dialogs would cause threading issues.
+
+        Args:
+            filename: Path to the output HDF5 file
+        """
+        self._datalab.save_h5_workspace(filename)
+
 
 @contextmanager
 def proxy_context(what: str) -> Generator[LocalProxy | RemoteProxy, None, None]:

datalab/control/remote.py

@@ -99,6 +99,8 @@ class RemoteServer(QC.QThread):
     SIG_SAVE_TO_H5 = QC.Signal(str)
     SIG_OPEN_H5 = QC.Signal(list, bool, bool)
     SIG_IMPORT_H5 = QC.Signal(str, bool)
+    SIG_LOAD_H5_WORKSPACE = QC.Signal(list, bool)
+    SIG_SAVE_H5_WORKSPACE = QC.Signal(str)
     SIG_CALC = QC.Signal(str, object)
     SIG_RUN_MACRO = QC.Signal(str)
     SIG_STOP_MACRO = QC.Signal(str)
@@ -133,6 +135,8 @@ def __init__(self, win: DLMainWindow) -> None:
         self.SIG_SAVE_TO_H5.connect(win.save_to_h5_file)
         self.SIG_OPEN_H5.connect(win.open_h5_files)
         self.SIG_IMPORT_H5.connect(win.import_h5_file)
+        self.SIG_LOAD_H5_WORKSPACE.connect(win.load_h5_workspace)
+        self.SIG_SAVE_H5_WORKSPACE.connect(win.save_h5_workspace)
         self.SIG_CALC.connect(win.calc)
         self.SIG_RUN_MACRO.connect(win.run_macro)
         self.SIG_STOP_MACRO.connect(win.stop_macro)
@@ -297,6 +301,37 @@ def import_h5_file(self, filename: str, reset_all: bool | None = None) -> None:
         reset_all = False if reset_all is None else reset_all
         self.SIG_IMPORT_H5.emit(filename, reset_all)
 
+    @remote_call
+    def load_h5_workspace(self, h5files: list[str], reset_all: bool = False) -> None:
+        """Load native DataLab HDF5 workspace files without any GUI elements.
+
+        This method can be safely called from scripts as it does not create
+        any Qt widgets, dialogs, or progress bars.
+
+        Args:
+            h5files: List of native DataLab HDF5 filenames
+            reset_all: Reset all application data before importing. Defaults to False.
+
+        Raises:
+            ValueError: If a file is not a valid native DataLab HDF5 file
+        """
+        self.SIG_LOAD_H5_WORKSPACE.emit(h5files, reset_all)
+
+    @remote_call
+    def save_h5_workspace(self, filename: str) -> None:
+        """Save current workspace to a native DataLab HDF5 file without GUI elements.
+
+        This method can be safely called from scripts as it does not create
+        any Qt widgets, dialogs, or progress bars.
+
+        Args:
+            filename: HDF5 filename to save to
+
+        Raises:
+            IOError: If file cannot be saved
+        """
+        self.SIG_SAVE_H5_WORKSPACE.emit(filename)
+
     @remote_call
     def load_from_files(self, filenames: list[str]) -> None:
         """Open objects from files in current panel (signals/images).

datalab/gui/h5io.py

@@ -54,6 +54,31 @@ def save_file(self, filename: str) -> None:
             panel.serialize_to_hdf5(writer)
         writer.close()
 
+    def open_file_headless(self, filename: str, reset_all: bool) -> bool:
+        """Open native DataLab HDF5 file without any GUI elements.
+
+        This method can be safely called from any thread (e.g., the console thread)
+        as it does not create any Qt widgets or dialogs.
+
+        Args:
+            filename: HDF5 filename
+            reset_all: Reset all application data before importing
+
+        Returns:
+            True if file was successfully opened as a native DataLab file,
+            False if the file format is not compatible (KeyError was raised)
+        """
+        try:
+            reader = NativeH5Reader(filename)
+            if reset_all:
+                self.mainwindow.reset_all()
+            for panel in self.mainwindow.panels:
+                panel.deserialize_from_hdf5(reader, reset_all)
+            reader.close()
+            return True
+        except KeyError:
+            return False
+
     def open_file(self, filename: str, import_all: bool, reset_all: bool) -> None:
         """Open HDF5 file"""
         progress = None

datalab/gui/main.py

@@ -1474,6 +1474,10 @@ def set_modified(self, state: bool = True) -> None:
             title += f" [{datalab.__version__}]"
         self.setWindowTitle(title)
 
+    def is_modified(self) -> bool:
+        """Return True if mainwindow is modified"""
+        return self.__is_modified
+
     def __add_dockwidget(self, child, title: str) -> QW.QDockWidget:
         """Add QDockWidget and toggleViewAction"""
         dockwidget, location = child.create_dockwidget(title)
@@ -1683,9 +1687,7 @@ def save_to_h5_file(self, filename=None) -> None:
             if not filename:
                 return
         with qth.qt_try_loadsave_file(self, filename, "save"):
-            filename = self.__check_h5file(filename, "save")
-            self.h5inputoutput.save_file(filename)
-            self.set_modified(False)
+            self.save_h5_workspace(filename)
 
     @remote_controlled
     def open_h5_files(
@@ -1791,6 +1793,59 @@ def browse_h5_files(self, filenames: list[str], reset_all: bool) -> None:
             self.__check_h5file(filename, "load")
         self.h5inputoutput.import_files(filenames, False, reset_all)
 
+    @remote_controlled
+    def load_h5_workspace(self, h5files: list[str], reset_all: bool = False) -> None:
+        """Load native DataLab HDF5 workspace files without any GUI elements.
+
+        This method can be safely called from the internal console as it does not
+        create any Qt widgets, dialogs, or progress bars. It is designed for
+        programmatic use when loading DataLab workspace files.
+
+        .. warning::
+
+            This method only supports native DataLab HDF5 files. For importing
+            arbitrary HDF5 files (non-native), use the GUI menu or macros with
+            :class:`datalab.control.proxy.RemoteProxy`.
+
+        Args:
+            h5files: List of native DataLab HDF5 filenames
+            reset_all: Reset all application data before importing. Defaults to False.
+
+        Raises:
+            ValueError: If a file is not a valid native DataLab HDF5 file
+        """
+        for idx, filename in enumerate(h5files):
+            filename = self.__check_h5file(filename, "load")
+            success = self.h5inputoutput.open_file_headless(
+                filename, reset_all=(reset_all and idx == 0)
+            )
+            if not success:
+                raise ValueError(
+                    f"File '{filename}' is not a native DataLab HDF5 file. "
+                    f"Use the GUI menu or a macro with RemoteProxy to import "
+                    f"arbitrary HDF5 files."
+                )
+        # Refresh panel trees after loading
+        self.repopulate_panel_trees()
+
+    @remote_controlled
+    def save_h5_workspace(self, filename: str) -> None:
+        """Save current workspace to a native DataLab HDF5 file without GUI elements.
+
+        This method can be safely called from the internal console as it does not
+        create any Qt widgets, dialogs, or progress bars. It is designed for
+        programmatic use when saving DataLab workspace files.
+
+        Args:
+            filename: HDF5 filename to save to
+
+        Raises:
+            IOError: If file cannot be saved
+        """
+        filename = self.__check_h5file(filename, "save")
+        self.h5inputoutput.save_file(filename)
+        self.set_modified(False)
+
     @remote_controlled
     def import_h5_file(self, filename: str, reset_all: bool | None = None) -> None:
         """Import HDF5 file into DataLab
@@ -2151,7 +2206,7 @@ def close_properly(self) -> bool:
         Returns:
             True if closed properly, False otherwise
         """
-        if not env.execenv.unattended and self.__is_modified:
+        if not env.execenv.unattended and self.is_modified():
             answer = QW.QMessageBox.warning(
                 self,
                 _("Quit"),
@@ -2163,7 +2218,7 @@ def close_properly(self) -> bool:
             )
             if answer == QW.QMessageBox.Yes:
                 self.save_to_h5_file()
-                if self.__is_modified:
+                if self.is_modified():
                     return False
             elif answer == QW.QMessageBox.Cancel:
                 return False

datalab/tests/features/control/remoteclient_unit.py

@@ -48,6 +48,16 @@ def multiple_commands(remote: RemoteProxy):
         remote.reset_all()
         remote.open_h5_files([fname], True, False)
         remote.import_h5_file(fname, True)
+
+        # Test new headless workspace API methods (Issue #275)
+        fname_workspace = osp.join(tmpdir, "workspace_test.h5")
+        remote.save_h5_workspace(fname_workspace)
+        assert osp.exists(fname_workspace), "Workspace file was not created"
+        remote.reset_all()
+        remote.load_h5_workspace([fname_workspace], reset_all=True)
+        # Verify objects were restored
+        assert len(remote.get_object_titles()) > 0, "No objects after load_h5_workspace"
+
         remote.set_current_panel("signal")
         assert remote.get_current_panel() == "signal"
         remote.calc("log10")