Remote API: new get_object_shapes method

Author: PierreRaybaut

cdlclient/baseproxy.py

@@ -250,6 +250,28 @@ def get_object_uuids(self, panel: str | None = None) -> list[str]:
             ValueError: if panel not found
         """
 
+    @abc.abstractmethod
+    def get_object_shapes(
+        self,
+        index: int | None = None,
+        group_index: int | None = None,
+        panel: str | None = None,
+    ) -> list:
+        """Get plot item shapes associated to object (signal/image).
+
+        Args:
+            index: Object index in current panel. Defaults to None.
+            group_index: Group index. Defaults to None.
+            panel: Panel name. Defaults to None.
+
+        If ``index`` is not specified, returns the currently selected object.
+        If ``group_index`` is not specified, return an object from the current group.
+        If ``panel`` is not specified, return an object from the current panel.
+
+        Returns:
+            List of plot item shapes
+        """
+
     @abc.abstractmethod
     def add_annotations_from_items(
         self, items: list, refresh_plot: bool = True, panel: str | None = None

cdlclient/remote.py

@@ -18,6 +18,7 @@
 
 import configparser as cp
 import importlib
+import json
 import os
 import os.path as osp
 import sys
@@ -167,6 +168,27 @@ def items_to_json(items: list) -> str | None:
     return None
 
 
+def json_to_items(json_str: str | None) -> list:
+    """Convert JSON string to plot items.
+
+    Args:
+        json_str (str): JSON string or None
+
+    Returns:
+        list: list of plot items
+    """
+    from plotpy.io import load_items  # pylint: disable=import-outside-toplevel
+
+    items = []
+    if json_str:
+        try:
+            for item in load_items(JSONReader(json_str)):
+                items.append(item)
+        except json.decoder.JSONDecodeError:
+            pass
+    return items
+
+
 class SimpleRemoteProxy(SimpleBaseProxy):
     """Object representing a proxy/client to DataLab XML-RPC server.
     This object is used to call DataLab functions from a Python script.
@@ -355,6 +377,29 @@ def calc(self, name: str, param: gds.DataSet | None = None) -> gds.DataSet:
             return self._cdl.calc(name)
         return self._cdl.calc(name, dataset_to_json(param))
 
+    def get_object_shapes(
+        self,
+        index: int | None = None,
+        group_index: int | None = None,
+        panel: str | None = None,
+    ) -> list:
+        """Get plot item shapes associated to object (signal/image).
+
+        Args:
+            index: Object index in current panel. Defaults to None.
+            group_index: Group index. Defaults to None.
+            panel: Panel name. Defaults to None.
+
+        If ``index`` is not specified, returns the currently selected object.
+        If ``group_index`` is not specified, return an object from the current group.
+        If ``panel`` is not specified, return an object from the current panel.
+
+        Returns:
+            List of plot item shapes
+        """
+        items_json = self._cdl.get_object_shapes(index, group_index, panel)
+        return json_to_items(items_json)
+
     def add_annotations_from_items(
         self, items: list, refresh_plot: bool = True, panel: str | None = None
     ) -> None:

cdlclient/tests/remoteclient_unit.py

@@ -49,8 +49,12 @@ def multiple_commands(remote: SimpleRemoteProxy):
         z = np.random.rand(200, 200)
         remote.add_image("toto", z)
         rect = make.annotated_rectangle(100, 100, 200, 200, title="Test")
+        area = rect.get_rect()
         remote.add_annotations_from_items([rect])
         uuid = remote.get_sel_object_uuids()[0]
+        items = remote.get_object_shapes()
+        assert len(items) == 1 and items[0].get_rect() == area
+        execenv.print("OK")
         remote.add_label_with_title(f"Image uuid: {uuid}")
         remote.select_groups([0])
         remote.select_objects([uuid])