New toggle_auto_refresh/toggle_show_titles methods

Author: PierreRaybaut

.vscode/settings.json

@@ -20,7 +20,7 @@
     ],
     "[python]": {
         "editor.codeActionsOnSave": {
-            "source.organizeImports": true
+            "source.organizeImports": "explicit"
         },
         "editor.defaultFormatter": "ms-python.black-formatter"
     },

CHANGELOG.md

@@ -1,5 +1,12 @@
 # DataLab Simple Client Releases #
 
+## Version 0.7.0 ##
+
+💥 Changes:
+
+* Added `toggle_auto_refresh` method to `SimpleRemoteProxy`
+* Added `toggle_show_titles` method to `SimpleRemoteProxy`
+
 ## Version 0.6.0 ##
 
 💥 Changes:

cdlclient/__init__.py

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

cdlclient/baseproxy.py

@@ -117,6 +117,22 @@ def set_current_panel(self, panel: str) -> None:
     def reset_all(self) -> None:
         """Reset all application data"""
 
+    @abc.abstractmethod
+    def toggle_auto_refresh(self, state: bool) -> None:
+        """Toggle auto refresh state.
+
+        Args:
+            state (bool): Auto refresh state
+        """
+
+    @abc.abstractmethod
+    def toggle_show_titles(self, state: bool) -> None:
+        """Toggle show titles state.
+
+        Args:
+            state (bool): Show titles state
+        """
+
     @abc.abstractmethod
     def save_to_h5_file(self, filename: str) -> None:
         """Save to a DataLab HDF5 file.
@@ -465,6 +481,53 @@ def reset_all(self) -> None:
         """Reset all application data"""
         self._cdl.reset_all()
 
+    def toggle_auto_refresh(self, state: bool) -> None:
+        """Toggle auto refresh state.
+
+        Args:
+            state (bool): Auto refresh state
+        """
+        self._cdl.toggle_auto_refresh(state)
+
+    # Returns a context manager to temporarily disable autorefresh
+    def context_no_refresh(self) -> Callable:
+        """Return a context manager to temporarily disable auto refresh.
+
+        Returns:
+            Context manager
+
+        Example:
+
+            >>> with proxy.context_no_refresh():
+            ...     proxy.add_image("image1", data1)
+            ...     proxy.compute_fft()
+            ...     proxy.compute_wiener()
+            ...     proxy.compute_ifft()
+            ...     # Auto refresh is disabled during the above operations
+        """
+
+        class NoRefreshContextManager:
+            """Context manager to temporarily disable auto refresh"""
+
+            def __init__(self, cdl: SimpleAbstractCDLControl) -> None:
+                self._cdl = cdl
+
+            def __enter__(self) -> None:
+                self._cdl.toggle_auto_refresh(False)
+
+            def __exit__(self, exc_type, exc_value, traceback) -> None:
+                self._cdl.toggle_auto_refresh(True)
+
+        return NoRefreshContextManager(self)
+
+    def toggle_show_titles(self, state: bool) -> None:
+        """Toggle show titles state.
+
+        Args:
+            state (bool): Show titles state
+        """
+        self._cdl.toggle_show_titles(state)
+
     def save_to_h5_file(self, filename: str) -> None:
         """Save to a DataLab HDF5 file.
 

doc/remote_example.py

@@ -28,18 +28,24 @@
 
 # %% Executing commands in DataLab (...)
 
+proxy.toggle_auto_refresh(False)  # Turning off auto-refresh
 x = np.array([1.0, 2.0, 3.0])
 y = np.array([4.0, 5.0, -1.0])
 proxy.add_signal("toto", x, y)
 
 # %% Executing commands in DataLab (...)
 
 proxy.compute_derivative()
+proxy.toggle_auto_refresh(True)  # Turning on auto-refresh
 
 # %% Executing commands in DataLab (...)
 
 proxy.set_current_panel("image")
 
-# %% Executing commands in DataLab (...)
+# %% Executing a lot of commands without refreshing DataLab
 
-proxy.compute_fft()
+z = np.random.rand(400, 400)
+proxy.add_image("foobar", z)
+with proxy.context_no_refresh():
+    for _idx in range(100):
+        proxy.compute_fft()