Renamed switch_to_panel to set_current_panel

Author: PierreRaybaut

CHANGELOG.md

@@ -6,6 +6,8 @@ Changes:
 
 * Remote API:
   * 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
 
 ## Version 0.3.0 ##
 

cdlclient/baseproxy.py

@@ -98,7 +98,15 @@ def raise_window(self) -> None:
         """Raise DataLab window"""
 
     @abc.abstractmethod
-    def switch_to_panel(self, panel: str) -> None:
+    def get_current_panel(self) -> str:
+        """Return current panel name.
+
+        Returns:
+            str: Panel name (valid values: "signal", "image", "macro"))
+        """
+
+    @abc.abstractmethod
+    def set_current_panel(self, panel: str) -> None:
         """Switch to panel.
 
         Args:
@@ -428,13 +436,21 @@ def raise_window(self) -> None:
         """Raise DataLab window"""
         self._cdl.raise_window()
 
-    def switch_to_panel(self, panel: str) -> None:
+    def get_current_panel(self) -> str:
+        """Return current panel name.
+
+        Returns:
+            str: Panel name (valid values: "signal", "image", "macro"))
+        """
+        return self._cdl.get_current_panel()
+
+    def set_current_panel(self, panel: str) -> None:
         """Switch to panel.
 
         Args:
             panel (str): Panel name (valid values: "signal", "image", "macro"))
         """
-        self._cdl.switch_to_panel(panel)
+        self._cdl.set_current_panel(panel)
 
     def reset_all(self) -> None:
         """Reset all application data"""

cdlclient/tests/remoteclient_unit.py

@@ -65,7 +65,8 @@ def multiple_commands(remote: SimpleRemoteProxy):
         remote.reset_all()
         remote.open_h5_files([fname], True, False)
         remote.import_h5_file(fname, True)
-        remote.switch_to_panel("signal")
+        remote.set_current_panel("signal")
+        assert remote.get_current_panel() == "signal"
         remote.calc("log10")
 
         remote.calc("fft")