New DataLabConnectionDialog widget

Author: PierreRaybaut

.vscode/tasks.json

@@ -200,6 +200,9 @@
                 "clear": true
             },
             "dependsOrder": "sequence",
+            "dependsOn": [
+                "Clean Up"
+            ]
         },
     ]
 }

CHANGELOG.md

@@ -1,10 +1,23 @@
 # DataLab Simple Client Releases #
 
+## Version 0.5.0 ##
+
+💥 Changes:
+
+* Remote API (`SimpleRemoteProxy`):
+  * Added `is_connected` method
+
+* New `widgets` module:
+  * New `DataLabConnectionDialog` class:
+    * Ready-to-use dialog box to connect to a DataLab server
+    * `from cdlclient.widgets import DataLabConnectionDialog`
+    * See example in `cdlclient/tests/connect_dialog.py`
+
 ## Version 0.4.0 ##
 
-Changes:
+💥 Changes:
 
-* Remote API:
+* Remote API (`SimpleRemoteProxy`):
   * Added dict-like interface (e.g. `proxy['obj123']`)
   * Renamed `switch_to_panel` method to `set_current_panel` (compatibility with DataLab 0.9)
   * Added `get_current_panel` method
@@ -13,9 +26,9 @@ Changes:
 
 ## Version 0.3.0 ##
 
-Changes:
+💥 Changes:
 
-* Remote API:
+* Remote API (`SimpleRemoteProxy`):
   * `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
@@ -26,9 +39,9 @@ Changes:
 
 ## Version 0.2.0 ##
 
-Changes:
+💥 Changes:
 
-* Remote API:
+* Remote API (`SimpleRemoteProxy`):
   * New `raise_window` method
   * New `get_object_shapes` method
   * New `get_object` method

cdlclient/__init__.py

@@ -13,10 +13,11 @@
 .. _DataLab: https://codra-ingenierie-informatique.github.io/DataLab/
 """
 
+# pylint: disable=unused-import
 from cdlclient.baseproxy import SimpleBaseProxy
 from cdlclient.remote import SimpleRemoteProxy
 
-__version__ = "0.4.0"
+__version__ = "0.5.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/tests/connect_dialog.py

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

cdlclient/tests/convert_png_to_code.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+"""Convert PNG image to Python code"""
+
+# 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 convert_png_to_code(filename: str) -> bytes:
+    """Convert PNG image to Python code, so that it can be bundled with the
+    application, without having to load the image from disk."""
+    image = QG.QImage(filename)
+    data = QC.QByteArray()
+    buf = QC.QBuffer(data)
+    image.save(buf, "PNG")
+    return data.toBase64().data()
+
+
+def test_conv(filename: str, destmod: str) -> str:
+    """Test image to code conversion"""
+    with qt_app_context(exec_loop=True):
+        widget = QW.QWidget()
+        vlayout = QW.QVBoxLayout()
+        widget.setLayout(vlayout)
+        label1 = QW.QLabel()
+        label1.setPixmap(QG.QPixmap(filename))
+        label2 = QW.QLabel()
+        data = convert_png_to_code(filename)
+        destmod_path = osp.join(WIDGETS_PATH, destmod + ".py")
+        with open(destmod_path, "wb") as fn:
+            fn.write("DATA = b'".encode("utf-8"))
+            fn.write(data)
+            fn.write("'".encode("utf-8"))
+        mod = __import__("cdlclient.widgets." + destmod, fromlist=[destmod])
+        pixmap = QG.QPixmap()
+        pixmap.loadFromData(QC.QByteArray.fromBase64(mod.DATA))
+        label2.setPixmap(pixmap)
+        vlayout.addWidget(label1)
+        vlayout.addWidget(label2)
+        widget.show()
+
+
+if __name__ == "__main__":
+    test_conv(osp.join(RES_PATH, "DataLab-Banner-200.png"), "datalab_banner")

cdlclient/tests/remoteclient_app.py

@@ -15,18 +15,17 @@
 from __future__ import annotations
 
 import functools
-from collections.abc import Callable
 from contextlib import contextmanager
 
 import numpy as np
 from guidata.env import execenv
-from guidata.qthelpers import qt_app_context, qt_wait, win32_fix_title_bar_background
-from qtpy import QtCore as QC
+from guidata.qthelpers import qt_app_context, qt_wait
 from qtpy import QtWidgets as QW
 
 from cdlclient import SimpleRemoteProxy
 from cdlclient.tests.remoteclient_base import AbstractClientWindow
 from cdlclient.tests.remoteclient_unit import multiple_commands
+from cdlclient.widgets import DataLabConnectionDialog
 
 APP_NAME = "Remote client test"
 
@@ -56,80 +55,6 @@ def method_wrapper(*args, **kwargs):
     return try_send_command_decorator
 
 
-class DataLabConnectionThread(QC.QThread):
-    """DataLab Connection thread"""
-
-    SIG_CONNECTION_OK = QC.Signal()
-    SIG_CONNECTION_KO = QC.Signal()
-
-    def __init__(self, connect_callback: Callable, parent: QC.QObject = None) -> None:
-        super().__init__(parent)
-        self.connect_callback = connect_callback
-
-    def run(self) -> None:
-        """Run thread"""
-        try:
-            self.connect_callback()
-            self.SIG_CONNECTION_OK.emit()
-        except ConnectionRefusedError:
-            self.SIG_CONNECTION_KO.emit()
-
-
-class DataLabConnectionDialog(QW.QDialog):
-    """DataLab Connection dialog
-
-    Args:
-        connect_callback: Callback function to connect to DataLab server
-        parent: Parent widget. Defaults to None.
-    """
-
-    def __init__(self, connect_callback: Callable, parent: QW.QWidget = None) -> None:
-        super().__init__(parent)
-        win32_fix_title_bar_background(self)
-        self.setWindowTitle("Connection to DataLab")
-        self.setMinimumWidth(300)
-        self.host_label = QW.QLabel("Host:")
-        self.progress_bar = QW.QProgressBar()
-        self.progress_bar.setRange(0, 0)
-        self.status_label = QW.QLabel("Waiting for connection...")
-        layout = QW.QVBoxLayout()
-        layout.addWidget(self.host_label)
-        layout.addWidget(self.progress_bar)
-        layout.addWidget(self.status_label)
-        self.setLayout(layout)
-        self.thread = DataLabConnectionThread(connect_callback)
-        self.thread.SIG_CONNECTION_OK.connect(self.on_connection_successful)
-        self.thread.SIG_CONNECTION_KO.connect(self.on_connection_failed)
-        button_box = QW.QDialogButtonBox(QW.QDialogButtonBox.Cancel)
-        button_box.rejected.connect(self.reject)
-        layout.addWidget(button_box)
-
-    def exec(self) -> int:
-        """Execute dialog"""
-        self.connect_to_server()
-        return super().exec()
-
-    def connect_to_server(self) -> None:
-        """Connect to server"""
-        self.progress_bar.setRange(0, 0)
-        self.status_label.setText("Connecting to server...")
-        self.thread.start()
-
-    def on_connection_successful(self) -> None:
-        """Connection successful"""
-        self.progress_bar.setRange(0, 1)
-        self.progress_bar.setValue(1)
-        self.status_label.setText("Connection successful!")
-        self.accept()
-
-    def on_connection_failed(self) -> None:
-        """Connection failed"""
-        self.progress_bar.setRange(0, 1)
-        self.progress_bar.setValue(1)
-        self.status_label.setText("Connection failed.")
-        self.reject()
-
-
 class HostWindow(AbstractClientWindow):
     """Test main view"""
 
@@ -149,7 +74,6 @@ def init_cdl(self):
         if self.cdl is None:
             self.cdl: SimpleRemoteProxy = SimpleRemoteProxy()
             connect_dlg = DataLabConnectionDialog(self.cdl.connect, self)
-            connect_dlg.host_label.setText("Host: DataLab server")
             ok = connect_dlg.exec()
             if ok:
                 self.host.log("✨ Initialized DataLab connection ✨")

cdlclient/widgets/__init__.py

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+"""
+DataLab Simple Client Widgets
+-----------------------------
+
+This module requires `guidata`_ and `qtpy`_ packages.
+
+.. _guidata: https://pypi.org/project/guidata/
+.. _qtpy: https://pypi.org/project/QtPy/
+
+"""
+
+# pylint: disable=unused-import
+from cdlclient.widgets.connection import DataLabConnectionDialog