bec-widgets 0.52.0__py3-none-any.whl → 0.53.0__py3-none-any.whl

bec_widgets/cli/client_utils.py

@@ -281,6 +281,7 @@ class RPCBase:
     def _wait_for_response(self, request_id: str, timeout: int = 5):
         """
         Wait for the response from the server.
+
         Args:
             request_id(str): The request ID.
             timeout(int): The timeout in seconds.

bec_widgets/cli/generate_cli.py

@@ -41,6 +41,7 @@ from typing import Literal, Optional, overload"""
     def generate_content_for_class(self, cls):
         """
         Generate the content for the class.
+
         Args:
             cls: The class for which to generate the content.
         """

bec_widgets/cli/rpc_register.py

@@ -28,6 +28,7 @@ class RPCRegister:
     def add_rpc(self, rpc: QObject):
         """
         Add an RPC object to the register.
+
         Args:
             rpc(QObject): The RPC object to be added to the register.
         """
@@ -38,6 +39,7 @@ class RPCRegister:
     def remove_rpc(self, rpc: str):
         """
         Remove an RPC object from the register.
+
         Args:
             rpc(str): The RPC object to be removed from the register.
         """
@@ -48,6 +50,7 @@ class RPCRegister:
     def get_rpc_by_id(self, gui_id: str) -> QObject:
         """
         Get an RPC object by its ID.
+
         Args:
             gui_id(str): The ID of the RPC object to be retrieved.
 
@@ -60,6 +63,7 @@ class RPCRegister:
     def list_all_connections(self) -> dict:
         """
         List all the registered RPC objects.
+
         Returns:
             dict: A dictionary containing all the registered RPC objects.
         """

bec_widgets/cli/rpc_wigdet_handler.py

@@ -5,14 +5,13 @@ from bec_widgets.widgets.figure import BECFigure
 class RPCWidgetHandler:
     """Handler class for creating widgets from RPC messages."""
 
-    widget_classes = {
-        "BECFigure": BECFigure,
-    }
+    widget_classes = {"BECFigure": BECFigure}
 
     @staticmethod
     def create_widget(widget_type, **kwargs) -> BECConnector:
         """
         Create a widget from an RPC message.
+
         Args:
             widget_type(str): The type of the widget.
             **kwargs: The keyword arguments for the widget.

bec_widgets/examples/modular_app/modular.ui

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>MainWindow</class>
+ <widget class="QMainWindow" name="MainWindow">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>1433</width>
+    <height>689</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>MainWindow</string>
+  </property>
+  <widget class="QWidget" name="centralwidget">
+   <layout class="QGridLayout" name="gridLayout">
+    <item row="1" column="2">
+     <widget class="QLabel" name="label_3">
+      <property name="text">
+       <string>Plot  Config 2</string>
+      </property>
+     </widget>
+    </item>
+    <item row="3" column="0" colspan="2">
+     <widget class="BECMonitor" name="plot_1"/>
+    </item>
+    <item row="1" column="3">
+     <widget class="QPushButton" name="pushButton_setting_2">
+      <property name="text">
+       <string>Setting Plot 2</string>
+      </property>
+     </widget>
+    </item>
+    <item row="3" column="2" colspan="2">
+     <widget class="BECMonitor" name="plot_2"/>
+    </item>
+    <item row="1" column="4">
+     <widget class="QLabel" name="label_2">
+      <property name="text">
+       <string>Plot Scan Types = True</string>
+      </property>
+     </widget>
+    </item>
+    <item row="1" column="1">
+     <widget class="QPushButton" name="pushButton_setting_1">
+      <property name="text">
+       <string>Setting Plot 1</string>
+      </property>
+     </widget>
+    </item>
+    <item row="1" column="0">
+     <widget class="QLabel" name="label">
+      <property name="text">
+       <string>Plot Config 1</string>
+      </property>
+     </widget>
+    </item>
+    <item row="1" column="5">
+     <widget class="QPushButton" name="pushButton_setting_3">
+      <property name="text">
+       <string>Setting Plot 3</string>
+      </property>
+     </widget>
+    </item>
+    <item row="3" column="4" colspan="2">
+     <widget class="BECMonitor" name="plot_3"/>
+    </item>
+   </layout>
+  </widget>
+  <widget class="QMenuBar" name="menubar">
+   <property name="geometry">
+    <rect>
+     <x>0</x>
+     <y>0</y>
+     <width>1433</width>
+     <height>37</height>
+    </rect>
+   </property>
+  </widget>
+  <widget class="QStatusBar" name="statusbar"/>
+ </widget>
+ <customwidgets>
+  <customwidget>
+   <class>BECMonitor</class>
+   <extends>QGraphicsView</extends>
+   <header location="global">bec_widgets.widgets.h</header>
+  </customwidget>
+ </customwidgets>
+ <resources/>
+ <connections/>
+</ui>

bec_widgets/examples/modular_app/modular_app.py

@@ -0,0 +1,197 @@
+import os
+
+from qtpy import uic
+from qtpy.QtWidgets import QApplication, QMainWindow
+
+from bec_widgets.utils.bec_dispatcher import BECDispatcher
+from bec_widgets.widgets import BECMonitor
+
+# some default configs for demonstration purposes
+CONFIG_SIMPLE = {
+    "plot_settings": {
+        "background_color": "black",
+        "num_columns": 2,
+        "colormap": "plasma",
+        "scan_types": False,
+    },
+    "plot_data": [
+        {
+            "plot_name": "BPM4i plots vs samx",
+            "x_label": "Motor X",
+            "y_label": "bpm4i",
+            "sources": [
+                {
+                    "type": "scan_segment",
+                    "signals": {
+                        "x": [{"name": "samx"}],
+                        "y": [{"name": "bpm4i", "entry": "bpm4i"}],
+                    },
+                },
+                # {
+                #     "type": "history",
+                #     "signals": {
+                #         "x": [{"name": "samx"}],
+                #         "y": [{"name": "bpm4i", "entry": "bpm4i"}],
+                #     },
+                # },
+                # {
+                #     "type": "dap",
+                #     'worker':'some_worker',
+                #     "signals": {
+                #         "x": [{"name": "samx"}],
+                #         "y": [{"name": "bpm4i", "entry": "bpm4i"}],
+                #     },
+                # },
+            ],
+        },
+        {
+            "plot_name": "Gauss plots vs samx",
+            "x_label": "Motor X",
+            "y_label": "Gauss",
+            "sources": [
+                {
+                    "type": "scan_segment",
+                    "signals": {
+                        "x": [{"name": "samx", "entry": "samx"}],
+                        "y": [{"name": "gauss_bpm"}, {"name": "gauss_adc1"}],
+                    },
+                }
+            ],
+        },
+    ],
+}
+
+
+CONFIG_SCAN_MODE = {
+    "plot_settings": {
+        "background_color": "white",
+        "num_columns": 3,
+        "colormap": "plasma",
+        "scan_types": True,
+    },
+    "plot_data": {
+        "grid_scan": [
+            {
+                "plot_name": "Grid plot 1",
+                "x_label": "Motor X",
+                "y_label": "BPM",
+                "sources": [
+                    {
+                        "type": "scan_segment",
+                        "signals": {
+                            "x": [{"name": "samx", "entry": "samx"}],
+                            "y": [{"name": "gauss_bpm"}],
+                        },
+                    }
+                ],
+            },
+            {
+                "plot_name": "Grid plot 2",
+                "x_label": "Motor X",
+                "y_label": "BPM",
+                "sources": [
+                    {
+                        "type": "scan_segment",
+                        "signals": {
+                            "x": [{"name": "samx", "entry": "samx"}],
+                            "y": [{"name": "gauss_adc1"}],
+                        },
+                    }
+                ],
+            },
+            {
+                "plot_name": "Grid plot 3",
+                "x_label": "Motor X",
+                "y_label": "BPM",
+                "sources": [
+                    {
+                        "type": "scan_segment",
+                        "signals": {"x": [{"name": "samy"}], "y": [{"name": "gauss_adc2"}]},
+                    }
+                ],
+            },
+            {
+                "plot_name": "Grid plot 4",
+                "x_label": "Motor X",
+                "y_label": "BPM",
+                "sources": [
+                    {
+                        "type": "scan_segment",
+                        "signals": {
+                            "x": [{"name": "samy", "entry": "samy"}],
+                            "y": [{"name": "gauss_adc3"}],
+                        },
+                    }
+                ],
+            },
+        ],
+        "line_scan": [
+            {
+                "plot_name": "BPM plots vs samx",
+                "x_label": "Motor X",
+                "y_label": "Gauss",
+                "sources": [
+                    {
+                        "type": "scan_segment",
+                        "signals": {
+                            "x": [{"name": "samx", "entry": "samx"}],
+                            "y": [{"name": "bpm4i"}],
+                        },
+                    }
+                ],
+            },
+            {
+                "plot_name": "Gauss plots vs samx",
+                "x_label": "Motor X",
+                "y_label": "Gauss",
+                "sources": [
+                    {
+                        "type": "scan_segment",
+                        "signals": {
+                            "x": [{"name": "samx", "entry": "samx"}],
+                            "y": [{"name": "gauss_bpm"}, {"name": "gauss_adc1"}],
+                        },
+                    }
+                ],
+            },
+        ],
+    },
+}
+
+
+class ModularApp(QMainWindow):
+    def __init__(self, client=None, parent=None):
+        super(ModularApp, self).__init__(parent)
+
+        # Client and device manager from BEC
+        self.client = BECDispatcher().client if client is None else client
+
+        # Loading UI
+        current_path = os.path.dirname(__file__)
+        uic.loadUi(os.path.join(current_path, "modular.ui"), self)
+
+        self._init_plots()
+
+    def _init_plots(self):
+        """Initialize plots and connect the buttons to the config dialogs"""
+        plots = [self.plot_1, self.plot_2, self.plot_3]
+        configs = [CONFIG_SIMPLE, CONFIG_SCAN_MODE, CONFIG_SCAN_MODE]
+        buttons = [self.pushButton_setting_1, self.pushButton_setting_2, self.pushButton_setting_3]
+
+        # hook plots, configs and buttons together
+        for plot, config, button in zip(plots, configs, buttons):
+            plot.on_config_update(config)
+            button.clicked.connect(plot.show_config_dialog)
+
+
+if __name__ == "__main__":
+    # BECclient global variables
+    client = BECDispatcher().client
+    client.start()
+
+    app = QApplication([])
+    modularApp = ModularApp(client=client)
+
+    window = modularApp
+    window.show()
+    app.exec()

bec_widgets/examples/motor_movement/motor_control_compilations.py

@@ -42,7 +42,7 @@ CONFIG_DEFAULT = {
                 "x": [{"name": "samx", "entry": "samx"}],
                 "y": [{"name": "samy", "entry": "samy"}],
             },
-        },
+        }
     ],
 }
 

bec_widgets/examples/motor_movement/motor_example.py

@@ -1068,10 +1068,7 @@ class MotorApp(QWidget):
 
         # PyQtGraph Controls
         layout.addWidget(QLabel("Graph Window Controls:"))
-        graph_controls = [
-            ("Left Drag", "Pan the view"),
-            ("Right Drag or Scroll", "Zoom in/out"),
-        ]
+        graph_controls = [("Left Drag", "Pan the view"), ("Right Drag or Scroll", "Zoom in/out")]
         for action, description in graph_controls:
             layout.addWidget(QLabel(f"{action} - {description}"))
 
@@ -1111,10 +1108,7 @@ class MotorControl(QThread):
     motors_selected = pyqtSignal(object, object)  # Signal to emit when the motors are selected
     # progress_updated = pyqtSignal(int)  #TODO  Signal to emit progress percentage
 
-    def __init__(
-        self,
-        parent=None,
-    ):
+    def __init__(self, parent=None):
         super().__init__(parent)
 
         self.action = None
@@ -1131,10 +1125,7 @@ class MotorControl(QThread):
         self.motor_x_name = motor_x_name
         self.motor_y_name = motor_y_name
 
-        self.motor_x, self.motor_y = (
-            dev[self.motor_x_name],
-            dev[self.motor_y_name],
-        )
+        self.motor_x, self.motor_y = (dev[self.motor_x_name], dev[self.motor_y_name])
 
         (self.current_x, self.current_y) = self.get_coordinates()
 

bec_widgets/utils/bec_connector.py

@@ -78,6 +78,7 @@ class BECConnector:
     def config_dict(self) -> dict:
         """
         Get the configuration of the widget.
+
         Returns:
             dict: The configuration of the widget.
         """
@@ -87,6 +88,7 @@ class BECConnector:
     def config_dict(self, config: BaseModel) -> None:
         """
         Get the configuration of the widget.
+
         Returns:
             dict: The configuration of the widget.
         """
@@ -96,6 +98,7 @@ class BECConnector:
     def set_gui_id(self, gui_id: str) -> None:
         """
         Set the GUI ID for the widget.
+
         Args:
             gui_id(str): GUI ID
         """
@@ -116,6 +119,7 @@ class BECConnector:
 
     def update_client(self, client) -> None:
         """Update the client and device manager from BEC and create object for BEC shortcuts.
+
         Args:
             client: BEC client
         """
@@ -126,6 +130,7 @@ class BECConnector:
     def on_config_update(self, config: ConnectionConfig | dict) -> None:
         """
         Update the configuration for the widget.
+
         Args:
             config(ConnectionConfig): Configuration settings.
         """
@@ -138,8 +143,10 @@ class BECConnector:
     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.
         """

bec_widgets/utils/bec_dispatcher.py

@@ -112,9 +112,7 @@ class BECDispatcher:
         cls._initialized = False
 
     def connect_slot(
-        self,
-        slot: Callable,
-        topics: Union[EndpointInfo, str, list[Union[EndpointInfo, str]]],
+        self, slot: Callable, topics: Union[EndpointInfo, str, list[Union[EndpointInfo, str]]]
     ) -> None:
         """Connect widget's pyqt slot, so that it is called on new pub/sub topic message.
 

bec_widgets/utils/bec_table.py

@@ -8,6 +8,7 @@ class BECTable(QTableWidget):
     def keyPressEvent(self, event) -> None:
         """
         Delete selected rows with backspace or delete key
+
         Args:
             event: keyPressEvent
         """

bec_widgets/utils/container_utils.py

@@ -10,6 +10,7 @@ class WidgetContainerUtils:
     def generate_unique_widget_id(container: dict, prefix: str = "widget") -> str:
         """
         Generate a unique widget ID.
+
         Args:
             container(dict): The container of widgets.
             prefix(str): The prefix of the widget ID.
@@ -29,10 +30,12 @@ class WidgetContainerUtils:
     ) -> QWidget | None:
         """
         Find the first widget of a given class in the figure.
+
         Args:
             container(dict): The container of widgets.
             widget_class(Type): The class of the widget to find.
             can_fail(bool): If True, the method will return None if no widget is found. If False, it will raise an error.
+
         Returns:
             widget: The widget of the given class.
         """

bec_widgets/utils/crosshair.py

@@ -17,6 +17,7 @@ class Crosshair(QObject):
     def __init__(self, plot_item: pg.PlotItem, precision: int = None, parent=None):
         """
         Crosshair for 1D and 2D plots.
+
         Args:
             plot_item (pyqtgraph.PlotItem): The plot item to which the crosshair will be attached.
             precision (int, optional): Number of decimal places to round the coordinates to. Defaults to None.

bec_widgets/utils/entry_validator.py

@@ -5,6 +5,7 @@ class EntryValidator:
     def validate_signal(self, name: str, entry: str = None) -> str:
         """
         Validate a signal entry for a given device. If the entry is not provided, the first signal entry will be used from the device hints.
+
         Args:
             name(str): Device name
             entry(str): Signal entry
@@ -28,6 +29,7 @@ class EntryValidator:
     def validate_monitor(self, monitor: str) -> str:
         """
         Validate a monitor entry for a given device.
+
         Args:
             monitor(str): Monitor entry
 

bec_widgets/utils/layout_manager.py

@@ -21,6 +21,7 @@ class GridLayoutManager:
     def is_position_occupied(self, row: int, col: int) -> bool:
         """
         Check if the position in the layout is occupied by a widget.
+
         Args:
             row(int): The row to check.
             col(int): The column to check.
@@ -42,6 +43,7 @@ class GridLayoutManager:
     ):
         """
         Shift widgets in the layout in the specified direction starting from the specified position.
+
         Args:
             direction(str): The direction to shift the widgets. Can be "down", "up", "left", or "right".
             start_row(int): The row to start shifting from. Default is 0.
@@ -63,6 +65,7 @@ class GridLayoutManager:
     def move_widget(self, widget: QWidget, new_row: int, new_col: int):
         """
         Move a widget to a new position in the layout.
+
         Args:
             widget(QWidget): The widget to move.
             new_row(int): The new row to move the widget to.
@@ -82,6 +85,7 @@ class GridLayoutManager:
     ):
         """
         Add a widget to the layout at the specified position.
+
         Args:
             widget(QWidget): The widget to add.
             row(int): The row to add the widget to. If None, the widget will be added to the next available row.

bec_widgets/utils/widget_io.py

@@ -114,6 +114,7 @@ class WidgetIO:
     def get_value(widget, ignore_errors=False):
         """
         Retrieve value from the widget instance.
+
         Args:
             widget: Widget instance.
             ignore_errors(bool, optional): Whether to ignore if no handler is found.
@@ -129,6 +130,7 @@ class WidgetIO:
     def set_value(widget, value, ignore_errors=False):
         """
         Set a value on the widget instance.
+
         Args:
             widget: Widget instance.
             value: Value to set.
@@ -155,6 +157,7 @@ class WidgetHierarchy:
     ) -> None:
         """
         Print the widget hierarchy to the console.
+
         Args:
             widget: Widget to print the hierarchy of
             indent(int, optional): Level of indentation.
@@ -196,6 +199,7 @@ class WidgetHierarchy:
     ) -> dict:
         """
         Export the widget hierarchy to a dictionary.
+
         Args:
             widget: Widget to print the hierarchy of.
             config(dict,optional): Dictionary to export the hierarchy to.
@@ -245,6 +249,7 @@ class WidgetHierarchy:
     def import_config_from_dict(widget, config: dict, set_values: bool = False) -> None:
         """
         Import the widget hierarchy from a dictionary.
+
         Args:
             widget: Widget to import the hierarchy to.
             config:

bec_widgets/utils/yaml_dialog.py

@@ -9,6 +9,7 @@ from qtpy.QtWidgets import QFileDialog
 def load_yaml(instance) -> Union[dict, None]:
     """
     Load YAML file from disk.
+
     Args:
         instance: Instance of the calling widget.
 
@@ -40,6 +41,7 @@ def load_yaml(instance) -> Union[dict, None]:
 def save_yaml(instance, config: dict) -> None:
     """
     Save YAML file to disk.
+
     Args:
         instance: Instance of the calling widget.
         config: Configuration data to be saved.

bec_widgets/validation/monitor_config_validator.py

@@ -8,7 +8,7 @@ class Signal(BaseModel):
     """
     Represents a signal in a plot configuration.
 
-    Attributes:
+    Args:
         name (str): The name of the signal.
         entry (Optional[str]): The entry point of the signal, optional.
     """
@@ -21,6 +21,7 @@ class Signal(BaseModel):
     def validate_fields(cls, values):
         """Validate the fields of the model.
         First validate the 'name' field, then validate the 'entry' field.
+
         Args:
             values (dict): The values to be validated."""
         devices = MonitorConfigValidator.devices

bec_widgets/widgets/dock/dock_area.py

@@ -70,13 +70,11 @@ class BECDockArea(BECConnector, DockArea):
         self.docks = WeakValueDictionary(value)
 
     def restore_state(
-        self,
-        state: dict = None,
-        missing: Literal["ignore", "error"] = "ignore",
-        extra="bottom",
+        self, state: dict = None, missing: Literal["ignore", "error"] = "ignore", extra="bottom"
     ):
         """
         Restore the state of the dock area. If no state is provided, the last state is restored.
+
         Args:
             state(dict): The state to restore.
             missing(Literal['ignore','error']): What to do if a dock is missing.
@@ -89,6 +87,7 @@ class BECDockArea(BECConnector, DockArea):
     def save_state(self) -> dict:
         """
         Save the state of the dock area.
+
         Returns:
             dict: The state of the dock area.
         """
@@ -98,6 +97,7 @@ class BECDockArea(BECConnector, DockArea):
     def remove_dock(self, name: str):
         """
         Remove a dock by name and ensure it is properly closed and cleaned up.
+
         Args:
             name(str): The name of the dock to remove.
         """
@@ -138,6 +138,7 @@ class BECDockArea(BECConnector, DockArea):
             col(int): The column of the added widget.
             rowspan(int): The rowspan of the added widget.
             colspan(int): The colspan of the added widget.
+
         Returns:
             BECDock: The created dock.
         """
@@ -178,6 +179,7 @@ class BECDockArea(BECConnector, DockArea):
     def detach_dock(self, dock_name: str) -> BECDock:
         """
         Undock a dock from the dock area.
+
         Args:
             dock_name(str): The dock to undock.