bec-widgets 0.80.0__py3-none-any.whl → 0.82.0__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,45 @@
 # CHANGELOG
 
+## v0.82.0 (2024-07-07)
+
+### Feature
+
+* feat(toggle): added angular component-like toggle ([`b9bff38`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b9bff38b64b86f06b3bc047922ef9df0c7d32e71))
+
+### Refactor
+
+* refactor(device_input): DeviceComboBox and DeviceLineEdit moved to top layer of widgets ([`f048629`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f04862933f049030554086adef3ec9e1aebd3eda))
+
+* refactor(stop_button): moved to top layer, plugin added ([`f5b8375`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f5b8375fd36e3bb681de571da86a6c0bdb3cb6f0))
+
+* refactor(motor_map_widget): removed restriction of only PySide6 for widget ([`db1cdf4`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/db1cdf42806fef6d7c6d2db83528f32df3f9751d))
+
+* refactor(color_button): ColorButton moved to top level of widgets ([`fa1e86f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fa1e86ff07b25d2c47c73117b00765b8e2f25da4))
+
+## v0.81.2 (2024-07-07)
+
+### Fix
+
+* fix(waveform): scan_history error check for IndexError ([`dd1875e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/dd1875ea5cc18bcef9aad743347a8accf144c08d))
+
+## v0.81.1 (2024-07-07)
+
+### Fix
+
+* fix(motor_control): temporary remove of motor control widgets ([`99114f1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/99114f14f62202e1fd8bf145616fa8c69937ada4))
+
+## v0.81.0 (2024-07-06)
+
+### Feature
+
+* feat(color_button): can get colors in RGBA or HEX ([`9594be2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9594be260680d11c8550ff74ffb8d679e5a5b8f6))
+
+## v0.80.1 (2024-07-06)
+
+### Fix
+
+* fix(entry_validator): check for entry == "" ([`61de7e9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/61de7e9e221c766b9fb3ec23246da6a11c96a986))
+
 ## v0.80.0 (2024-07-06)
 
 ### Feature
@@ -97,49 +137,3 @@
 * fix(image): image can be fully reconstructed from config ([`797f73c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/797f73c39aa73e07d6311f3de4baea53f6c380e0))
 
 * fix(image_item): vrange added int for pydantic model check ([`b8f796f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b8f796fd3fcc15641e8fc6a3ca75c344ce90fc45))
-
-* fix(bec_figure): waveforms can be initialised from the config; widgets are deleteLater after removal ([`78673ea`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/78673ea11a47aad878128197ae6213925228ed59))
-
-### Unknown
-
-* Resolve "add VT100 console executing BEC as a widget" ([`c6a14c0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c6a14c0768a90695567a83a7895247ed0c64f3ce))
-
-## v0.76.1 (2024-06-29)
-
-### Fix
-
-* fix(plugins): fixes and tests for auto-gen plugins ([`c42511d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c42511dd44cc13577e108a6cef3166376e594f54))
-
-## v0.76.0 (2024-06-28)
-
-### Feature
-
-* feat(designer): added support for creating designer plugins automatically ([`c1dd0ee`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c1dd0ee1906dba1f2e2ae9ce40a84d55c26a1cce))
-
-### Fix
-
-* fix: fixed qwidget inheritance for ring progress bar ([`0610d2f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0610d2f9f027f8659e7149f2dfbb316ff30e337d))
-
-### Unknown
-
-* fix:parent set as first kwarg TextBox and WebsiteWidget ([`a45c407`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a45c4075684b93bfdcee03e5a416b84f61d3bc6f))
-
-## v0.75.0 (2024-06-26)
-
-### Feature
-
-* feat(widgets): added simple bec queue widget ([`3faee98`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3faee98ec80041a27e4c1f1156178de6f9dcdc63))
-
-### Refactor
-
-* refactor(dispatcher): cleanup ([`ca02132`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ca02132c8d18535b37e9192e00459d2aca6ba5cf))
-
-## v0.74.1 (2024-06-26)
-
-### Fix
-
-* fix(rings): rings properties updated right after setting ([`c8b7367`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c8b7367815b095f8e4aa8b819481efb701f2e542))
-
-### Test
-
-* test(bec_figure): tests for removing widgets with rpc e2e ([`a268caa`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a268caaa30711fcc7ece542d24578d74cbf65c77))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.80.0
+Version: 0.82.0
 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/cli/client.py

@@ -21,6 +21,7 @@ class Widgets(str, enum.Enum):
     BECStatusBox = "BECStatusBox"
     RingProgressBar = "RingProgressBar"
     ScanControl = "ScanControl"
+    StopButton = "StopButton"
     TextBox = "TextBox"
     VSCodeEditor = "VSCodeEditor"
     WebsiteWidget = "WebsiteWidget"

bec_widgets/examples/__init__.py

@@ -1,9 +0,0 @@
-from .motor_movement import (
-    MotorControlApp,
-    MotorControlMap,
-    MotorControlPanel,
-    MotorControlPanelAbsolute,
-    MotorControlPanelRelative,
-    MotorCoordinateTable,
-    MotorThread,
-)

bec_widgets/utils/entry_validator.py

@@ -19,7 +19,7 @@ class EntryValidator:
         device = self.devices[name]
         description = device.describe()
 
-        if entry is None:
+        if entry is None or entry == "":
             entry = next(iter(device._hints), name) if hasattr(device, "_hints") else name
         if entry not in description:
             raise ValueError(f"Entry '{entry}' not found in device '{name}' signals")

bec_widgets/widgets/{device_inputs → base_classes}/device_input_base.py

@@ -25,6 +25,7 @@ class DeviceInputBase(BECConnector):
         super().__init__(client=client, config=config, gui_id=gui_id)
 
         self.get_bec_shortcuts()
+        self._device_filter = None
         self._devices = []
 
     @property
@@ -56,6 +57,7 @@ class DeviceInputBase(BECConnector):
         """
         self.validate_device_filter(device_filter)
         self.config.device_filter = device_filter
+        self._device_filter = device_filter
 
     def set_default_device(self, default_device: str):
         """

bec_widgets/widgets/color_button/color_button.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+from typing import Literal
+
+import pyqtgraph as pg
+
+
+class ColorButton(pg.ColorButton):
+    """
+    A ColorButton that opens a dialog to select a color. Inherits from pyqtgraph.ColorButton.
+    Patches event loop of the ColorDialog, if opened in another QDialog.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def selectColor(self):
+        self.origColor = self.color()
+        self.colorDialog.setCurrentColor(self.color())
+        self.colorDialog.open()
+        self.colorDialog.exec()
+
+    def get_color(self, format: Literal["RGBA", "HEX"] = "RGBA") -> tuple | str:
+        """
+        Get the color of the button in the specified format.
+
+        Args:
+            format(Literal["RGBA", "HEX"]): The format of the returned color.
+
+        Returns:
+            tuple|str: The color in the specified format.
+        """
+        if format == "RGBA":
+            return self.color().getRgb()
+        if format == "HEX":
+            return self.color().name()

bec_widgets/widgets/{buttons/color_button → color_button}/color_button_plugin.py

@@ -3,7 +3,7 @@ import os
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
 from qtpy.QtGui import QIcon
 
-from bec_widgets.widgets.buttons.color_button.color_button import ColorButton
+from bec_widgets.widgets.color_button.color_button import ColorButton
 
 DOM_XML = """
 <ui language='c++'>

bec_widgets/widgets/{buttons/color_button → color_button}/register_color_button.py

@@ -6,7 +6,7 @@ def main():  # pragma: no cover
         return
     from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
 
-    from bec_widgets.widgets.buttons.color_button.color_button_plugin import ColorButtonPlugin
+    from bec_widgets.widgets.color_button.color_button_plugin import ColorButtonPlugin
 
     QPyDesignerCustomWidgetCollection.addCustomWidget(ColorButtonPlugin())
 

bec_widgets/widgets/{device_inputs/device_combobox → device_combobox}/device_combobox.py

@@ -2,10 +2,10 @@ from typing import TYPE_CHECKING
 
 from qtpy.QtWidgets import QComboBox
 
-from bec_widgets.widgets.device_inputs.device_input_base import DeviceInputBase, DeviceInputConfig
+from bec_widgets.widgets.base_classes.device_input_base import DeviceInputBase, DeviceInputConfig
 
 if TYPE_CHECKING:
-    from bec_widgets.widgets.device_inputs.device_input_base import DeviceInputConfig
+    from bec_widgets.widgets.base_classes.device_input_base import DeviceInputConfig
 
 
 class DeviceComboBox(DeviceInputBase, QComboBox):

bec_widgets/widgets/device_combobox/device_combobox.pyproject

@@ -0,0 +1,3 @@
+{
+    "files": ["device_combobox.py"]
+}

bec_widgets/widgets/{device_inputs/device_combobox → device_combobox}/device_combobox_plugin.py

@@ -1,10 +1,11 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
 
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
 from qtpy.QtGui import QIcon
 
-from bec_widgets.widgets.device_inputs import DeviceComboBox
+from bec_widgets.widgets.device_combobox.device_combobox import DeviceComboBox
 
 DOM_XML = """
 <ui language='c++'>
@@ -27,10 +28,12 @@ class DeviceComboBoxPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return DOM_XML
 
     def group(self):
-        return ""
+        return "BEC Device Inputs"
 
     def icon(self):
-        return QIcon()
+        current_path = os.path.dirname(__file__)
+        icon_path = os.path.join(current_path, "assets", "device_combobox_icon.png")
+        return QIcon(icon_path)
 
     def includeFile(self):
         return "device_combobox"

bec_widgets/widgets/{device_inputs/device_combobox → device_combobox}/register_device_combobox.py

@@ -6,9 +6,7 @@ def main():  # pragma: no cover
         return
     from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
 
-    from bec_widgets.widgets.device_inputs.device_combobox.device_combobox_plugin import (
-        DeviceComboBoxPlugin,
-    )
+    from bec_widgets.widgets.device_combobox.device_combobox_plugin import DeviceComboBoxPlugin
 
     QPyDesignerCustomWidgetCollection.addCustomWidget(DeviceComboBoxPlugin())
 

bec_widgets/widgets/{device_inputs/device_line_edit → device_line_edit}/device_line_edit.py

@@ -3,10 +3,10 @@ from typing import TYPE_CHECKING
 from qtpy.QtCore import QSize
 from qtpy.QtWidgets import QCompleter, QLineEdit, QSizePolicy
 
-from bec_widgets.widgets.device_inputs.device_input_base import DeviceInputBase, DeviceInputConfig
+from bec_widgets.widgets.base_classes.device_input_base import DeviceInputBase, DeviceInputConfig
 
 if TYPE_CHECKING:
-    from bec_widgets.widgets.device_inputs.device_input_base import DeviceInputConfig
+    from bec_widgets.widgets.base_classes.device_input_base import DeviceInputConfig
 
 
 class DeviceLineEdit(DeviceInputBase, QLineEdit):

bec_widgets/widgets/device_line_edit/device_line_edit.pyproject

@@ -0,0 +1,3 @@
+{
+    "files": ["device_line_edit.py"]
+}

bec_widgets/widgets/{device_inputs/device_line_edit → device_line_edit}/device_line_edit_plugin.py

@@ -1,10 +1,11 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
 
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
 from qtpy.QtGui import QIcon
 
-from bec_widgets.widgets.device_inputs import DeviceLineEdit
+from bec_widgets.widgets.device_line_edit.device_line_edit import DeviceLineEdit
 
 DOM_XML = """
 <ui language='c++'>
@@ -27,10 +28,12 @@ class DeviceLineEditPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return DOM_XML
 
     def group(self):
-        return ""
+        return "BEC Device Inputs"
 
     def icon(self):
-        return QIcon()
+        current_path = os.path.dirname(__file__)
+        icon_path = os.path.join(current_path, "assets", "line_edit_icon.png")
+        return QIcon(icon_path)
 
     def includeFile(self):
         return "device_line_edit"

bec_widgets/widgets/{device_inputs/device_line_edit → device_line_edit}/register_device_line_edit.py

@@ -6,9 +6,7 @@ def main():  # pragma: no cover
         return
     from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
 
-    from bec_widgets.widgets.device_inputs.device_line_edit.device_line_edit_plugin import (
-        DeviceLineEditPlugin,
-    )
+    from bec_widgets.widgets.device_line_edit.device_line_edit_plugin import DeviceLineEditPlugin
 
     QPyDesignerCustomWidgetCollection.addCustomWidget(DeviceLineEditPlugin())
 

bec_widgets/widgets/figure/plots/waveform/waveform.py

@@ -221,6 +221,7 @@ class BECWaveform(BECPlotBase):
         label: str | None = None,
         validate: bool = True,
         dap: str | None = None,  # TODO add dap custom curve wrapper
+        **kwargs,
     ) -> BECCurve:
         """
         Plot a curve to the plot widget.
@@ -244,7 +245,7 @@ class BECWaveform(BECPlotBase):
         """
 
         if x is not None and y is not None:
-            return self.add_curve_custom(x=x, y=y, label=label, color=color)
+            return self.add_curve_custom(x=x, y=y, label=label, color=color, **kwargs)
         else:
             if dap:
                 self.add_dap(x_name=x_name, y_name=y_name, dap=dap)
@@ -259,6 +260,7 @@ class BECWaveform(BECPlotBase):
                 color_map_z=color_map_z,
                 label=label,
                 validate_bec=validate,
+                **kwargs,
             )
 
     def add_curve_custom(
@@ -754,7 +756,11 @@ class BECWaveform(BECPlotBase):
             self.update_dap, MessageEndpoints.dap_response(self.scan_id)
         )
         if scan_index is not None:
-            self.scan_id = self.queue.scan_storage.storage[scan_index].scan_id
+            try:
+                self.scan_id = self.queue.scan_storage.storage[scan_index].scan_id
+            except IndexError:
+                print(f"Scan index {scan_index} out of range.")
+                return
         elif scan_id is not None:
             self.scan_id = scan_id
 

bec_widgets/widgets/motor_map/motor_map_dialog/motor_map_settings.py

@@ -36,7 +36,7 @@ class MotorMapSettings(QWidget):
         precision = WidgetIO.get_value(self.ui.precision)
         scatter_size = WidgetIO.get_value(self.ui.scatter_size)
         background_intensity = int(WidgetIO.get_value(self.ui.background_value) * 0.01 * 255)
-        color = self.ui.color.color().toTuple()
+        color = self.ui.color.get_color("RGBA")
 
         if self.target_widget is not None:
             self.target_widget.set_max_points(max_points)

bec_widgets/widgets/motor_map/motor_map_dialog/motor_map_toolbar.py

@@ -4,7 +4,7 @@ from qtpy.QtCore import QSize
 from qtpy.QtGui import QAction, QIcon
 from qtpy.QtWidgets import QHBoxLayout, QLabel, QWidget
 
-from bec_widgets.widgets.device_inputs import DeviceComboBox
+from bec_widgets.widgets.device_combobox.device_combobox import DeviceComboBox
 from bec_widgets.widgets.toolbar.toolbar import ToolBarAction
 
 

bec_widgets/widgets/motor_map/motor_map_widget.py

@@ -2,7 +2,6 @@ from __future__ import annotations
 
 import sys
 
-from qtpy import PYSIDE6
 from qtpy.QtWidgets import QVBoxLayout, QWidget
 
 from bec_widgets.utils import BECConnector
@@ -37,10 +36,6 @@ class BECMotorMapWidget(BECConnector, QWidget):
         client=None,
         gui_id: str | None = None,
     ) -> None:
-        if not PYSIDE6:
-            raise RuntimeError(
-                "PYSIDE6 is not available in the environment. This widget is compatible only with PySide6."
-            )
         if config is None:
             config = MotorMapConfig(widget_class=self.__class__.__name__)
         else:
@@ -216,13 +211,6 @@ class BECMotorMapWidget(BECConnector, QWidget):
 
 
 def main():  # pragma: no cover
-
-    if not PYSIDE6:
-        print(
-            "PYSIDE6 is not available in the environment. UI files with BEC custom widgets are runnable only with PySide6."
-        )
-        return
-
     from qtpy.QtWidgets import QApplication
 
     app = QApplication(sys.argv)

bec_widgets/widgets/scan_control/scan_control.py

@@ -12,8 +12,8 @@ from qtpy.QtWidgets import (
 )
 
 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
+from bec_widgets.widgets.stop_button.stop_button import StopButton
 
 
 class ScanControl(BECConnector, QWidget):

bec_widgets/widgets/scan_control/scan_group_box.py

@@ -12,7 +12,7 @@ from qtpy.QtWidgets import (
 )
 
 from bec_widgets.utils.widget_io import WidgetIO
-from bec_widgets.widgets.device_inputs import DeviceLineEdit
+from bec_widgets.widgets.device_line_edit.device_line_edit import DeviceLineEdit
 
 
 class ScanArgType:

bec_widgets/widgets/stop_button/register_stop_button.py

@@ -0,0 +1,15 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.stop_button.stop_button_plugin import StopButtonPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(StopButtonPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/widgets/{buttons/stop_button → stop_button}/stop_button.py

@@ -1,3 +1,4 @@
+from qtpy.QtCore import Slot
 from qtpy.QtWidgets import QPushButton
 
 from bec_widgets.utils import BECConnector
@@ -12,21 +13,13 @@ class StopButton(BECConnector, QPushButton):
 
         self.get_bec_shortcuts()
         self.setText("Stop")
-        self.setStyleSheet("background-color:  #cc181e; color: white")
+        self.setStyleSheet(
+            "background-color:  #cc181e; color: white; font-weight: bold; font-size: 12px;"
+        )
         self.clicked.connect(self.stop_scan)
 
+    @Slot()
     def stop_scan(self):
         """Stop the scan."""
         self.queue.request_scan_abortion()
         self.queue.request_queue_reset()
-
-
-if __name__ == "__main__":  # pragma: no cover
-    import sys
-
-    from qtpy.QtWidgets import QApplication
-
-    app = QApplication(sys.argv)
-    widget = StopButton()
-    widget.show()
-    sys.exit(app.exec_())

bec_widgets/widgets/stop_button/stop_button.pyproject

@@ -0,0 +1 @@
+{'files': ['stop_button.py']}

bec_widgets/widgets/stop_button/stop_button_plugin.py

@@ -0,0 +1,57 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+from qtpy.QtGui import QIcon
+
+from bec_widgets.widgets.stop_button.stop_button import StopButton
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='StopButton' name='stop_button'>
+    </widget>
+</ui>
+"""
+
+
+class StopButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = StopButton(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        current_path = os.path.dirname(__file__)
+        icon_path = os.path.join(current_path, "assets", "stop.png")
+        return QIcon(icon_path)
+
+    def includeFile(self):
+        return "stop_button"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "StopButton"
+
+    def toolTip(self):
+        return "A button that stops the current scan."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/toggle/register_toggle_switch.py

@@ -0,0 +1,15 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.toggle.toggle_switch_plugin import ToggleSwitchPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(ToggleSwitchPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()