feat: add set_object method to update existing objects in DataLab across multiple components

Author: PierreRaybaut

datalab/control/baseproxy.py

@@ -341,6 +341,22 @@ def add_object(
             True if object was added successfully, False otherwise
         """
 
+    @abc.abstractmethod
+    def set_object(self, obj: SignalObj | ImageObj) -> None:
+        """Set object data in DataLab.
+
+        Update an existing object in DataLab with new data from ``obj``.
+        The object is identified by its UUID (which is carried by ``obj``
+        from a previous :meth:`get_object` call).
+
+        Args:
+            obj: Signal or image object (must have the same UUID as an
+             existing object in DataLab)
+
+        Raises:
+            KeyError: if no object with matching UUID is found
+        """
+
     @abc.abstractmethod
     def add_group(
         self, title: str, panel: str | None = None, select: bool = False
@@ -859,6 +875,22 @@ def get_group_titles_with_object_info(
         """
         return self._datalab.get_group_titles_with_object_info()
 
+    def set_object(self, obj: SignalObj | ImageObj) -> None:
+        """Set object data in DataLab.
+
+        Update an existing object in DataLab with new data from ``obj``.
+        The object is identified by its UUID (which is carried by ``obj``
+        from a previous :meth:`get_object` call).
+
+        Args:
+            obj: Signal or image object (must have the same UUID as an
+             existing object in DataLab)
+
+        Raises:
+            KeyError: if no object with matching UUID is found
+        """
+        self._datalab.set_object(obj)
+
     def get_object_titles(self, panel: str | None = None) -> list[str]:
         """Get object (signal/image) list for current panel.
         Objects are sorted by group number and object index in group.

datalab/control/remote.py

@@ -84,6 +84,7 @@ class RemoteServer(QC.QThread):
     SIG_CLOSE_APP = QC.Signal()
     SIG_RAISE_WINDOW = QC.Signal()
     SIG_ADD_OBJECT = QC.Signal(object, str, bool)
+    SIG_SET_OBJECT = QC.Signal(object)
     SIG_ADD_GROUP = QC.Signal(str, str, bool)
     SIG_LOAD_FROM_FILES = QC.Signal(list)
     SIG_LOAD_FROM_DIRECTORY = QC.Signal(str)
@@ -120,6 +121,7 @@ def __init__(self, win: DLMainWindow) -> None:
         self.SIG_CLOSE_APP.connect(win.close)
         self.SIG_RAISE_WINDOW.connect(win.raise_window)
         self.SIG_ADD_OBJECT.connect(win.add_object)
+        self.SIG_SET_OBJECT.connect(win.set_object)
         self.SIG_ADD_GROUP.connect(win.add_group)
         self.SIG_LOAD_FROM_FILES.connect(win.load_from_files)
         self.SIG_LOAD_FROM_DIRECTORY.connect(win.load_from_directory)
@@ -449,6 +451,26 @@ def add_object(
         self.SIG_ADD_OBJECT.emit(obj, group_id, set_current)
         return True
 
+    @remote_call
+    def set_object(self, obj_data: list[str]) -> bool:
+        """Set object data in DataLab.
+
+        Update an existing object in DataLab with new data from ``obj_data``.
+        The object is identified by its UUID.
+
+        Args:
+            obj_data: Object data (RPC-JSON serialized)
+
+        Returns:
+            True if successful
+
+        Raises:
+            KeyError: if no object with matching UUID is found
+        """
+        obj = utils.rpcjson_to_dataset(obj_data)
+        self.SIG_SET_OBJECT.emit(obj)
+        return True
+
     @remote_call
     def get_sel_object_uuids(self, include_groups: bool = False) -> list[str]:
         """Return selected objects uuids.
@@ -1068,6 +1090,23 @@ def add_object(
         obj_data = utils.dataset_to_rpcjson(obj)
         self._datalab.add_object(obj_data, group_id, set_current)
 
+    def set_object(self, obj: SignalObj | ImageObj) -> None:
+        """Set object data in DataLab.
+
+        Update an existing object in DataLab with new data from ``obj``.
+        The object is identified by its UUID (which is carried by ``obj``
+        from a previous :meth:`get_object` call).
+
+        Args:
+            obj: Signal or image object (must have the same UUID as an
+             existing object in DataLab)
+
+        Raises:
+            KeyError: if no object with matching UUID is found
+        """
+        obj_data = utils.dataset_to_rpcjson(obj)
+        self._datalab.set_object(obj_data)
+
     def calc(self, name: str, param: gds.DataSet | None = None) -> None:
         """Call computation feature ``name``
 

datalab/gui/main.py

@@ -2225,6 +2225,27 @@ def add_object(
             else:
                 raise TypeError(f"Unsupported object type {type(obj)}")
 
+    @remote_controlled
+    def set_object(self, obj: SignalObj | ImageObj) -> None:
+        """Set object data - update an existing signal or image in-place.
+
+        The existing object is identified by UUID carried by ``obj``
+        (from a previous :meth:`get_object` call).
+
+        Args:
+            obj: object with updated data (signal or image)
+
+        Raises:
+            KeyError: if no object with matching UUID is found
+            TypeError: if object type is unsupported
+        """
+        if isinstance(obj, SignalObj):
+            self.signalpanel.set_object(obj)
+        elif isinstance(obj, ImageObj):
+            self.imagepanel.set_object(obj)
+        else:
+            raise TypeError(f"Unsupported object type {type(obj)}")
+
     @remote_controlled
     def load_from_files(self, filenames: list[str]) -> None:
         """Open objects from files in current panel (signals/images)

datalab/gui/panel/base.py

@@ -84,7 +84,14 @@
     insert_processing_parameters,
 )
 from datalab.gui.roieditor import TypeROIEditor
-from datalab.objectmodel import ObjectGroup, get_short_id, get_uuid, set_uuid
+from datalab.objectmodel import (
+    ObjectGroup,
+    get_number,
+    get_short_id,
+    get_uuid,
+    set_number,
+    set_uuid,
+)
 from datalab.utils.qthelpers import (
     CallbackWorker,
     create_progress_bar,
@@ -1550,6 +1557,33 @@ def add_object(
 
         self.objview.update_tree()
 
+    def set_object(self, obj: TypeObj) -> None:
+        """Update an existing object in-place with data from ``obj``.
+
+        The existing object is identified by UUID (carried by ``obj`` from a
+        previous :meth:`get_object` call). All data attributes are copied from
+        ``obj`` to the existing object while preserving internal metadata
+        (number, group membership).
+
+        Args:
+            obj: SignalObj or ImageObj with the same UUID as an existing object.
+
+        Raises:
+            KeyError: if no object with matching UUID is found
+        """
+        obj_uuid = get_uuid(obj)
+        existing = self.objmodel[obj_uuid]  # KeyError if not found
+        # Preserve internal number metadata before overwriting
+        number = get_number(existing)
+        # Copy all public DataSet item values from obj to existing
+        for item in existing._items:  # pylint: disable=protected-access
+            name = item.get_name()
+            if not name.startswith("_"):
+                setattr(existing, name, getattr(obj, name))
+        set_number(existing, number)
+        self.objview.update_tree()
+        self.refresh_plot("selected", update_items=True, force=True)
+
     def remove_all_objects(self) -> None:
         """Remove all objects"""
         # iterate over a copy of self.__separate_views dict keys to avoid RuntimeError:

datalab/locale/fr/LC_MESSAGES/datalab.po

@@ -3449,3 +3449,4 @@ msgstr "Merci de sélectionner le fichier à importer."
 
 msgid "Example Wizard"
 msgstr "Assistant exemple"
+

datalab/tests/features/control/remoteclient_unit.py

@@ -60,6 +60,20 @@ def multiple_commands(remote: RemoteProxy):
 
         remote.set_current_panel("signal")
         assert remote.get_current_panel() == "signal"
+
+        # Test set_object round-trip (get → modify → set → verify)
+        uuids = remote.get_object_uuids()
+        obj = remote.get_object(uuids[0])
+        original_title = obj.title
+        obj.title = "Modified by set_object"
+        remote.set_object(obj)
+        obj2 = remote.get_object(uuids[0])
+        assert obj2.title == "Modified by set_object", (
+            f"set_object failed: expected 'Modified by set_object', got '{obj2.title}'"
+        )
+        obj2.title = original_title
+        remote.set_object(obj2)
+
         remote.calc("log10")
 
         param = XYCalibrateParam.create(a=1.2, b=0.1)

datalab/webapi/adapter.py

@@ -422,6 +422,50 @@ def do_update():
 
         self._executor.run_on_main_thread(do_update)
 
+    def set_object(self, name: str, obj: DataObject) -> None:
+        """Update an existing object in-place with new data.
+
+        This operation replaces all data attributes of the existing object
+        (identified by name/title) with those from ``obj``, preserving the
+        object's identity, group membership, and position in the workspace.
+
+        This operation is marshaled to the Qt main thread for thread safety.
+
+        Args:
+            name: Object name/title.
+            obj: Object with updated data (same type as existing).
+
+        Raises:
+            KeyError: If object not found.
+        """
+        self._ensure_main_window()
+
+        panel_name = self.get_object_panel(name)
+        if panel_name is None:
+            raise KeyError(f"Object '{name}' not found")
+
+        if panel_name == "signal":
+            panel = self._main_window.signalpanel
+        else:
+            panel = self._main_window.imagepanel
+
+        def do_set():
+            # Find the existing object by title
+            for existing in panel.objmodel:
+                if existing.title == name:
+                    # Copy all public DataSet item values
+                    for item in existing._items:  # pylint: disable=protected-access
+                        attr_name = item.get_name()
+                        if not attr_name.startswith("_"):
+                            setattr(existing, attr_name, getattr(obj, attr_name))
+                    # Refresh display
+                    panel.objview.update_tree()
+                    panel.SIG_REFRESH_PLOT.emit("selected", True)
+                    return
+            raise KeyError(f"Object '{name}' not found")
+
+        self._executor.run_on_main_thread(do_set)
+
     def clear(self) -> None:
         """Clear all objects from the workspace.
 

datalab/webapi/routes.py

@@ -461,6 +461,66 @@ async def put_object_data(
         ) from e
 
 
+@router.put(
+    "/objects/{name}",
+    response_model=ObjectMetadata,
+    responses={
+        401: {"model": ErrorResponse},
+        404: {"model": ErrorResponse},
+        422: {"model": ErrorResponse},
+        500: {"model": ErrorResponse},
+    },
+)
+async def set_object(
+    name: str,
+    request: Request,
+    _token: str = Depends(verify_token),
+    adapter: WorkspaceAdapter = Depends(get_adapter),
+) -> ObjectMetadata:
+    """Update an existing object in-place from NPZ data.
+
+    The request body must be a NumPy NPZ archive containing the object data
+    (x.npy/y.npy for signals, data.npy for images) and metadata.json.
+
+    Unlike ``PUT /objects/{name}/data`` (which creates or replaces), this
+    endpoint requires the object to already exist and updates it in-place,
+    preserving its identity, group membership, and position.
+
+    Args:
+        name: Object name/title (must already exist).
+        request: FastAPI request (body contains NPZ archive bytes).
+
+    Returns:
+        Updated object metadata.
+    """
+    try:
+        body = await request.body()
+        obj = deserialize_object_from_npz(body)
+        obj.title = name
+        adapter.set_object(name, obj)
+
+        # Return updated metadata
+        updated = adapter.get_object(name)
+        meta = object_to_metadata(updated, name)
+        return ObjectMetadata(**meta)
+
+    except KeyError as e:
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail=f"Object '{name}' not found",
+        ) from e
+    except ValueError as e:
+        raise HTTPException(
+            status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
+            detail=f"Invalid NPZ format: {e}",
+        ) from e
+    except Exception as e:  # pylint: disable=broad-exception-caught
+        raise HTTPException(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            detail=f"Error updating object '{name}': {e}",
+        ) from e
+
+
 # =============================================================================
 # Computation endpoints
 # =============================================================================

doc/locale/fr/LC_MESSAGES/features/advanced/proxy.po

@@ -441,6 +441,18 @@ msgstr ""
 msgid "Panel name (valid values: \"signal\", \"image\", \"macro\"))"
 msgstr ""
 
+msgid "Set object data in DataLab."
+msgstr ""
+
+msgid "Update an existing object in DataLab with new data from ``obj``. The object is identified by its UUID (which is carried by ``obj`` from a previous :meth:`get_object` call)."
+msgstr ""
+
+msgid "Signal or image object (must have the same UUID as an existing object in DataLab)"
+msgstr ""
+
+msgid "if no object with matching UUID is found"
+msgstr ""
+
 msgid "Set XML-RPC port to connect to."
 msgstr ""
 

doc/locale/fr/LC_MESSAGES/features/advanced/remote.po

@@ -266,6 +266,18 @@ msgstr ""
 msgid "if True, set the added object as current"
 msgstr ""
 
+msgid "Set object data in DataLab."
+msgstr ""
+
+msgid "Update an existing object in DataLab with new data from ``obj``. The object is identified by its UUID (which is carried by ``obj`` from a previous :meth:`get_object` call)."
+msgstr ""
+
+msgid "Signal or image object (must have the same UUID as an existing object in DataLab)"
+msgstr ""
+
+msgid "if no object with matching UUID is found"
+msgstr ""
+
 msgid "Call computation feature ``name``"
 msgstr ""