SimpleRemoteProxy constructor: add autoconnect=True

Author: PierreRaybaut

CHANGELOG.md

@@ -1,5 +1,19 @@
 # DataLab Simple Client Releases #
 
+## Version 0.9.0 ##
+
+DataLab Simple Client is fully compatible with **DataLab 0.11.0** and above.
+With older versions of the DataLab server, some features may not work.
+
+💥 Changes:
+
+* Remote API (`SimpleRemoteProxy`):
+  * Changed constructor signature to accept `autoconnect` as argument,
+    defaulting to `True`
+  * Thus, when creating a `SimpleRemoteProxy` instance, the connection to the
+    server is now established automatically by default (i.e. same behavior as
+    DataLab's `cdl.proxy.RemoteProxy` class)
+
 ## Version 0.8.1 ##
 
 DataLab Simple Client is fully compatible with **DataLab 0.11.0** and above.

cdlclient/__init__.py

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

cdlclient/remote.py

@@ -230,13 +230,19 @@ class SimpleRemoteProxy(SimpleBaseProxy):
     This is a subset of DataLab's `RemoteClient` class, with only the methods
     that do not require DataLab object model to be implemented.
 
+    Args:
+        autoconnect: If True, automatically connect to DataLab XML-RPC server.
+         Defaults to True.
+
+    Raises:
+        ConnectionRefusedError: DataLab is currently not running
+
     Examples:
         Here is a simple example of how to use SimpleRemoteProxy in a Python script
         or in a Jupyter notebook:
 
         >>> from cdlclient import SimpleRemoteProxy
-        >>> proxy = SimpleRemoteProxy()
-        >>> proxy.connect()
+        >>> proxy = SimpleRemoteProxy()  # autoconnect is on by default
         Connecting to DataLab XML-RPC server...OK (port: 28867)
         >>> proxy.get_version()
         '1.0.0'
@@ -254,10 +260,12 @@ class SimpleRemoteProxy(SimpleBaseProxy):
         array([1., 2., 3.])
     """
 
-    def __init__(self) -> None:
+    def __init__(self, autoconnect: bool = True) -> None:
         super().__init__()
         self.port: str = None
         self._cdl: ServerProxy
+        if autoconnect:
+            self.connect()
 
     def __connect_to_server(self, port: str | None = None) -> None:
         """Connect to DataLab XML-RPC server.

cdlclient/tests/connect_dialog.py

@@ -18,7 +18,7 @@
 
 def test_dialog():
     """Test connection dialog"""
-    proxy = SimpleRemoteProxy()
+    proxy = SimpleRemoteProxy(autoconnect=False)
     with qt_app_context():
         dlg = ConnectionDialog(proxy.connect)
         if dlg.exec():

cdlclient/tests/get_object_dialog.py

@@ -18,7 +18,6 @@
 def test_dialog():
     """Test connection dialog"""
     proxy = SimpleRemoteProxy()
-    proxy.connect()
     with qt_app_context():
         # 1. Select an image or signal object
         dlg = GetObjectDialog(None, proxy)

cdlclient/tests/remoteclient_app.py

@@ -73,7 +73,7 @@ class HostWindow(AbstractClientWindow):
     def init_cdl(self):
         """Open DataLab test"""
         if self.cdl is None:
-            self.cdl: SimpleRemoteProxy = SimpleRemoteProxy()
+            self.cdl = SimpleRemoteProxy(autoconnect=False)
             connect_dlg = ConnectionDialog(self.cdl.connect, self)
             ok = connect_dlg.exec()
             if ok:

cdlclient/tests/remoteclient_unit.py

@@ -77,7 +77,6 @@ def multiple_commands(remote: SimpleRemoteProxy):
 def test():
     """Remote client test"""
     remote = SimpleRemoteProxy()
-    remote.connect()
     execenv.print("Executing multiple commands...", end="")
     multiple_commands(remote)
     execenv.print("OK")

doc/remote_example.py

@@ -14,12 +14,11 @@
 import numpy as np
 
 # DataLab remote control client:
-from cdlclient import SimpleRemoteProxy
+from cdlclient import SimpleRemoteProxy as RemoteProxy
 
 # %% Connecting to DataLab current session
 
-proxy = SimpleRemoteProxy()
-proxy.connect()
+proxy = RemoteProxy()
 
 # %% Executing commands in DataLab (...)