Add proxy.remove_object() method for selective object deletion

Fixes #264

Author: PierreRaybaut

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 See DataLab [roadmap page](https://datalab-platform.com/en/contributing/roadmap.html) for future and past milestones.
 
+## DataLab Version 1.1.0 (unreleased) ##
+
+### ✨ New Features ###
+
+**Proxy API:**
+
+* Added `remove_object()` method to proxy interface (local and remote) for selective object deletion
+  * Removes currently selected object from active panel
+  * Optional `force` parameter to skip confirmation dialog
+  * Complements existing `reset_all()` method which removes all objects
+
 ## DataLab Version 1.0.2 (unreleased) ##
 
 ### 🛠️ Bug Fixes ###

datalab/control/baseproxy.py

@@ -127,6 +127,14 @@ def set_current_panel(self, panel: str) -> None:
     def reset_all(self) -> None:
         """Reset all application data"""
 
+    @abc.abstractmethod
+    def remove_object(self, force: bool = False) -> None:
+        """Remove current object from current panel.
+
+        Args:
+            force: if True, remove object without confirmation. Defaults to False.
+        """
+
     @abc.abstractmethod
     def toggle_auto_refresh(self, state: bool) -> None:
         """Toggle auto refresh state.
@@ -559,6 +567,14 @@ def reset_all(self) -> None:
         """Reset all application data"""
         self._datalab.reset_all()
 
+    def remove_object(self, force: bool = False) -> None:
+        """Remove current object from current panel.
+
+        Args:
+            force: if True, remove object without confirmation. Defaults to False.
+        """
+        self._datalab.remove_object(force)
+
     def toggle_auto_refresh(self, state: bool) -> None:
         """Toggle auto refresh state.
 

datalab/control/remote.py

@@ -81,6 +81,7 @@ class RemoteServer(QC.QThread):
     SIG_TOGGLE_AUTO_REFRESH = QC.Signal(bool)
     SIG_TOGGLE_SHOW_TITLES = QC.Signal(bool)
     SIG_RESET_ALL = QC.Signal()
+    SIG_REMOVE_OBJECT = QC.Signal(bool)
     SIG_SAVE_TO_H5 = QC.Signal(str)
     SIG_OPEN_H5 = QC.Signal(list, bool, bool)
     SIG_IMPORT_H5 = QC.Signal(str, bool)
@@ -111,6 +112,7 @@ def __init__(self, win: DLMainWindow) -> None:
         self.SIG_TOGGLE_AUTO_REFRESH.connect(win.toggle_auto_refresh)
         self.SIG_TOGGLE_SHOW_TITLES.connect(win.toggle_show_titles)
         self.SIG_RESET_ALL.connect(win.reset_all)
+        self.SIG_REMOVE_OBJECT.connect(win.remove_object)
         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)
@@ -230,6 +232,15 @@ def reset_all(self) -> None:
         """Reset all application data"""
         self.SIG_RESET_ALL.emit()
 
+    @remote_call
+    def remove_object(self, force: bool = False) -> None:
+        """Remove current object from current panel.
+
+        Args:
+            force: if True, remove object without confirmation. Defaults to False.
+        """
+        self.SIG_REMOVE_OBJECT.emit(force)
+
     @remote_call
     def save_to_h5_file(self, filename: str) -> None:
         """Save to a DataLab HDF5 file.

datalab/gui/main.py

@@ -1527,6 +1527,16 @@ def reset_all(self) -> None:
             if panel is not None:
                 panel.remove_all_objects()
 
+    @remote_controlled
+    def remove_object(self, force: bool = False) -> None:
+        """Remove current object from current panel.
+
+        Args:
+            force: if True, remove object without confirmation. Defaults to False.
+        """
+        panel = self.__get_current_basedatapanel()
+        panel.remove_object(force)
+
     @staticmethod
     def __check_h5file(filename: str, operation: str) -> str:
         """Check HDF5 filename"""

datalab/tests/backbone/main_app_test.py

@@ -54,6 +54,10 @@ def test_main_app():
         # Add signals to signal panel
         sig1 = create_paracetamol_signal(500)
         panel.add_object(sig1)
+        nobj0 = len(panel)
+        win.remove_object(force=True)  # Test remove object method, then add it back
+        assert len(panel) == nobj0 - 1, "One object should have been removed"
+        panel.add_object(sig1)
         panel.rename_selected_object_or_group("Paracetamol Signal 1")
         panel.processor.run_feature(sips.derivative)
         panel.processor.run_feature(sips.wiener)

datalab/tests/features/common/misc_app_test.py

@@ -164,6 +164,11 @@ def __misc_unit_function(win: DLMainWindow) -> None:
         group_id=get_uuid(gp2),
         set_current=False,
     )
+    sig = win.get_object()  # Get the last added signal
+    nobj0 = len(win.signalpanel)
+    win.remove_object(force=True)  # Test the remove object method, then add it back
+    assert len(win.signalpanel) == nobj0 - 1, "One object should have been removed"
+    win.add_object(sig)
 
     # Add image
     __print_test_result("Add image")

datalab/tests/features/control/embedded1_unit_test.py

@@ -164,6 +164,14 @@ def add_signals(self):
                 obj = func(title=self.sigtitle)
                 self.add_object(obj)
                 self.host.log(f"Added signal: {obj.title}")
+            # Remove last added signal to test remove_object
+            nobj0 = len(self.datalab.get_object_titles())
+            sig = self.datalab.get_object()  # Get the last added signal
+            self.datalab.remove_object(force=True)  # Test remove object method
+            assert len(self.datalab.get_object_titles()) == nobj0 - 1, (
+                "One object should have been removed"
+            )
+            self.add_object(sig)  # Add it back
 
     def add_images(self):
         """Add images to DataLab"""