Fix API changes and bug in multiple signals loading feature

Author: PierreRaybaut

CHANGELOG.md

@@ -5,6 +5,16 @@ for future and past milestones.
 
 ## DataLab Version 0.14.2 ##
 
+⚠️ API changes required for fixing support for multiple signals loading feature:
+  * Merged `open_object` and `open_objects` methods to `load_from_files` in proxy
+    classes, main window and data panels
+  * For consistency's sake: merged `save_object` and `save_objects` into `save_to_files`
+  * To sum up, those changes lead to the following situation:
+    * `load_from_files`: load a sequence of objects from multiple files
+    * `save_to_files`: save a sequence of objects to multiple files (at the moment,
+      it only supports saving a single object to a single file, but it may be extended
+      in the future to support saving multiple objects to a single file)
+
 🛠️ Bug fixes:
 
 * Fixed [Issue #61](https://github.com/DataLab-Platform/DataLab/issues/61) - Text file import wizard: application crash when importing a multiple curve text file:

cdl/__init__.py

@@ -16,7 +16,7 @@
 
 import os
 
-__version__ = "0.14.1"
+__version__ = "0.14.2"
 __docurl__ = __homeurl__ = "https://datalab-platform.com/"
 __supporturl__ = "https://github.com/DataLab-Platform/DataLab/issues/new/choose"
 

cdl/core/baseproxy.py

@@ -208,11 +208,11 @@ def import_h5_file(self, filename: str, reset_all: bool | None = None) -> None:
         """
 
     @abc.abstractmethod
-    def open_object(self, filename: str) -> None:
-        """Open object from file in current panel (signal/image).
+    def load_from_files(self, filenames: list[str]) -> None:
+        """Open objects from files in current panel (signals/images).
 
         Args:
-            filename (str): File name
+            filenames: list of file names
         """
 
     @abc.abstractmethod
@@ -596,13 +596,13 @@ def import_h5_file(self, filename: str, reset_all: bool | None = None) -> None:
         """
         self._cdl.import_h5_file(filename, reset_all)
 
-    def open_object(self, filename: str) -> None:
-        """Open object from file in current panel (signal/image).
+    def load_from_files(self, filenames: list[str]) -> None:
+        """Open objects from files in current panel (signals/images).
 
         Args:
-            filename (str): File name
+            filenames: list of file names
         """
-        self._cdl.open_object(filename)
+        self._cdl.load_from_files(filenames)
 
     def get_sel_object_uuids(self, include_groups: bool = False) -> list[str]:
         """Return selected objects uuids.

cdl/core/gui/actionhandler.py

@@ -377,7 +377,7 @@ def create_first_actions(self):
                 # icon: fileopen_signal.svg or fileopen_image.svg
                 icon=get_icon(f"fileopen_{self.__class__.__name__[:3].lower()}.svg"),
                 tip=_("Open %s") % self.OBJECT_STR,
-                triggered=self.panel.open_objects,
+                triggered=self.panel.load_from_files,
                 shortcut=QG.QKeySequence(QG.QKeySequence.Open),
                 select_condition=SelectCond.always,
                 toolbar_pos=-1,
@@ -387,7 +387,7 @@ def create_first_actions(self):
                 # icon: filesave_signal.svg or filesave_image.svg
                 icon=get_icon(f"filesave_{self.__class__.__name__[:3].lower()}.svg"),
                 tip=_("Save selected %s") % self.OBJECT_STR,
-                triggered=self.panel.save_objects,
+                triggered=self.panel.save_to_files,
                 shortcut=QG.QKeySequence(QG.QKeySequence.Save),
                 select_condition=SelectCond.at_least_one,
                 context_menu_pos=-1,

cdl/core/gui/main.py

@@ -1399,17 +1399,14 @@ def add_object(self, obj: SignalObj | ImageObj) -> None:
                 raise TypeError(f"Unsupported object type {type(obj)}")
 
     @remote_controlled
-    def open_object(self, filename: str) -> None:
-        """Open object from file in current panel (signal/image)
+    def load_from_files(self, filenames: list[str]) -> None:
+        """Open objects from files in current panel (signals/images)
 
         Args:
-            filename (str): HDF5 filename
-
-        Returns:
-            None
+            filenames: list of filenames
         """
-        panel = self.tabwidget.currentWidget()
-        panel.open_object(filename)
+        panel = self.__get_current_basedatapanel()
+        panel.load_from_files(filenames)
 
     # ------Other methods related to AbstractCDLControl interface
     def get_version(self) -> str:

cdl/core/gui/panel/base.py

@@ -551,8 +551,8 @@ def add_annotations_from_items(
         """Add object annotations (annotation plot items).
 
         Args:
-            items (list): annotation plot items
-            refresh_plot (bool | None): refresh plot. Defaults to True.
+            items: annotation plot items
+            refresh_plot: refresh plot. Defaults to True.
         """
         for obj in self.objview.get_sel_objects(include_groups=True):
             obj.add_annotations_from_items(items)
@@ -594,8 +594,7 @@ def get_newparam_from_current(
         """Get new object parameters from the current object.
 
         Args:
-            newparam (guidata.dataset.DataSet): new object parameters.
-             If None, create a new one.
+            newparam: new object parameters. If None, create a new one.
 
         Returns:
             New object parameters
@@ -612,10 +611,10 @@ def new_object(
         """Create a new object (signal/image).
 
         Args:
-            newparam (guidata.dataset.DataSet): new object parameters
-            addparam (guidata.dataset.DataSet): additional parameters
-            edit (bool): Open a dialog box to edit parameters (default: True)
-            add_to_panel (bool): Add object to panel (default: True)
+            newparam: new object parameters
+            addparam: additional parameters
+            edit: Open a dialog box to edit parameters (default: True)
+            add_to_panel: Add object to panel (default: True)
 
         Returns:
             New object
@@ -627,62 +626,38 @@ def set_current_object_title(self, title: str) -> None:
         obj.title = title
         self.objview.update_item(obj.uuid)
 
-    def open_object(
-        self, filename: str
-    ) -> SignalObj | ImageObj | list[SignalObj | ImageObj]:
-        """Open object from file (signal/image), add it to DataLab and return it.
+    def __load_from_file(self, filename: str) -> list[SignalObj] | list[ImageObj]:
+        """Open objects from file (signal/image), add them to DataLab and return them.
 
         Args:
-            filename (str): file name
+            filename: file name
 
         Returns:
             New object or list of new objects
         """
-        obj_or_objlist = self.IO_REGISTRY.read(filename)
-        objs = obj_or_objlist if isinstance(obj_or_objlist, list) else [obj_or_objlist]
+        objs = self.IO_REGISTRY.read(filename)
         for obj in objs:
             obj.metadata["source"] = filename
             self.add_object(obj, set_current=obj is objs[-1])
         self.selection_changed()
-        if len(objs) == 1:
-            return objs[0]
         return objs
 
-    def save_object(self, obj, filename: str | None = None) -> None:
-        """Save object to file (signal/image)"""
-        if filename is None:
-            basedir = Conf.main.base_dir.get()
-            filters = self.IO_REGISTRY.get_filters(IOAction.SAVE)
-            with save_restore_stds():
-                filename, _filt = getsavefilename(self, _("Save as"), basedir, filters)
-        if filename:
-            with qt_try_loadsave_file(self.parent(), filename, "save"):
-                Conf.main.base_dir.set(filename)
-                self.IO_REGISTRY.write(filename, obj)
-
-    def handle_dropped_files(self, filenames: list[str] | None = None) -> None:
-        """Handle dropped files
+    def __save_to_file(self, obj: SignalObj | ImageObj, filename: str) -> None:
+        """Save object to file (signal/image).
 
         Args:
-            filenames (list(str)): File names
-
-        Returns:
-            None
+            obj: object
+            filename: file name
         """
-        h5_fnames = [fname for fname in filenames if fname.endswith(".h5")]
-        other_fnames = sorted(list(set(filenames) - set(h5_fnames)))
-        if h5_fnames:
-            self.mainwindow.open_h5_files(h5_fnames, import_all=True)
-        if other_fnames:
-            self.open_objects(other_fnames)
+        self.IO_REGISTRY.write(filename, obj)
 
-    def open_objects(
+    def load_from_files(
         self, filenames: list[str] | None = None
     ) -> list[SignalObj | ImageObj]:
         """Open objects from file (signals/images), add them to DataLab and return them.
 
         Args:
-            filenames (list(str)): File names
+            filenames: File names
 
         Returns:
             list of new objects
@@ -698,25 +673,50 @@ def open_objects(
         for filename in filenames:
             with qt_try_loadsave_file(self.parent(), filename, "load"):
                 Conf.main.base_dir.set(filename)
-                objs.append(self.open_object(filename))
+                objs += self.__load_from_file(filename)
         return objs
 
-    def save_objects(self, filenames: list[str] | None = None) -> None:
-        """Save selected objects to file (signal/image).
+    def save_to_files(self, obj, filenames: list[str] | str | None = None) -> None:
+        """Save selected objects to files (signal/image).
 
         Args:
-            filenames (list(str)): File names
-
-        Returns:
-            None
+            filenames: File names
         """
         objs = self.objview.get_sel_objects(include_groups=True)
         if filenames is None:  # pragma: no cover
             filenames = [None] * len(objs)
-        assert len(filenames) == len(objs)
+        assert len(filenames) == len(
+            objs
+        ), "Number of filenames must match number of objects"
         for index, obj in enumerate(objs):
             filename = filenames[index]
-            self.save_object(obj, filename)
+            if filename is None:
+                basedir = Conf.main.base_dir.get()
+                filters = self.IO_REGISTRY.get_filters(IOAction.SAVE)
+                with save_restore_stds():
+                    filename, _filt = getsavefilename(
+                        self, _("Save as"), basedir, filters
+                    )
+            if filename:
+                with qt_try_loadsave_file(self.parent(), filename, "save"):
+                    Conf.main.base_dir.set(filename)
+                    self.__save_to_file(obj, filename)
+
+    def handle_dropped_files(self, filenames: list[str] | None = None) -> None:
+        """Handle dropped files
+
+        Args:
+            filenames: File names
+
+        Returns:
+            None
+        """
+        h5_fnames = [fname for fname in filenames if fname.endswith(".h5")]
+        other_fnames = sorted(list(set(filenames) - set(h5_fnames)))
+        if h5_fnames:
+            self.mainwindow.open_h5_files(h5_fnames, import_all=True)
+        if other_fnames:
+            self.load_from_files(other_fnames)
 
     def exec_import_wizard(self) -> None:
         """Execute import wizard"""
@@ -737,10 +737,7 @@ def import_metadata_from_file(self, filename: str | None = None) -> None:
         """Import metadata from file (JSON).
 
         Args:
-            filename (str): File name
-
-        Returns:
-            None
+            filename: File name
         """
         if filename is None:  # pragma: no cover
             basedir = Conf.main.base_dir.get()
@@ -759,10 +756,7 @@ def export_metadata_from_file(self, filename: str | None = None) -> None:
         """Export metadata to file (JSON).
 
         Args:
-            filename (str): File name
-
-        Returns:
-            None
+            filename: File name
         """
         obj = self.objview.get_sel_objects(include_groups=True)[0]
         if filename is None:  # pragma: no cover
@@ -782,7 +776,7 @@ def selection_changed(self, update_items: bool = False) -> None:
         object view.
 
         Args:
-            update_items (bool): Update plot items (default: False)
+            update_items: Update plot items (default: False)
         """
         selected_objects = self.objview.get_sel_objects(include_groups=True)
         selected_groups = self.objview.get_sel_groups()
@@ -804,7 +798,7 @@ def open_separate_view(self, oids: list[str] | None = None) -> PlotDialog | None
         Open separate view for visualizing selected objects
 
         Args:
-            oids (list(str)): Object IDs
+            oids: Object IDs
 
         Returns:
             QDialog instance
@@ -874,13 +868,13 @@ def create_new_dialog(
         """Create new pop-up signal/image plot dialog.
 
         Args:
-            oids (list(str)): Object IDs
-            edit (bool): Edit mode
-            toolbar (bool): Show toolbar
-            title (str): Dialog title
-            tools (list(GuiTool)): list of tools to add to the toolbar
-            name (str): Dialog name
-            options (dict): Plot options
+            oids: Object IDs
+            edit: Edit mode
+            toolbar: Show toolbar
+            title: Dialog title
+            tools: list of tools to add to the toolbar
+            name: Dialog name
+            options: Plot options
 
         Returns:
             QDialog instance
@@ -939,11 +933,11 @@ def create_new_dialog_for_selection(
         """Create new pop-up dialog for the currently selected signal/image.
 
         Args:
-            title (str): Dialog title
-            name (str): Dialog name
-            options (dict): Plot options
-            toolbar (bool): Show toolbar
-            tools (list(GuiTool)): list of tools to add to the toolbar
+            title: Dialog title
+            name: Dialog name
+            options: Plot options
+            toolbar: Show toolbar
+            tools: list of tools to add to the toolbar
 
         Returns:
             QDialog instance, selected object
@@ -1141,8 +1135,8 @@ def add_label_with_title(self, title: str | None = None) -> None:
         """Add a label with object title on the associated plot
 
         Args:
-            title (str | None): Label title. Defaults to None.
-                If None, the title is the object title.
+            title: Label title. Defaults to None.
+             If None, the title is the object title.
         """
         objs = self.objview.get_sel_objects(include_groups=True)
         for obj in objs: