bec-widgets 0.52.0__py3-none-any.whl → 0.52.1__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

@@ -13,6 +13,7 @@ class RPCWidgetHandler:
     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/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_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

@@ -77,6 +77,7 @@ class BECDockArea(BECConnector, DockArea):
     ):
         """
         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 +90,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 +100,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 +141,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 +182,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.
 

bec_widgets/widgets/figure/figure.py

@@ -210,6 +210,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> BECWaveform:
         """
         Add a Waveform1D plot to the figure at the specified position.
+
         Args:
             widget_id(str): The unique identifier of the widget. If not provided, a unique ID will be generated.
             row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
@@ -289,6 +290,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> BECWaveform:
         """
         Add a 1D waveform plot to the figure. Always access the first waveform widget in the figure.
+
         Args:
             x_name(str): The name of the device for the x-axis.
             y_name(str): The name of the device for the y-axis.
@@ -375,6 +377,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> BECImageShow:
         """
         Add an image to the figure. Always access the first image widget in the figure.
+
         Args:
             monitor(str): The name of the monitor to display.
             color_bar(Literal["simple","full"]): The type of color bar to display.
@@ -428,6 +431,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> BECImageShow:
         """
         Add an image to the figure at the specified position.
+
         Args:
             monitor(str): The name of the monitor to display.
             color_bar(Literal["simple","full"]): The type of color bar to display.
@@ -482,6 +486,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def motor_map(self, motor_x: str = None, motor_y: str = None, **axis_kwargs) -> BECMotorMap:
         """
         Add a motor map to the figure. Always access the first motor map widget in the figure.
+
         Args:
             motor_x(str): The name of the motor for the X axis.
             motor_y(str): The name of the motor for the Y axis.
@@ -558,6 +563,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> BECPlotBase:
         """
         Add a widget to the figure at the specified position.
+
         Args:
             widget_type(Literal["PlotBase","Waveform1D"]): The type of the widget to add.
             widget_id(str): The unique identifier of the widget. If not provided, a unique ID will be generated.
@@ -620,6 +626,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> None:
         """
         Remove a widget from the figure. Can be removed by its unique identifier or by its coordinates.
+
         Args:
             row(int): The row coordinate of the widget to remove.
             col(int): The column coordinate of the widget to remove.
@@ -638,6 +645,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def change_theme(self, theme: Literal["dark", "light"]) -> None:
         """
         Change the theme of the figure widget.
+
         Args:
             theme(Literal["dark","light"]): The theme to set for the figure widget.
         """
@@ -648,6 +656,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def _remove_by_coordinates(self, row: int, col: int) -> None:
         """
         Remove a widget from the figure by its coordinates.
+
         Args:
             row(int): The row coordinate of the widget to remove.
             col(int): The column coordinate of the widget to remove.
@@ -661,6 +670,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def _remove_by_id(self, widget_id: str) -> None:
         """
         Remove a widget from the figure by its unique identifier.
+
         Args:
             widget_id(str): The unique identifier of the widget to remove.
         """
@@ -678,6 +688,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def axes(self, row: int, col: int) -> BECPlotBase:
         """
         Get widget by its coordinates in the figure.
+
         Args:
             row(int): the row coordinate
             col(int): the column coordinate
@@ -700,6 +711,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def _change_grid(self, widget_id: str, row: int, col: int):
         """
         Change the grid to reflect the new position of the widget.
+
         Args:
             widget_id(str): The unique identifier of the widget.
             row(int): The new row coordinate of the widget in the figure.