Remote control API: added run/stop/import macro methods

Author: PierreRaybaut

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## Version 0.9.0 ##
 
-DataLab Simple Client is fully compatible with **DataLab 0.11.0** and above.
+DataLab Simple Client is fully compatible with **DataLab 0.13.0** and above.
 With older versions of the DataLab server, some features may not work.
 
 💥 Changes:
@@ -13,6 +13,9 @@ With older versions of the DataLab server, some features may not work.
   * 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)
+  * `get_object_titles` method now accepts "macro" as panel name and returns
+    the list of macro titles
+  * New `run_macro`, `stop_macro` and `import_macro_from_file` methods
 
 ## Version 0.8.1 ##
 

cdlclient/__init__.py

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

cdlclient/baseproxy.py

@@ -301,11 +301,11 @@ def get_object_titles(self, panel: str | None = None) -> list[str]:
         Objects are sorted by group number and object index in group.
 
         Args:
-            panel (str | None): panel name (valid values: "signal", "image").
-                If None, current panel is used.
+            panel: panel name (valid values: "signal", "image", "macro").
+             If None, current data panel is used (i.e. signal or image panel).
 
         Returns:
-            list[str]: list of object titles
+            List of object titles
 
         Raises:
             ValueError: if panel not found
@@ -390,6 +390,32 @@ def add_label_with_title(
                 If None, current panel is used.
         """
 
+    @abc.abstractmethod
+    def run_macro(self, number_or_title: int | str | None = None) -> None:
+        """Run macro.
+
+        Args:
+             number: Number of the macro (starting at 1). Defaults to None (run
+              current macro, or does nothing if there is no macro).
+        """
+
+    @abc.abstractmethod
+    def stop_macro(self, number_or_title: int | str | None = None) -> None:
+        """Stop macro.
+
+        Args:
+            number: Number of the macro (starting at 1). Defaults to None (stop
+             current macro, or does nothing if there is no macro).
+        """
+
+    @abc.abstractmethod
+    def import_macro_from_file(self, filename: str) -> None:
+        """Import macro from file
+
+        Args:
+            filename: Filename.
+        """
+
     @abc.abstractmethod
     def calc(self, name: str, param: gds.DataSet | None = None) -> gds.DataSet:
         """Call compute function ``name`` in current panel's processor.
@@ -636,11 +662,11 @@ def get_object_titles(self, panel: str | None = None) -> list[str]:
         Objects are sorted by group number and object index in group.
 
         Args:
-            panel (str | None): panel name (valid values: "signal", "image").
-                If None, current panel is used.
+            panel: panel name (valid values: "signal", "image", "macro").
+             If None, current data panel is used (i.e. signal or image panel).
 
         Returns:
-            list[str]: list of object titles
+            List of object titles
 
         Raises:
             ValueError: if panel not found
@@ -675,3 +701,29 @@ def add_label_with_title(
                 If None, current panel is used.
         """
         self._cdl.add_label_with_title(title, panel)
+
+    def run_macro(self, number_or_title: int | str | None = None) -> None:
+        """Run macro.
+
+        Args:
+             number: Number of the macro (starting at 1). Defaults to None (run
+              current macro, or does nothing if there is no macro).
+        """
+        self._cdl.run_macro(number_or_title)
+
+    def stop_macro(self, number_or_title: int | str | None = None) -> None:
+        """Stop macro.
+
+        Args:
+            number: Number of the macro (starting at 1). Defaults to None (stop
+             current macro, or does nothing if there is no macro).
+        """
+        self._cdl.stop_macro(number_or_title)
+
+    def import_macro_from_file(self, filename: str) -> None:
+        """Import macro from file
+
+        Args:
+            filename: Filename.
+        """
+        return self._cdl.import_macro_from_file(filename)