bec-widgets 0.70.0__tar.gz → 0.71.1__tar.gz

{bec_widgets-0.70.0 → bec_widgets-0.71.1}/CHANGELOG.md

@@ -1,5 +1,53 @@
 # CHANGELOG
 
+## v0.71.1 (2024-06-23)
+
+### Fix
+
+* fix: don't print exception if the auto-update module cannot be found in plugins ([`860517a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/860517a3211075d1f6e2af7fa6a567b9e0cd77f3))
+
+## v0.71.0 (2024-06-23)
+
+### Feature
+
+* feat(scan_group_box): scan box for args and kwargs separated from ScanControlGUI code ([`d8cf441`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d8cf44134c30063e586771f9068947fef7a306d1))
+
+### Fix
+
+* fix(cleanup): cleanup added to device_input widgets and scan_control ([`8badb6a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8badb6adc1d003dbf0b2b1a800c34821f3fc9aa3))
+
+* fix(scan_group_box): added row counter based on widgets ([`37682e7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/37682e7b8a6ede38308880d285e41a948d6fe831))
+
+* fix(scan_control): added default min limit for args bundle if specified ([`ec4574e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ec4574ed5c2c85ea6fbbe2b98f162a8e1220653b))
+
+* fix(scan_control): argbox delete later added to prevent overlapping gui if scan changed ([`7ce3a83`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7ce3a83c58cb69c2bf7cb7f4eaba7e6a2ca6c546))
+
+* fix(scan_control): only scans with defined gui_config are allowed ([`6dff187`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6dff1879c4178df0f8ebfd35101acdebb028d572))
+
+* fix(WidgetIO): find handlers within base classes ([`ca85638`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ca856384f380dabf28d43f1cd48511af784c035b))
+
+* fix(scan_control): adapted widget to scan BEC gui config ([`8b822e0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8b822e0fa8e28f080b9a4bf81948a7280a4c07bf))
+
+* fix(scan_control): scan_control.py combatible with the newest BEC versions, test disabled ([`67d398c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/67d398caf74e08ab25a70cc5d85a5f0c2de8212d))
+
+### Refactor
+
+* refactor(device_line_edit): renamed default_device to default ([`4e2c9df`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4e2c9df6a4979d935285fd7eba17fd7fd455a35c))
+
+### Test
+
+* test(scan_control): tests added ([`56e74a0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/56e74a0e7da72d18e89bc30d1896dbf9ef97cd6b))
+
+### Unknown
+
+* test(scan_control):e2e tests added ([`83001a0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/83001a0d8267e1320549b07032857dcf46ecd293))
+
+* doc(scan_control): docs added ([`1b7921a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1b7921a7f2e3bcc846219a2a7aa0de0fd27bb8fe))
+
+* fix(device_line_edit):SizePolicy fixed for 100 horizontal ([`21d20e0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/21d20e0fc78e9a3853abe802733388cce119ce20))
+
+* tests WIP ([`c09644b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c09644b29ddb291c91dc58bcd6ebf02ff45cab36))
+
 ## v0.70.0 (2024-06-21)
 
 ### Documentation
@@ -100,68 +148,6 @@ in their parent process ([`ce37416`](https://gitlab.psi.ch/bec/bec_widgets/-/com
 
 ## v0.65.0 (2024-06-20)
 
-### Feature
-
-* feat(device_input): DeviceLineEdit with QCompleter added ([`50e41ff`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/50e41ff26160ec26d77feb6d519e4dad902a9b9b))
-
-* feat(device_combobox): DeviceInputBase and DeviceComboBox added ([`430b282`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/430b282039806e3fbc6cf98e958861a065760620))
-
-### Fix
-
-* fix(device_input_base): bug with setting config and overwriting default device and filter ([`d79f7e9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d79f7e9ccde03dc77819ca556c79736d30f7821a))
-
 ### Test
 
 * test(device_input): tests added ([`1a0a98a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1a0a98a45367db414bed813bbd346b3e1ae8d550))
-
-## v0.64.2 (2024-06-19)
-
-### Fix
-
-* fix(client_utils): added close rpc command to shutdown of gui from bec_ipython_client ([`e5a7d47`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e5a7d47b21cbf066f740f1d11d7c9ea7c70f3080))
-
-## v0.64.1 (2024-06-19)
-
-### Fix
-
-* fix(widgets): removed widget module import of sub widgets ([`216511b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/216511b951ff0e15b6d7c70133095f3ac45c23f4))
-
-### Refactor
-
-* refactor(utils): moved get_rpc_widgets to plugin_utils ([`6dabbf8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6dabbf874fbbdde89c34a7885bf95aa9c895a28b))
-
-### Test
-
-* test: moved rpc_classes test ([`b3575eb`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b3575eb06852b456cde915dfda281a3e778e3aeb))
-
-## v0.64.0 (2024-06-19)
-
-### Ci
-
-* ci: add job optional dependency check ([`27426ce`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/27426ce7a52b4cbad7f3bef114d6efe6ad73bd7f))
-
-### Documentation
-
-* docs: fix links in developer section ([`9e16f2f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9e16f2faf9c59a5d36ae878512c5a910cca31e69))
-
-* docs: refactor developer section, add widget tutorial ([`2a36d93`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2a36d9364f242bf42e4cda4b50e6f46aa3833bbd))
-
-### Feature
-
-* feat: add option to change size of the fonts ([`ea805d1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ea805d1362fc084d3b703b6f81b0180072f0825d))
-
-### Fix
-
-* fix(plot_base): font size is set with setScale which is scaling the whole legend window ([`5d66720`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5d6672069ea1cbceb62104f66c127e4e3c23e4a4))
-
-### Test
-
-* test: add tests ([`140ad83`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/140ad83380808928edf7953e23c762ab72a0a1e9))
-
-## v0.63.2 (2024-06-14)
-
-### Fix
-
-* fix: do not import "server" in client, prevents from having trouble with QApplication creation order
-
-Like with QtWebEngine ([`6f96498`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6f96498de66358b89f3a2035627eed2e02dde5a1))

{bec_widgets-0.70.0 → bec_widgets-0.71.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.70.0
+Version: 0.71.1
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

{bec_widgets-0.70.0 → bec_widgets-0.71.1}/bec_widgets/cli/client.py

@@ -17,6 +17,7 @@ class Widgets(str, enum.Enum):
     BECDock = "BECDock"
     BECDockArea = "BECDockArea"
     BECFigure = "BECFigure"
+    ScanControl = "ScanControl"
     SpiralProgressBar = "SpiralProgressBar"
     TextBox = "TextBox"
     VSCodeEditor = "VSCodeEditor"
@@ -1823,6 +1824,24 @@ class Ring(RPCBase):
         """
 
 
+class ScanControl(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 get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
+
 class SpiralProgressBar(RPCBase):
     @rpc_call
     def get_all_rpc(self) -> "dict":

{bec_widgets-0.70.0 → bec_widgets-0.71.1}/bec_widgets/cli/client_utils.py

@@ -141,6 +141,10 @@ class BECGuiClientMixin:
         for ep in eps:
             if ep.name == "plugin_widgets_update":
                 try:
+                    spec = importlib.util.find_spec(ep.module)
+                    # if the module is not found, we skip it
+                    if spec is None:
+                        continue
                     return ep.load()(gui=self)
                 except Exception as e:
                     print(f"Error loading auto update script from plugin: {str(e)}")

{bec_widgets-0.70.0 → bec_widgets-0.71.1}/bec_widgets/utils/widget_io.py

@@ -119,7 +119,7 @@ class WidgetIO:
             widget: Widget instance.
             ignore_errors(bool, optional): Whether to ignore if no handler is found.
         """
-        handler_class = WidgetIO._handlers.get(type(widget))
+        handler_class = WidgetIO._find_handler(widget)
         if handler_class:
             return handler_class().get_value(widget)  # Instantiate the handler
         if not ignore_errors:
@@ -136,12 +136,28 @@ class WidgetIO:
             value: Value to set.
             ignore_errors(bool, optional): Whether to ignore if no handler is found.
         """
-        handler_class = WidgetIO._handlers.get(type(widget))
+        handler_class = WidgetIO._find_handler(widget)
         if handler_class:
             handler_class().set_value(widget, value)  # Instantiate the handler
         elif not ignore_errors:
             raise ValueError(f"No handler for widget type: {type(widget)}")
 
+    @staticmethod
+    def _find_handler(widget):
+        """
+        Find the appropriate handler for the widget by checking its base classes.
+
+        Args:
+            widget: Widget instance.
+
+        Returns:
+            handler_class: The handler class if found, otherwise None.
+        """
+        for base in type(widget).__mro__:
+            if base in WidgetIO._handlers:
+                return WidgetIO._handlers[base]
+        return None
+
 
 ################## for exporting and importing widget hierarchies ##################
 

{bec_widgets-0.70.0 → bec_widgets-0.71.1}/bec_widgets/widgets/device_inputs/device_combobox/device_combobox.py

@@ -18,7 +18,7 @@ class DeviceComboBox(DeviceInputBase, QComboBox):
         config: Device input configuration.
         gui_id: GUI ID.
         device_filter: Device filter, name of the device class.
-        default_device: Default device name.
+        default: Default device name.
         arg_name: Argument name, can be used for the other widgets which has to call some other function in bec using correct argument names.
     """
 
@@ -29,7 +29,7 @@ class DeviceComboBox(DeviceInputBase, QComboBox):
         config: DeviceInputConfig = None,
         gui_id: str | None = None,
         device_filter: str | None = None,
-        default_device: str | None = None,
+        default: str | None = None,
         arg_name: str | None = None,
     ):
         super().__init__(client=client, config=config, gui_id=gui_id)
@@ -41,8 +41,8 @@ class DeviceComboBox(DeviceInputBase, QComboBox):
             self.config.arg_name = arg_name
         if device_filter is not None:
             self.set_device_filter(device_filter)
-        if default_device is not None:
-            self.set_default_device(default_device)
+        if default is not None:
+            self.set_default_device(default)
 
     def set_device_filter(self, device_filter: str):
         """
@@ -82,3 +82,11 @@ class DeviceComboBox(DeviceInputBase, QComboBox):
         if device_obj is None:
             raise ValueError(f"Device {device_name} is not found.")
         return device_obj
+
+    def cleanup(self):
+        """Cleanup the widget."""
+        super().cleanup()
+
+    def closeEvent(self, event):
+        super().cleanup()
+        QComboBox().closeEvent(event)

{bec_widgets-0.70.0 → bec_widgets-0.71.1}/bec_widgets/widgets/device_inputs/device_input_base.py

@@ -5,7 +5,7 @@ from bec_widgets.utils import BECConnector, ConnectionConfig
 
 class DeviceInputConfig(ConnectionConfig):
     device_filter: str | list[str] | None = None
-    default_device: str | None = None
+    default: str | None = None
     arg_name: str | None = None
 
 
@@ -65,7 +65,7 @@ class DeviceInputBase(BECConnector):
             default_device(str): Default device name.
         """
         self.validate_device(default_device)
-        self.config.default_device = default_device
+        self.config.default = default_device
 
     def get_device_list(self, filter: str | list[str] | None = None) -> list[str]:
         """
@@ -118,3 +118,6 @@ class DeviceInputBase(BECConnector):
         """
         if device not in self.get_device_list(self.config.device_filter):
             raise ValueError(f"Device {device} is not valid.")
+
+    def cleanup(self):
+        super().cleanup()

{bec_widgets-0.70.0 → bec_widgets-0.71.1}/bec_widgets/widgets/device_inputs/device_line_edit/device_line_edit.py

@@ -1,6 +1,7 @@
 from typing import TYPE_CHECKING
 
-from qtpy.QtWidgets import QCompleter, QLineEdit
+from qtpy.QtCore import QSize
+from qtpy.QtWidgets import QCompleter, QLineEdit, QSizePolicy
 
 from bec_widgets.widgets.device_inputs.device_input_base import DeviceInputBase, DeviceInputConfig
 
@@ -18,7 +19,7 @@ class DeviceLineEdit(DeviceInputBase, QLineEdit):
         config: Device input configuration.
         gui_id: GUI ID.
         device_filter: Device filter, name of the device class.
-        default_device: Default device name.
+        default: Default device name.
         arg_name: Argument name, can be used for the other widgets which has to call some other function in bec using correct argument names.
     """
 
@@ -29,7 +30,7 @@ class DeviceLineEdit(DeviceInputBase, QLineEdit):
         config: DeviceInputConfig = None,
         gui_id: str | None = None,
         device_filter: str | list[str] | None = None,
-        default_device: str | None = None,
+        default: str | None = None,
         arg_name: str | None = None,
     ):
         QLineEdit.__init__(self, parent=parent)
@@ -41,10 +42,14 @@ class DeviceLineEdit(DeviceInputBase, QLineEdit):
 
         if arg_name is not None:
             self.config.arg_name = arg_name
+            self.arg_name = arg_name
         if device_filter is not None:
             self.set_device_filter(device_filter)
-        if default_device is not None:
-            self.set_default_device(default_device)
+        if default is not None:
+            self.set_default_device(default)
+
+        self.setSizePolicy(QSizePolicy.Preferred, QSizePolicy.Fixed)
+        self.setMinimumSize(QSize(100, 0))
 
     def set_device_filter(self, device_filter: str | list[str]):
         """
@@ -89,3 +94,11 @@ class DeviceLineEdit(DeviceInputBase, QLineEdit):
         if device_obj is None:
             raise ValueError(f"Device {device_name} is not found.")
         return device_obj
+
+    def cleanup(self):
+        """Cleanup the widget."""
+        super().cleanup()
+
+    def closeEvent(self, event):
+        super().cleanup()
+        QLineEdit().closeEvent(event)

bec_widgets-0.71.1/bec_widgets/widgets/scan_control/scan_control.py

@@ -0,0 +1,212 @@
+import qdarktheme
+from bec_lib.endpoints import MessageEndpoints
+from qtpy.QtWidgets import (
+    QApplication,
+    QComboBox,
+    QGridLayout,
+    QGroupBox,
+    QPushButton,
+    QSizePolicy,
+    QVBoxLayout,
+    QWidget,
+)
+
+from bec_widgets.utils import BECConnector
+from bec_widgets.widgets.buttons.stop_button.stop_button import StopButton
+from bec_widgets.widgets.scan_control.scan_group_box import ScanGroupBox
+
+
+class ScanControl(BECConnector, QWidget):
+
+    def __init__(
+        self, parent=None, client=None, gui_id: str | None = None, allowed_scans: list | None = None
+    ):
+        super().__init__(client=client, gui_id=gui_id)
+        QWidget.__init__(self, parent=parent)
+
+        # Client from BEC + shortcuts to device manager and scans
+        self.get_bec_shortcuts()
+
+        # Main layout
+        self.layout = QVBoxLayout(self)
+        self.arg_box = None
+        self.kwarg_boxes = []
+        self.expert_mode = False  # TODO implement in the future versions
+
+        # Scan list - allowed scans for the GUI
+        self.allowed_scans = allowed_scans
+
+        # Create and set main layout
+        self._init_UI()
+
+    def _init_UI(self):
+        """
+        Initializes the UI of the scan control widget. Create the top box for scan selection and populate scans to main combobox.
+        """
+
+        # Scan selection group box
+        self.scan_selection_group = self.create_scan_selection_group()
+        self.scan_selection_group.setSizePolicy(QSizePolicy.Preferred, QSizePolicy.Fixed)
+        self.layout.addWidget(self.scan_selection_group)
+
+        # Connect signals
+        self.comboBox_scan_selection.currentIndexChanged.connect(self.on_scan_selected)
+        self.button_run_scan.clicked.connect(self.run_scan)
+        self.button_add_bundle.clicked.connect(self.add_arg_bundle)
+        self.button_remove_bundle.clicked.connect(self.remove_arg_bundle)
+
+        # Initialize scan selection
+        self.populate_scans()
+
+    def create_scan_selection_group(self) -> QGroupBox:
+        """
+        Creates the scan selection group box with combobox to select the scan and start/stop button.
+
+        Returns:
+            QGroupBox: Group box containing the scan selection widgets.
+        """
+
+        scan_selection_group = QGroupBox("Scan Selection", self)
+        self.scan_selection_layout = QGridLayout(scan_selection_group)
+        self.comboBox_scan_selection = QComboBox(scan_selection_group)
+        # Run button
+        self.button_run_scan = QPushButton("Start", scan_selection_group)
+        self.button_run_scan.setStyleSheet("background-color:  #559900; color: white")
+        # Stop button
+        self.button_stop_scan = StopButton(parent=scan_selection_group)
+        # Add bundle button
+        self.button_add_bundle = QPushButton("Add Bundle", scan_selection_group)
+        # Remove bundle button
+        self.button_remove_bundle = QPushButton("Remove Bundle", scan_selection_group)
+
+        self.scan_selection_layout.addWidget(self.comboBox_scan_selection, 0, 0, 1, 2)
+        self.scan_selection_layout.addWidget(self.button_run_scan, 1, 0)
+        self.scan_selection_layout.addWidget(self.button_stop_scan, 1, 1)
+        self.scan_selection_layout.addWidget(self.button_add_bundle, 2, 0)
+        self.scan_selection_layout.addWidget(self.button_remove_bundle, 2, 1)
+
+        return scan_selection_group
+
+    def populate_scans(self):
+        """Populates the scan selection combo box with available scans from BEC session."""
+        self.available_scans = self.client.connector.get(
+            MessageEndpoints.available_scans()
+        ).resource
+        if self.allowed_scans is None:
+            supported_scans = ["ScanBase", "SyncFlyScanBase", "AsyncFlyScanBase"]
+            allowed_scans = [
+                scan_name
+                for scan_name, scan_info in self.available_scans.items()
+                if scan_info["base_class"] in supported_scans and len(scan_info["gui_config"]) > 0
+            ]
+
+        else:
+            allowed_scans = self.allowed_scans
+        self.comboBox_scan_selection.addItems(allowed_scans)
+
+    def on_scan_selected(self):
+        """Callback for scan selection combo box"""
+        self.reset_layout()
+        selected_scan_name = self.comboBox_scan_selection.currentText()
+        selected_scan_info = self.available_scans.get(selected_scan_name, {})
+
+        gui_config = selected_scan_info.get("gui_config", {})
+        self.arg_group = gui_config.get("arg_group", None)
+        self.kwarg_groups = gui_config.get("kwarg_groups", None)
+
+        if self.arg_box is None:
+            self.button_add_bundle.setEnabled(False)
+            self.button_remove_bundle.setEnabled(False)
+
+        if len(self.arg_group["arg_inputs"]) > 0:
+            self.button_add_bundle.setEnabled(True)
+            self.button_remove_bundle.setEnabled(True)
+            self.add_arg_group(self.arg_group)
+        if len(self.kwarg_groups) > 0:
+            self.add_kwargs_boxes(self.kwarg_groups)
+
+        self.update()
+        self.adjustSize()
+
+    def add_kwargs_boxes(self, groups: list):
+        """
+        Adds the given gui_groups to the scan control layout.
+
+        Args:
+            groups(list): List of dictionaries containing the gui_group information.
+        """
+        for group in groups:
+            box = ScanGroupBox(box_type="kwargs", config=group)
+            box.setSizePolicy(QSizePolicy.Preferred, QSizePolicy.Fixed)
+            self.layout.addWidget(box)
+            self.kwarg_boxes.append(box)
+
+    def add_arg_group(self, group: dict):
+        """
+        Adds the given gui_groups to the scan control layout.
+
+        Args:
+        """
+        self.arg_box = ScanGroupBox(box_type="args", config=group)
+        self.arg_box.setSizePolicy(QSizePolicy.Preferred, QSizePolicy.Fixed)
+        self.layout.addWidget(self.arg_box)
+
+    def add_arg_bundle(self):
+        self.arg_box.add_widget_bundle()
+
+    def remove_arg_bundle(self):
+        self.arg_box.remove_widget_bundle()
+
+    def reset_layout(self):
+        """Clears the scan control layout from GuiGroups and ArgGroups boxes."""
+        if self.arg_box is not None:
+            self.layout.removeWidget(self.arg_box)
+            self.arg_box.deleteLater()
+            self.arg_box = None
+        if self.kwarg_boxes != []:
+            self.remove_kwarg_boxes()
+
+    def remove_kwarg_boxes(self):
+        for box in self.kwarg_boxes:
+            self.layout.removeWidget(box)
+            box.deleteLater()
+        self.kwarg_boxes = []
+
+    def run_scan(self):
+        args = []
+        kwargs = {}
+        if self.arg_box is not None:
+            args = self.arg_box.get_parameters()
+        for box in self.kwarg_boxes:
+            box_kwargs = box.get_parameters()
+            kwargs.update(box_kwargs)
+        scan_function = getattr(self.scans, self.comboBox_scan_selection.currentText())
+        if callable(scan_function):
+            scan_function(*args, **kwargs)
+
+    def cleanup(self):
+        self.button_stop_scan.cleanup()
+        if self.arg_box:
+            for widget in self.arg_box.widgets:
+                if hasattr(widget, "cleanup"):
+                    widget.cleanup()
+        for kwarg_box in self.kwarg_boxes:
+            for widget in kwarg_box.widgets:
+                if hasattr(widget, "cleanup"):
+                    widget.cleanup()
+        super().cleanup()
+
+    def closeEvent(self, event):
+        self.cleanup()
+        QWidget().closeEvent(event)
+
+
+# Application example
+if __name__ == "__main__":  # pragma: no cover
+    app = QApplication([])
+    scan_control = ScanControl()
+
+    qdarktheme.setup_theme("auto")
+    window = scan_control
+    window.show()
+    app.exec()