Added GetObjectDialog widget

Author: PierreRaybaut

.vscode/launch.json

@@ -26,6 +26,9 @@
             "envFile": "${workspaceFolder}/.env",
             "python": "${config:python.defaultInterpreterPath}",
             "justMyCode": false,
+            "env": {
+                "QT_COLOR_MODE": "light",
+            }
         },
         {
             "name": "Run current file (unattended)",

CHANGELOG.md

@@ -1,5 +1,18 @@
 # DataLab Simple Client Releases #
 
+## Version 0.6.0 ##
+
+💥 Changes:
+
+* Remote API (`SimpleRemoteProxy`):
+  * Added `get_group_titles_with_object_infos` method
+
+* New `widgets` module:
+  * New `GetObjectDialog` class:
+    * Ready-to-use dialog box to retrieve an object from a DataLab server
+    * `from cdlclient.widgets import GetObjectDialog`
+    * See example in `cdlclient/tests/get_object_dialog.py`
+
 ## Version 0.5.0 ##
 
 💥 Changes:

cdlclient/__init__.py

@@ -17,6 +17,6 @@
 from cdlclient.baseproxy import SimpleBaseProxy  # noqa: F401
 from cdlclient.remote import SimpleRemoteProxy  # noqa: F401
 
-__version__ = "0.5.0"
+__version__ = "0.6.0"
 __docurl__ = "https://cdlclient.readthedocs.io/en/latest/"
 __homeurl__ = "https://github.com/Codra-Ingenierie-Informatique/DataLabSimpleClient/"

cdlclient/baseproxy.py

@@ -266,6 +266,16 @@ def delete_metadata(self, refresh_plot: bool = True) -> None:
             refresh_plot (bool | None): Refresh plot. Defaults to True.
         """
 
+    @abc.abstractmethod
+    def get_group_titles_with_object_infos(
+        self,
+    ) -> tuple[list[str], list[list[str]], list[list[str]]]:
+        """Return groups titles and lists of inner objects uuids and titles.
+
+        Returns:
+            Tuple: groups titles, lists of inner objects uuids and titles
+        """
+
     @abc.abstractmethod
     def get_object_titles(self, panel: str | None = None) -> list[str]:
         """Get object (signal/image) list for current panel.
@@ -542,6 +552,16 @@ def delete_metadata(self, refresh_plot: bool = True) -> None:
         """
         self._cdl.delete_metadata(refresh_plot)
 
+    def get_group_titles_with_object_infos(
+        self,
+    ) -> tuple[list[str], list[list[str]], list[list[str]]]:
+        """Return groups titles and lists of inner objects uuids and titles.
+
+        Returns:
+            Tuple: groups titles, lists of inner objects uuids and titles
+        """
+        return self._cdl.get_group_titles_with_object_infos()
+
     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.

cdlclient/tests/get_object_dialog.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+#
+# Licensed under the terms of the BSD 3-Clause
+# (see cdlclient/LICENSE for details)
+
+"""
+DataLab Remote client get object dialog example
+"""
+
+# guitest: show
+
+from guidata.qthelpers import qt_app_context
+
+from cdlclient import SimpleRemoteProxy
+from cdlclient.widgets import GetObjectDialog
+
+
+def test_dialog():
+    """Test connection dialog"""
+    proxy = SimpleRemoteProxy()
+    proxy.connect()
+    with qt_app_context():
+        dlg = GetObjectDialog(None, "Get object", proxy)
+        if dlg.exec():
+            obj_uuid = dlg.get_current_object_uuid()
+            obj = proxy.get_object(obj_uuid)
+            print(str(obj))
+
+
+if __name__ == "__main__":
+    test_dialog()

cdlclient/tests/imagefile_to_code.py

@@ -3,50 +3,16 @@
 
 # guitest: skip
 
-import os
 import os.path as osp
 
 from guidata.qthelpers import qt_app_context
 from qtpy import QtCore as QC
 from qtpy import QtGui as QG
 from qtpy import QtWidgets as QW
 
-PKG_PATH = osp.join(osp.dirname(__file__), os.pardir, os.pardir)
-RES_PATH = osp.join(PKG_PATH, "resources")
-WIDGETS_PATH = osp.join(PKG_PATH, "cdlclient", "widgets")
-
-
-def imagefile_to_base64(filename: str) -> bytes:
-    """Convert image file to Base64-encoded bytes
-
-    Args:
-        filename: image filename
-
-    Returns:
-        Base64-encoded bytes
-    """
-    image = QG.QImage(filename)
-    data = QC.QByteArray()
-    buf = QC.QBuffer(data)
-    image.save(buf, "PNG")
-    return data.toBase64().data()
+from cdlclient.widgets.qthelpers import PKG_PATH, imagefile_to_python_module
 
-
-def imagefile_to_python_module(filename: str, destmod: str) -> None:
-    """Convert image file to Python module
-
-    Args:
-        filename: image filename
-        destmod: destination module name
-    """
-    data = imagefile_to_base64(filename)
-    destmod_path = osp.join(WIDGETS_PATH, destmod + ".py")
-    with open(destmod_path, "wb") as fn:
-        fn.write("# -*- coding: utf-8 -*-\n\n".encode("utf-8"))
-        fn.write("# pylint: skip-file\n\n".encode("utf-8"))
-        fn.write("DATA = b'".encode("utf-8"))
-        fn.write(data)
-        fn.write("'".encode("utf-8"))
+RES_PATH = osp.join(PKG_PATH, "resources")
 
 
 def test_conv(filename: str, destmod: str) -> None:
@@ -75,3 +41,4 @@ def test_conv(filename: str, destmod: str) -> None:
 
 if __name__ == "__main__":
     test_conv(osp.join(RES_PATH, "DataLab-Banner-200.png"), "datalab_banner")
+    test_conv(osp.join(RES_PATH, "DataLab-Banner-200.png"), "datalab_banner")

cdlclient/tests/remoteclient_app.py

@@ -25,7 +25,7 @@
 from cdlclient import SimpleRemoteProxy
 from cdlclient.tests.remoteclient_base import AbstractClientWindow
 from cdlclient.tests.remoteclient_unit import multiple_commands
-from cdlclient.widgets import ConnectionDialog
+from cdlclient.widgets import ConnectionDialog, GetObjectDialog
 
 APP_NAME = "Remote client test"
 
@@ -100,6 +100,7 @@ def add_additional_buttons(self):
         add_btn("Get object titles", self.get_object_titles, 10)
         add_btn("Get object uuids", self.get_object_uuids, 10)
         add_btn("Get object", self.get_object)
+        add_btn("Get object using dialog box", self.get_object_dialog)
 
     @try_send_command()
     def exec_multiple_cmd(self):
@@ -145,6 +146,17 @@ def get_object(self):
             else:
                 self.host.log("🏴‍☠️ Object list is empty!")
 
+    @try_send_command()
+    def get_object_dialog(self):
+        """Get object (signal/image) using dialog box"""
+        if self.cdl is not None:
+            dialog = GetObjectDialog(self, "Get object from DataLab", self.cdl)
+            if dialog.exec():
+                uuid = dialog.get_current_object_uuid()
+                obj = self.cdl.get_object(uuid)
+                self.host.log(f"Object '{obj.title}'")
+                self.host.log(str(obj))
+
     def add_signals(self):
         """Add signals to DataLab"""
         if self.cdl is not None:

cdlclient/widgets/__init__.py

@@ -12,3 +12,4 @@
 
 # pylint: disable=unused-import
 from cdlclient.widgets.connection import ConnectionDialog  # noqa: F401
+from cdlclient.widgets.objectdialog import GetObjectDialog  # noqa: F401