bec-widgets 0.46.3__tar.gz → 0.46.5__tar.gz

{bec_widgets-0.46.3 → bec_widgets-0.46.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bec_widgets
-Version: 0.46.3
+Version: 0.46.5
 Summary: BEC Widgets
 Home-page: https://gitlab.psi.ch/bec/bec-widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec-widgets/issues

{bec_widgets-0.46.3 → bec_widgets-0.46.5}/bec_widgets/cli/client.py

@@ -6,14 +6,13 @@ from bec_widgets.cli.client_utils import BECFigureClientMixin, RPCBase, rpc_call
 
 
 class BECPlotBase(RPCBase):
+    @property
     @rpc_call
-    def get_config(self, dict_output: "bool" = True) -> "dict | BaseModel":
+    def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
-        Args:
-            dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
         Returns:
-            dict: The configuration of the plot widget.
+            dict: The configuration of the widget.
         """
 
     @rpc_call
@@ -137,6 +136,15 @@ class BECPlotBase(RPCBase):
 
 
 class BECWaveform(RPCBase):
+    @property
+    @rpc_call
+    def config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+        Returns:
+            dict: The configuration of the widget.
+        """
+
     @rpc_call
     def add_curve_scan(
         self,
@@ -258,16 +266,6 @@ class BECWaveform(RPCBase):
             dict | pd.DataFrame: Data of all curves in the specified format.
         """
 
-    @rpc_call
-    def get_config(self, dict_output: "bool" = True) -> "dict | BaseModel":
-        """
-        Get the configuration of the widget.
-        Args:
-            dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
-        Returns:
-            dict: The configuration of the plot widget.
-        """
-
     @rpc_call
     def set(self, **kwargs) -> "None":
         """
@@ -389,6 +387,15 @@ class BECWaveform(RPCBase):
 
 
 class BECFigure(RPCBase, BECFigureClientMixin):
+    @property
+    @rpc_call
+    def config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+        Returns:
+            dict: The configuration of the widget.
+        """
+
     @property
     @rpc_call
     def axes(self) -> "list[BECPlotBase]":
@@ -607,18 +614,17 @@ class BECFigure(RPCBase, BECFigureClientMixin):
         Clear all widgets from the figure and reset to default state
         """
 
+
+class BECCurve(RPCBase):
+    @property
     @rpc_call
-    def get_config(self, dict_output: "bool" = True) -> "dict | BaseModel":
+    def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
-        Args:
-            dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
         Returns:
-            dict: The configuration of the plot widget.
+            dict: The configuration of the widget.
         """
 
-
-class BECCurve(RPCBase):
     @rpc_call
     def set(self, **kwargs):
         """
@@ -705,18 +711,17 @@ class BECCurve(RPCBase):
             tuple[np.ndarray,np.ndarray]: X and Y data of the curve.
         """
 
+
+class BECImageShow(RPCBase):
+    @property
     @rpc_call
-    def get_config(self, dict_output: "bool" = True) -> "dict | BaseModel":
+    def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
-        Args:
-            dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
         Returns:
-            dict: The configuration of the plot widget.
+            dict: The configuration of the widget.
         """
 
-
-class BECImageShow(RPCBase):
     @rpc_call
     def add_image_by_config(self, config: "ImageItemConfig | dict") -> "BECImageItem":
         """
@@ -740,14 +745,6 @@ class BECImageShow(RPCBase):
             ImageItemConfig|dict: The configuration of the image.
         """
 
-    @rpc_call
-    def get_image_list(self) -> "list[BECImageItem]":
-        """
-        Get the list of images.
-        Returns:
-            list[BECImageItem]: The list of images.
-        """
-
     @rpc_call
     def get_image_dict(self) -> "dict[str, dict[str, BECImageItem]]":
         """
@@ -756,16 +753,6 @@ class BECImageShow(RPCBase):
             dict[str, dict[str, BECImageItem]]: The dictionary of images.
         """
 
-    @rpc_call
-    def get_config(self, dict_output: "bool" = True) -> "dict | BaseModel":
-        """
-        Get the configuration of the widget.
-        Args:
-            dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
-        Returns:
-            dict: The configuration of the plot widget.
-        """
-
     @rpc_call
     def add_monitor_image(
         self,
@@ -919,16 +906,6 @@ class BECImageShow(RPCBase):
             use_threading(bool): Whether to use threading.
         """
 
-    @rpc_call
-    def get_config(self, dict_output: "bool" = True) -> "dict | BaseModel":
-        """
-        Get the configuration of the widget.
-        Args:
-            dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
-        Returns:
-            dict: The configuration of the plot widget.
-        """
-
     @rpc_call
     def set(self, **kwargs) -> "None":
         """
@@ -1048,20 +1025,37 @@ class BECImageShow(RPCBase):
         Remove the plot widget from the figure.
         """
 
+    @property
+    @rpc_call
+    def images(self) -> "list[BECImageItem]":
+        """
+        Get the list of images.
+        Returns:
+            list[BECImageItem]: The list of images.
+        """
+
 
 class BECConnector(RPCBase):
+    @property
     @rpc_call
-    def get_config(self, dict_output: "bool" = True) -> "dict | BaseModel":
+    def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
-        Args:
-            dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
         Returns:
-            dict: The configuration of the plot widget.
+            dict: The configuration of the widget.
         """
 
 
 class BECImageItem(RPCBase):
+    @property
+    @rpc_call
+    def config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+        Returns:
+            dict: The configuration of the widget.
+        """
+
     @rpc_call
     def set(self, **kwargs):
         """
@@ -1164,17 +1158,24 @@ class BECImageItem(RPCBase):
         """
 
     @rpc_call
-    def get_config(self, dict_output: "bool" = True) -> "dict | BaseModel":
+    def get_data(self) -> "np.ndarray":
         """
-        Get the configuration of the widget.
-        Args:
-            dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
+        Get the data of the image.
         Returns:
-            dict: The configuration of the plot widget.
+            np.ndarray: The data of the image.
         """
 
 
 class BECMotorMap(RPCBase):
+    @property
+    @rpc_call
+    def config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+        Returns:
+            dict: The configuration of the widget.
+        """
+
     @rpc_call
     def change_motors(
         self,
@@ -1194,16 +1195,6 @@ class BECMotorMap(RPCBase):
             validate_bec(bool, optional): If True, validate the signal with BEC. Defaults to True.
         """
 
-    @rpc_call
-    def get_config(self, dict_output: "bool" = True) -> "dict | BaseModel":
-        """
-        Get the configuration of the widget.
-        Args:
-            dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
-        Returns:
-            dict: The configuration of the plot widget.
-        """
-
     @rpc_call
     def set_max_points(self, max_points: "int") -> "None":
         """
@@ -1243,3 +1234,11 @@ class BECMotorMap(RPCBase):
         Args:
             scatter_size(int): Size of the scatter points.
         """
+
+    @rpc_call
+    def get_data(self) -> "dict":
+        """
+        Get the data of the motor map.
+        Returns:
+            dict: Data of the motor map.
+        """

{bec_widgets-0.46.3 → bec_widgets-0.46.5}/bec_widgets/cli/client_utils.py

@@ -82,8 +82,9 @@ def update_script(figure: BECFigure, msg):
         print(f"Scan {scan_number} is running")
         dev_x = scan_report_devices[0]
         dev_y = scan_report_devices[1]
+        dev_z = get_selected_device(monitored_devices, figure.selected_device)
         figure.clear_all()
-        plt = figure.plot(dev_x, dev_y, label=f"Scan {scan_number}")
+        plt = figure.plot(dev_x, dev_y, dev_z, label=f"Scan {scan_number}")
         plt.set(title=f"Scan {scan_number}", x_label=dev_x, y_label=dev_y)
     elif scan_report_devices:
         dev_x = scan_report_devices[0]

{bec_widgets-0.46.3 → bec_widgets-0.46.5}/bec_widgets/cli/server.py

@@ -12,9 +12,9 @@ from bec_widgets.widgets.plots import BECCurve, BECImageShow, BECWaveform
 class BECWidgetsCLIServer:
     WIDGETS = [BECWaveform, BECFigure, BECCurve, BECImageShow]
 
-    def __init__(self, gui_id: str = None, dispatcher: BECDispatcher = None) -> None:
+    def __init__(self, gui_id: str = None, dispatcher: BECDispatcher = None, client=None) -> None:
         self.dispatcher = BECDispatcher() if dispatcher is None else dispatcher
-        self.client = self.dispatcher.client
+        self.client = self.dispatcher.client if client is None else client
         self.client.start()
         self.gui_id = gui_id
         self.fig = BECFigure(gui_id=self.gui_id)

bec_widgets-0.46.5/bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -0,0 +1,102 @@
+import os
+
+import numpy as np
+import pyqtgraph as pg
+from pyqtgraph.Qt import uic
+from qtconsole.inprocess import QtInProcessKernelManager
+from qtconsole.rich_jupyter_widget import RichJupyterWidget
+from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
+
+from bec_widgets.utils import BECDispatcher
+from bec_widgets.widgets import BECFigure
+
+
+class JupyterConsoleWidget(RichJupyterWidget):  # pragma: no cover:
+    def __init__(self):
+        super().__init__()
+
+        self.kernel_manager = QtInProcessKernelManager()
+        self.kernel_manager.start_kernel(show_banner=False)
+        self.kernel_client = self.kernel_manager.client()
+        self.kernel_client.start_channels()
+
+        self.kernel_manager.kernel.shell.push({"np": np, "pg": pg})
+        # self.set_console_font_size(70)
+
+    def shutdown_kernel(self):
+        self.kernel_client.stop_channels()
+        self.kernel_manager.shutdown_kernel()
+
+
+class JupyterConsoleWindow(QWidget):  # pragma: no cover:
+    """A widget that contains a Jupyter console linked to BEC Widgets with full API access (contains Qt and pyqtgraph API)."""
+
+    def __init__(self, parent=None):
+        super().__init__(parent)
+
+        current_path = os.path.dirname(__file__)
+        uic.loadUi(os.path.join(current_path, "jupyter_console_window.ui"), self)
+
+        self._init_ui()
+
+        self.splitter.setSizes([200, 100])
+        self.safe_close = False
+        # self.figure.clean_signal.connect(self.confirm_close)
+
+        # console push
+        self.console.kernel_manager.kernel.shell.push(
+            {
+                "fig": self.figure,
+                "w1": self.w1,
+                "w2": self.w2,
+                "w3": self.w3,
+                "bec": self.figure.client,
+                "scans": self.figure.client.scans,
+                "dev": self.figure.client.device_manager.devices,
+            }
+        )
+
+    def _init_ui(self):
+        # Plotting window
+        self.glw_1_layout = QVBoxLayout(self.glw)  # Create a new QVBoxLayout
+        self.figure = BECFigure(parent=self, gui_id="remote")  # Create a new BECDeviceMonitor
+        self.glw_1_layout.addWidget(self.figure)  # Add BECDeviceMonitor to the layout
+
+        # add stuff to figure
+        self._init_figure()
+
+        self.console_layout = QVBoxLayout(self.widget_console)
+        self.console = JupyterConsoleWidget()
+        self.console_layout.addWidget(self.console)
+        self.console.set_default_style("linux")
+
+    def _init_figure(self):
+        self.figure.plot("samx", "bpm4d")
+        self.figure.motor_map("samx", "samy")
+        self.figure.image("eiger", color_map="viridis", vrange=(0, 100))
+
+        self.figure.change_layout(2, 2)
+
+        self.w1 = self.figure[0, 0]
+        self.w2 = self.figure[0, 1]
+        self.w3 = self.figure[1, 0]
+
+        # curves for w1
+        self.w1.add_curve_scan("samx", "samy", "bpm4i", pen_style="dash")
+        self.w1.add_curve_scan("samx", "samy", "bpm3a", pen_style="dash")
+        self.c1 = self.w1.get_config()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    bec_dispatcher = BECDispatcher()
+    client = bec_dispatcher.client
+    client.start()
+
+    app = QApplication(sys.argv)
+    app.setApplicationName("Jupyter Console")
+    win = JupyterConsoleWindow()
+    win.show()
+
+    sys.exit(app.exec_())

{bec_widgets-0.46.3 → bec_widgets-0.46.5}/bec_widgets/utils/bec_connector.py

@@ -31,7 +31,7 @@ class ConnectionConfig(BaseModel):
 class BECConnector:
     """Connection mixin class for all BEC widgets, to handle BEC client and device manager"""
 
-    USER_ACCESS = ["get_config"]
+    USER_ACCESS = ["config_dict"]
 
     def __init__(self, client=None, config: ConnectionConfig = None, gui_id: str = None):
         # BEC related connections
@@ -54,6 +54,24 @@ class BECConnector:
         else:
             self.gui_id = self.config.gui_id
 
+    @property
+    def config_dict(self) -> dict:
+        """
+        Get the configuration of the widget.
+        Returns:
+            dict: The configuration of the widget.
+        """
+        return self.config.model_dump()
+
+    @config_dict.setter
+    def config_dict(self, config: BaseModel) -> None:
+        """
+        Get the configuration of the widget.
+        Returns:
+            dict: The configuration of the widget.
+        """
+        self.config = config
+
     @pyqtSlot(str)
     def set_gui_id(self, gui_id: str) -> None:
         """

{bec_widgets-0.46.3 → bec_widgets-0.46.5}/bec_widgets/utils/bec_dispatcher.py

@@ -82,8 +82,9 @@ class BECDispatcher:
             return
 
         self._slots = collections.defaultdict(set)
+        self.client = client
 
-        if client is None:
+        if self.client is None:
             self.client = BECClient(connector_cls=QtRedisConnector, forced=True)
         else:
             if self.client.started:

{bec_widgets-0.46.3 → bec_widgets-0.46.5}/bec_widgets/widgets/figure/figure.py

@@ -97,6 +97,7 @@ class WidgetHandler:
 
 class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     USER_ACCESS = [
+        "config_dict",
         "axes",
         "widgets",
         "add_plot",
@@ -109,7 +110,6 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         "change_layout",
         "change_theme",
         "clear_all",
-        "get_config",
     ]
 
     clean_signal = pyqtSignal()
@@ -227,7 +227,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
                 y_entry=y_entry,
                 z_entry=z_entry,
                 color=color,
-                color_map=color_map_z,
+                color_map_z=color_map_z,
                 label=label,
                 validate=validate,
             )
@@ -313,7 +313,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
                 y_entry=y_entry,
                 z_entry=z_entry,
                 color=color,
-                color_map=color_map_z,
+                color_map_z=color_map_z,
                 label=label,
                 validate=validate,
             )
@@ -787,8 +787,8 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
 
     def clear_all(self):
         """Clear all widgets from the figure and reset to default state"""
-        for widget in self._widgets.values():
-            widget.cleanup()
+        # for widget in self._widgets.values():
+        #     widget.cleanup()
         self.clear()
         self._widgets = defaultdict(dict)
         self.grid = []
@@ -796,158 +796,3 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         self.config = FigureConfig(
             widget_class=self.__class__.__name__, gui_id=self.gui_id, theme=theme
         )
-
-
-##################################################
-##################################################
-# Debug window
-##################################################
-##################################################
-
-from qtconsole.inprocess import QtInProcessKernelManager
-from qtconsole.rich_jupyter_widget import RichJupyterWidget
-
-
-class JupyterConsoleWidget(RichJupyterWidget):  # pragma: no cover:
-    def __init__(self):
-        super().__init__()
-
-        self.kernel_manager = QtInProcessKernelManager()
-        self.kernel_manager.start_kernel(show_banner=False)
-        self.kernel_client = self.kernel_manager.client()
-        self.kernel_client.start_channels()
-
-        self.kernel_manager.kernel.shell.push({"np": np, "pg": pg})
-        # self.set_console_font_size(70)
-
-    def shutdown_kernel(self):
-        self.kernel_client.stop_channels()
-        self.kernel_manager.shutdown_kernel()
-
-
-class DebugWindow(QWidget):  # pragma: no cover:
-    """Debug window for BEC widgets"""
-
-    def __init__(self, parent=None):
-        super().__init__(parent)
-
-        current_path = os.path.dirname(__file__)
-        uic.loadUi(os.path.join(current_path, "figure_debug_minimal.ui"), self)
-
-        self._init_ui()
-
-        self.splitter.setSizes([200, 100])
-        self.safe_close = False
-        # self.figure.clean_signal.connect(self.confirm_close)
-
-        # console push
-        self.console.kernel_manager.kernel.shell.push(
-            {
-                "fig": self.figure,
-                "w1": self.w1,
-                "w2": self.w2,
-                "w3": self.w3,
-                "w4": self.w4,
-                "bec": self.figure.client,
-                "scans": self.figure.client.scans,
-                "dev": self.figure.client.device_manager.devices,
-            }
-        )
-
-    def _init_ui(self):
-        # Plotting window
-        self.glw_1_layout = QVBoxLayout(self.glw)  # Create a new QVBoxLayout
-        self.figure = BECFigure(parent=self, gui_id="remote")  # Create a new BECDeviceMonitor
-        self.glw_1_layout.addWidget(self.figure)  # Add BECDeviceMonitor to the layout
-
-        # add stuff to figure
-        self._init_figure()
-
-        self.console_layout = QVBoxLayout(self.widget_console)
-        self.console = JupyterConsoleWidget()
-        self.console_layout.addWidget(self.console)
-        self.console.set_default_style("linux")
-
-    def _init_figure(self):
-        # self.figure.add_widget(widget_type="Waveform1D", row=0, col=0, title="Widget 1")
-        self.figure.plot("samx", "bpm4d")
-        self.figure.add_widget(widget_type="Waveform1D", row=0, col=1, title="Widget 2")
-        self.figure.add_image(
-            title="Image", row=1, col=0, color_map="viridis", color_bar="simple", vrange=(0, 100)
-        )
-        self.figure.add_image(title="Image", row=1, col=1, vrange=(0, 100))
-
-        self.w1 = self.figure[0, 0]
-        self.w2 = self.figure[0, 1]
-        self.w3 = self.figure[1, 0]
-        self.w4 = self.figure[1, 1]
-
-        # curves for w1
-        self.w1.add_curve_scan("samx", "samy", "bpm4i", pen_style="dash")
-        self.w1.add_curve_scan("samx", "samy", "bpm3a", pen_style="dash")
-
-        # self.w1.add_curve_custom(
-        #     x=[1, 2, 3, 4, 5],
-        #     y=[1, 2, 3, 4, 5],
-        #     label="curve-custom",
-        #     color="blue",
-        #     pen_style="dashdot",
-        # )
-        self.c1 = self.w1.get_config()
-
-        # curves for w2
-        self.w2.add_curve_scan("samx", "bpm3a", pen_style="solid")
-        self.w2.add_curve_scan("samx", "bpm4d", pen_style="dot")
-        self.w2.add_curve_custom(
-            x=[1, 2, 3, 4, 5], y=[5, 4, 3, 2, 1], color="red", pen_style="dashdot"
-        )
-
-        # curves for w3
-        # self.w3.add_curve_scan("samx", "bpm4i", pen_style="dash")
-        # self.w3.add_curve_custom(
-        #     x=[1, 2, 3, 4, 5],
-        #     y=[1, 2, 3, 4, 5],
-        #     label="curve-custom",
-        #     color="blue",
-        #     pen_style="dashdot",
-        # )
-
-        # curves for w4
-        # self.w4.add_curve_scan("samx", "bpm4i", pen_style="dash")
-        # self.w4.add_curve_custom(
-        #     x=[1, 2, 3, 4, 5],
-        #     y=[1, 2, 3, 4, 5],
-        #     label="curve-custom",
-        #     color="blue",
-        #     pen_style="dashdot",
-        # )
-
-        # Image setting for w3
-
-        self.w3.add_monitor_image("eiger", vrange=(0, 100), color_bar="full")
-
-        # Image setting for w4
-        self.w4.add_monitor_image("eiger", vrange=(0, 100), color_map="viridis")
-
-    # def confirm_close(self):
-    #     self.safe_close = True
-    #
-    # def closeEvent(self, event):
-    #     self.figure.cleanup()
-    #     if self.safe_close == True:
-    #         print("Safe close")
-    #         event.accept()
-
-
-if __name__ == "__main__":  # pragma: no cover
-    import sys
-
-    bec_dispatcher = BECDispatcher()
-    client = bec_dispatcher.client
-    client.start()
-
-    app = QApplication(sys.argv)
-    win = DebugWindow()
-    win.show()
-
-    sys.exit(app.exec_())