Enhanced get_object, get_object_shapes

Author: PierreRaybaut

CHANGELOG.md

@@ -1,5 +1,14 @@
 # DataLab Simple Client Releases #
 
+## Version 0.3.0 ##
+
+Changes:
+
+* Remote API:
+  * `get_object` method now takes either object number, UUID or a title
+  * `get_object_shapes` method now takes either object number, UUID or a title
+  * Removed deprecated `get_object_from_uuid` and `get_object_from_title` methods
+
 ## Version 0.2.0 ##
 
 Changes:

cdlclient/__init__.py

@@ -16,7 +16,7 @@
 from cdlclient.baseproxy import SimpleBaseProxy
 from cdlclient.remote import SimpleRemoteProxy
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 __docurl__ = "https://cdlclient.readthedocs.io/en/latest/"
 __homeurl__ = "https://github.com/Codra-Ingenierie-Informatique/DataLabSimpleClient/"
 __supporturl__ = "https://github.com/Codra-Ingenierie-Informatique/DataLabSimpleClient/issues/new/choose"

cdlclient/baseproxy.py

@@ -255,20 +255,15 @@ def get_object_uuids(self, panel: str | None = None) -> list[str]:
     @abc.abstractmethod
     def get_object_shapes(
         self,
-        index: int | None = None,
-        group_index: int | None = None,
+        nb_id_title: int | str | 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.
+            nb_id_title: Object number, or object id, or object title.
+             Defaults to None (current object).
+            panel: Panel name. Defaults to None (current panel).
 
         Returns:
             List of plot item shapes

cdlclient/remote.py

@@ -217,9 +217,9 @@ class SimpleRemoteProxy(SimpleBaseProxy):
         ['toto']
         >>> proxy.get_object_from_title("toto")
         <cdlclient.model.signal.SignalObj at 0x7f7f1c0b4a90>
-        >>> proxy.get_object(0)
+        >>> proxy.get_object(1)
         <cdlclient.model.signal.SignalObj at 0x7f7f1c0b4a90>
-        >>> proxy.get_object(0).data
+        >>> proxy.get_object(1).data
         array([1., 2., 3.])
     """
 
@@ -382,92 +382,43 @@ 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_from_title(
-        self, title: str, panel: str | None = None
-    ) -> SignalObj | ImageObj:
-        """Get object (signal/image) from title
-
-        Args:
-            title (str): object
-            panel (str | None): panel name (valid values: "signal", "image").
-                If None, current panel is used.
-
-        Returns:
-            Union[SignalObj, ImageObj]: object
-
-        Raises:
-            ValueError: if object not found
-            ValueError: if panel not found
-        """
-        param_data = self._cdl.get_object_from_title(title, panel)
-        return json_to_dataset(param_data)
-
     def get_object(
         self,
-        index: int | None = None,
-        group_index: int | None = None,
+        nb_id_title: int | str | None = None,
         panel: str | None = None,
     ) -> SignalObj | ImageObj:
         """Get object (signal/image) from index.
 
         Args:
-            index (int): Object index in current panel. Defaults to None.
-            group_index (int | None): Group index. Defaults to None.
-            panel (str | None): 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.
+            nb_id_title: Object number, or object id, or object title.
+             Defaults to None (current object).
+            panel: Panel name. Defaults to None (current panel).
 
         Returns:
-            Union[SignalObj, ImageObj]: object
+            Object
 
         Raises:
-            IndexError: if object not found
+            KeyError: if object not found
         """
-        param_data = self._cdl.get_object(index, group_index, panel)
-        return json_to_dataset(param_data)
-
-    def get_object_from_uuid(
-        self, oid: str, panel: str | None = None
-    ) -> SignalObj | ImageObj:
-        """Get object (signal/image) from uuid
-
-        Args:
-            oid (str): object uuid
-            panel (str | None): panel name (valid values: "signal", "image").
-
-        Returns:
-            Union[SignalObj, ImageObj]: object
-
-        Raises:
-            ValueError: if object not found
-            ValueError: if panel not found
-        """
-        param_data = self._cdl.get_object_from_uuid(oid, panel)
+        param_data = self._cdl.get_object(nb_id_title, panel)
         return json_to_dataset(param_data)
 
     def get_object_shapes(
         self,
-        index: int | None = None,
-        group_index: int | None = None,
+        nb_id_title: int | str | 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.
+            nb_id_title: Object number, or object id, or object title.
+             Defaults to None (current object).
+            panel: Panel name. Defaults to None (current panel).
 
         Returns:
             List of plot item shapes
         """
-        items_json = self._cdl.get_object_shapes(index, group_index, panel)
+        items_json = self._cdl.get_object_shapes(nb_id_title, panel)
         return json_to_items(items_json)
 
     def add_annotations_from_items(