Major overhaul

Author: PierreRaybaut

.coveragerc

@@ -9,8 +9,8 @@ parallel = True
 concurrency = multiprocessing,thread
 
 omit =
-    */cdl_client/utils/tests.py
-    */cdl_client/tests/*
+    */cdlclient/utils/tests.py
+    */cdlclient/tests/*
     */guidata/*
     */plotpy/*
 

.gitignore

@@ -73,7 +73,7 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build/
-cdl_client/data/doc/
+cdlclient/data/doc/
 
 # PyBuilder
 target/

.isort.cfg

@@ -1,2 +1,2 @@
 [settings]
-known_first_party=cdl_client
+known_first_party=cdlclient

.vscode/launch.json

@@ -8,7 +8,7 @@
             "name": "Run Test Launcher",
             "type": "python",
             "request": "launch",
-            "program": "${workspaceFolder}/cdl_client/tests/__init__.py",
+            "program": "${workspaceFolder}/cdlclient/tests/__init__.py",
             "console": "integratedTerminal",
             "envFile": "${workspaceFolder}/.env",
             "python": "${config:python.defaultInterpreterPath}",

CHANGELOG.md

@@ -1,5 +1,5 @@
-# DataLab Client Releases #
+# DataLab Simple Client Releases #
 
 ## Version 0.1.0 ##
 
-First release of the DataLab Client.
+First release of the DataLab Simple Client.

README.md

@@ -1,11 +1,11 @@
-## DataLab Client
+## DataLab Simple Client
 
-![DataLab](https://raw.githubusercontent.com/Codra-Ingenierie-Informatique/DataLab_Client/main/doc/images/DataLab-banner.png)
+![DataLab](https://raw.githubusercontent.com/Codra-Ingenierie-Informatique/DataLabSimpleClient/main/doc/images/DataLab-banner.png)
 
-[![license](https://img.shields.io/pypi/l/CDL_Client.svg)](./LICENSE)
-[![pypi version](https://img.shields.io/pypi/v/CDL_Client.svg)](https://pypi.org/project/CDL_Client/)
-[![PyPI status](https://img.shields.io/pypi/status/CDL_Client.svg)](https://github.com/Codra-Ingenierie-Informatique/DataLab_Client)
-[![PyPI pyversions](https://img.shields.io/pypi/pyversions/CDL_Client.svg)](https://pypi.python.org/pypi/CDL_Client/)
+[![license](https://img.shields.io/pypi/l/cdlclient.svg)](./LICENSE)
+[![pypi version](https://img.shields.io/pypi/v/cdlclient.svg)](https://pypi.org/project/cdlclient/)
+[![PyPI status](https://img.shields.io/pypi/status/cdlclient.svg)](https://github.com/Codra-Ingenierie-Informatique/DataLabSimpleClient)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/cdlclient.svg)](https://pypi.python.org/pypi/cdlclient/)
 
 ℹ️ Created by [Codra](https://codra.net/)/[Pierre Raybaut](https://github.com/PierreRaybaut) in 2023, developed and maintained by DataLab open-source project team.
 
@@ -25,11 +25,11 @@ libraries (such as NumPy, SciPy or scikit-image) and Qt graphical user interface
 
 DataLab is available as a **stand-alone** application (see for example our all-in-one Windows installer) or as an **addon to your Python-Qt application** thanks to advanced automation and embedding features.
 
-## About the client
+## About this package
 
-This repository contains the DataLab client, which is a Python package that can be used to interact with a DataLab server.
+DataLab Simple Client is a Python library that can be used to interact with a DataLab application (server).
 
-This allows to run computations on a remote server, or/and to control the DataLab GUI from a third-party application.
+This allows to control DataLab application from a remote computer, or/and from a third-party application.
 
 ### Credits
 
@@ -40,5 +40,5 @@ Copyrights and licensing:
 
 ### Dependencies and other installation methods
 
-See [Installation](https://cdl_client.readthedocs.io/en/latest/installation.html)
+See [Installation](https://cdlclient.readthedocs.io/en/latest/installation.html)
 section in the documentation for more details.

cdl_client/__init__.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+#
+# Licensed under the terms of the BSD 3-Clause
+# (see cdlclient/LICENSE for details)
+
+"""
+DataLab Simple Client
+=====================
+
+DataLab Simple Client (`cdlclient`) is a Python library providing a proxy to `DataLab`_
+application through XML-RPC protocol.
+
+.. _DataLab: https://codra-ingenierie-informatique.github.io/DataLab/
+"""
+
+from cdlclient.baseproxy import SimpleBaseProxy
+from cdlclient.remote import SimpleRemoteProxy
+
+__version__ = "0.1.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/__init__.py

@@ -1,30 +1,13 @@
 # -*- coding: utf-8 -*-
 #
 # Licensed under the terms of the BSD 3-Clause
-# (see cdl_client/LICENSE for details)
+# (see cdlclient/LICENSE for details)
 
 """
 DataLab base proxy module
 -------------------------
 """
 
-# How to add a new method to the proxy:
-# -------------------------------------
-#
-# 1.  Add the method to the AbstractCDLControl class, as an abstract method
-#
-# 2a. If the method requires any data conversion to get through the XML-RPC layer,
-#     implement the method in both CDLProxy and RemoteClient classes
-#
-# 2b. If the method does not require any data conversion, implement the method
-#     directly in the BaseProxy class, so that it is available to both CDLProxy
-#     and RemoteClient classes without any code duplication
-#
-# 3.  Implement the method in the CDLMainWindow class
-#
-# 4.  Implement the method in the RemoteServer class (it will be automatically
-#     registered as an XML-RPC method, like all methods of AbstractCDLControl)
-
 from __future__ import annotations
 
 import abc
@@ -37,11 +20,14 @@
 if TYPE_CHECKING:
     from cdl.core.gui.main import CDLMainWindow
 
-    from cdl_client.remote import ServerProxy
+    from cdlclient.remote import ServerProxy
 
 
-class AbstractCDLControl(abc.ABC):
-    """Abstract base class for controlling DataLab (main window or remote server)"""
+class SimpleAbstractCDLControl(abc.ABC):
+    """Simple abstract base class for controlling DataLab
+
+    This is a subset of DataLab's AbstractCDLControl, with only the methods that do not
+    require DataLab object model to be implemented."""
 
     @classmethod
     def get_public_methods(cls) -> list[str]:
@@ -329,17 +315,20 @@ def compute_func(param: gds.DataSet | None = None) -> gds.DataSet:
         raise AttributeError(f"DataLab has no compute function '{name}'")
 
 
-class BaseProxy(AbstractCDLControl, metaclass=abc.ABCMeta):
-    """Common base class for DataLab proxies
+class SimpleBaseProxy(SimpleAbstractCDLControl, metaclass=abc.ABCMeta):
+    """Simple common base class for DataLab proxies
+
+    This is a subset of DataLab's BaseProxy, with only the methods that do not require
+    DataLab object model to be implemented.
 
     Args:
-        cdl_client (CDLMainWindow | ServerProxy | None): CDLMainWindow instance or
+        cdlclient (CDLMainWindow | ServerProxy | None): CDLMainWindow instance or
             ServerProxy instance. If None, then the proxy implementation will
-            have to set it later (e.g. see RemoteClient).
+            have to set it later (e.g. see SimpleRemoteProxy).
     """
 
-    def __init__(self, cdl_client: CDLMainWindow | ServerProxy | None = None) -> None:
-        self._cdl = cdl_client
+    def __init__(self, cdlclient: CDLMainWindow | ServerProxy | None = None) -> None:
+        self._cdl = cdlclient
 
     def get_version(self) -> str:
         """Return DataLab version.

cdl_client/baseproxy.py cdlclient/baseproxy.pycdl_client/baseproxy.py renamed to cdlclient/baseproxy.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # Licensed under the terms of the BSD 3-Clause
-# (see cdl_client/LICENSE for details)
+# (see cdlclient/LICENSE for details)
 
 """
 DataLab remote control
@@ -10,7 +10,8 @@
 This module provides utilities to control DataLab from a Python script (e.g. with
 Spyder) or from a Jupyter notebook.
 
-The :class:`RemoteClient` class provides the main interface to DataLab XML-RPC server.
+The :class:`SimpleRemoteProxy` class provides the main interface
+to DataLab XML-RPC server.
 """
 
 from __future__ import annotations
@@ -30,7 +31,7 @@
 from guidata.env import execenv
 from guidata.userconfig import get_config_basedir
 
-from cdl_client.baseproxy import BaseProxy
+from cdlclient.baseproxy import SimpleBaseProxy
 
 # pylint: disable=invalid-name  # Allows short reference names like x, y, ...
 # pylint: disable=duplicate-code
@@ -119,8 +120,8 @@ def json_to_dataset(param_data: list[str]) -> gds.DataSet:
 
 # === Python 2.7 client side:
 #
-# # See doc/remotecontrol_py27.py for an almost complete Python 2.7
-# # implementation of RemoteClient class
+# # See DataLab's doc/remotecontrol_py27.py for an almost complete Python 2.7
+# # implementation of SimpleRemoteProxy class
 #
 # import io
 # from xmlrpclib import ServerProxy, Binary
@@ -135,10 +136,6 @@ def json_to_dataset(param_data: list[str]) -> gds.DataSet:
 # s.add_image("toto", array_to_binary(data))
 
 
-class CDLConnectionError(Exception):
-    """Error when trying to connect to DataLab XML-RPC server"""
-
-
 def get_cdl_xmlrpc_port():
     """Return DataLab current XML-RPC port"""
     if sys.platform == "win32" and "HOME" in os.environ:
@@ -149,7 +146,7 @@ def get_cdl_xmlrpc_port():
     try:
         return ini.get("main", "rpc_server_port")
     except (cp.NoSectionError, cp.NoOptionError) as exc:
-        raise CDLConnectionError("DataLab has not yet been executed") from exc
+        raise ConnectionRefusedError("DataLab has not yet been executed") from exc
 
 
 def items_to_json(items: list) -> str | None:
@@ -170,16 +167,19 @@ def items_to_json(items: list) -> str | None:
     return None
 
 
-class RemoteClient(BaseProxy):
+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.
 
+    This is a subset of DataLab's `RemoteClient` class, with only the methods
+    that do not require DataLab object model to be implemented.
+
     Examples:
-        Here is a simple example of how to use RemoteClient in a Python script
+        Here is a simple example of how to use SimpleRemoteProxy in a Python script
         or in a Jupyter notebook:
 
-        >>> from cdl_client.remotecontrol import RemoteClient
-        >>> proxy = RemoteClient()
+        >>> from cdlclient import SimpleRemoteProxy
+        >>> proxy = SimpleRemoteProxy()
         >>> proxy.connect()
         Connecting to DataLab XML-RPC server...OK (port: 28867)
         >>> proxy.get_version()
@@ -189,9 +189,9 @@ class RemoteClient(BaseProxy):
         >>> proxy.get_object_titles()
         ['toto']
         >>> proxy.get_object_from_title("toto")
-        <cdl_client.model.signal.SignalObj at 0x7f7f1c0b4a90>
+        <cdlclient.model.signal.SignalObj at 0x7f7f1c0b4a90>
         >>> proxy.get_object(0)
-        <cdl_client.model.signal.SignalObj at 0x7f7f1c0b4a90>
+        <cdlclient.model.signal.SignalObj at 0x7f7f1c0b4a90>
         >>> proxy.get_object(0).data
         array([1., 2., 3.])
     """
@@ -209,7 +209,7 @@ def __connect_to_server(self, port: str | None = None) -> None:
                 the port is automatically retrieved from DataLab configuration.
 
         Raises:
-            CDLConnectionError: DataLab is currently not running
+            ConnectionRefusedError: DataLab is currently not running
         """
         if port is None:
             port = get_xmlrpcport_from_env()
@@ -220,7 +220,7 @@ def __connect_to_server(self, port: str | None = None) -> None:
         try:
             self.get_version()
         except ConnectionRefusedError as exc:
-            raise CDLConnectionError("DataLab is currently not running") from exc
+            raise ConnectionRefusedError("DataLab is currently not running") from exc
 
     def connect(
         self,
@@ -237,7 +237,7 @@ def connect(
             retries (int | None): Number of retries. Defaults to 10.
 
         Raises:
-            CDLConnectionError: Unable to connect to DataLab
+            ConnectionRefusedError: Unable to connect to DataLab
             ValueError: Invalid timeout (must be >= 0.0)
             ValueError: Invalid number of retries (must be >= 1)
         """
@@ -252,11 +252,11 @@ def connect(
             try:
                 self.__connect_to_server(port=port)
                 break
-            except CDLConnectionError:
+            except ConnectionRefusedError:
                 time.sleep(timeout / retries)
         else:
             execenv.print("KO")
-            raise CDLConnectionError("Unable to connect to DataLab")
+            raise ConnectionRefusedError("Unable to connect to DataLab")
         execenv.print(f"OK (port: {self.port})")
 
     def disconnect(self) -> None: