bec-widgets 0.82.1__py3-none-any.whl → 0.83.0__py3-none-any.whl

.gitlab-ci.yml

@@ -144,6 +144,9 @@ tests:
       coverage_report:
         coverage_format: cobertura
         path: coverage.xml
+    paths:
+      - tests/reference_failures/
+    when: always
 
 test-matrix:
   parallel:

CHANGELOG.md

@@ -1,5 +1,37 @@
 # CHANGELOG
 
+## v0.83.0 (2024-07-08)
+
+### Feature
+
+* feat: added reference utils to compare renderings of widgets ([`2988fd3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2988fd387e6b8076fffec1d57e3ccab89ddb2aeb))
+
+* feat(widgets): added device box with spinner ([`1b017ed`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1b017edfad8e78fa079210486123976695b8915c))
+
+* feat(designer): added option to skip the widget validation for DesignerPluginGenerator ([`41bcb80`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/41bcb801674ab6c4d6069bba34ffee09c9e665db))
+
+### Fix
+
+* fix(terminal): added default args to avoid designer crashes on startup ([`360d171`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/360d17135573e44b80ab517756da3c0b31daab0f))
+
+* fix(widget): fixed widget cleanup routine ([`2b29e34`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2b29e34b52d056349647bb2fcf649b749a60d292))
+
+* fix(bec_widget): added cleanup method to bec widget base class ([`fd8766e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fd8766ed87770661da6591aeb4df5abdaf38afc7))
+
+* fix(website): fixed dummy input ([`903ce7d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/903ce7d46b5d37d40486d0fda92d3694d3faca62))
+
+### Test
+
+* test(vscode): fixed vscode tests for new cleanup routine ([`eb26e2a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/eb26e2a11b229a52efe2e6d4fb28d760d3740136))
+
+* test(vscode): improved vscode test ([`5de8804`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5de8804da1e41eafad2472344904b3324438c13b))
+
+## v0.82.2 (2024-07-08)
+
+### Fix
+
+* fix(rpc_server): pass cli config to server ([`90178e2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/90178e2f61fa9dac7d82c0d0db40a9767bb133e6))
+
 ## v0.82.1 (2024-07-07)
 
 ### Fix
@@ -111,37 +143,3 @@
 * fix(toolbar): change default color to black to match BECFigure theme ([`b8774e0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b8774e0b0bc43dcd00f94f42539a778e507ca27d))
 
 * fix(motor_map): fixed bug with residual trace after changing motors ([`aaa0d10`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/aaa0d1003d2e94b45bafe4f700852c2c05288aea))
-
-* fix(widget_io): widget handler adjusted for spinboxes and comboboxes ([`3dc0532`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3dc0532df05b6ec0a2522107fa0b1e210ce7d91b))
-
-### Refactor
-
-* refactor(toolbar): cleanup and adjusted colors ([`96863ad`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/96863adf53c15112645d20eb6200733617801c6d))
-
-## v0.78.1 (2024-07-02)
-
-### Fix
-
-* fix(ui_loader): ui loader is compatible with bec plugins ([`b787759`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b787759f44486dc7af2c03811efb156041e4b6cb))
-
-## v0.78.0 (2024-07-02)
-
-### Feature
-
-* feat(color_button): patched ColorButton from pyqtgraph to be able to be opened in another QDialog ([`c36bb80`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c36bb80d6a4939802a4a1c8e5452c7b94bac185e))
-
-## v0.77.0 (2024-07-02)
-
-### Feature
-
-* feat(bec_connector): export config to yaml ([`a391f30`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a391f3018c50fee6a4a06884491b957df80c3cd3))
-
-### Fix
-
-* fix(waveform): scatter 2D brush error ([`215d59c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/215d59c8bfe7fda9aff8cec8353bef9e1ce2eca1))
-
-* fix(figure): API cleanup ([`008a33a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/008a33a9b192473cc58e90cd6d98c5bcb5f7b8c0))
-
-* fix(figure): if/else logic corrected in subplot_factory ([`3e78723`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3e787234c7274b0698423d7bf9a4c54ec46bad5f))
-
-* fix(image): processing of already displayed data; closes #106 ([`1173510`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1173510105d2d70d7e498c2ac1e122cea3a16597))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.82.1
+Version: 0.83.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_utils.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import importlib
 import importlib.metadata as imd
+import json
 import os
 import select
 import subprocess
@@ -87,7 +88,7 @@ def _get_output(process, logger) -> None:
         print(f"Error reading process output: {str(e)}")
 
 
-def _start_plot_process(gui_id, gui_class, config, logger=None) -> None:
+def _start_plot_process(gui_id: str, gui_class: type, config: dict | str, logger=None) -> None:
     """
     Start the plot in a new process.
 
@@ -98,6 +99,8 @@ def _start_plot_process(gui_id, gui_class, config, logger=None) -> None:
     # pylint: disable=subprocess-run-check
     command = ["bec-gui-server", "--id", gui_id, "--gui_class", gui_class.__name__]
     if config:
+        if isinstance(config, dict):
+            config = json.dumps(config)
         command.extend(["--config", config])
 
     env_dict = os.environ.copy()
@@ -190,7 +193,7 @@ class BECGuiClientMixin:
         if self._process is None or self._process.poll() is not None:
             self._start_update_script()
             self._process, self._process_output_processing_thread = _start_plot_process(
-                self._gui_id, self.__class__, self._client._service_config.config_path
+                self._gui_id, self.__class__, self._client._service_config.config
             )
         while not self.gui_is_alive():
             print("Waiting for GUI to start...")

bec_widgets/cli/server.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import inspect
+import json
 import signal
 import sys
 from contextlib import redirect_stderr, redirect_stdout
@@ -141,10 +142,30 @@ class SimpleFileLikeFromLogOutputFunc:
         return
 
 
+def _start_server(gui_id: str, gui_class: Union[BECFigure, BECDockArea], config: str | None = None):
+    if config:
+        try:
+            config = json.loads(config)
+            service_config = ServiceConfig(config=config)
+        except (json.JSONDecodeError, TypeError):
+            service_config = ServiceConfig(config_path=config)
+    else:
+        # if no config is provided, use the default config
+        service_config = ServiceConfig()
+
+    bec_logger.configure(
+        service_config.redis,
+        QtRedisConnector,
+        service_name="BECWidgetsCLIServer",
+        service_config=service_config.service_config,
+    )
+    server = BECWidgetsCLIServer(gui_id=gui_id, config=service_config, gui_class=gui_class)
+    return server
+
+
 def main():
     import argparse
     import os
-    import sys
 
     from qtpy.QtCore import QSize
     from qtpy.QtGui import QIcon
@@ -159,7 +180,7 @@ def main():
         type=str,
         help="Name of the gui class to be rendered. Possible values: \n- BECFigure\n- BECDockArea",
     )
-    parser.add_argument("--config", type=str, help="Config file")
+    parser.add_argument("--config", type=str, help="Config file or config string.")
 
     args = parser.parse_args()
 
@@ -188,14 +209,7 @@ def main():
             win = QMainWindow()
             win.setWindowTitle("BEC Widgets")
 
-            service_config = ServiceConfig(args.config)
-            bec_logger.configure(
-                service_config.redis,
-                QtRedisConnector,
-                service_name="BECWidgetsCLIServer",
-                service_config=service_config.service_config,
-            )
-            server = BECWidgetsCLIServer(gui_id=args.id, config=service_config, gui_class=gui_class)
+            server = _start_server(args.id, gui_class, args.config)
 
             gui = server.gui
             win.setCentralWidget(gui)

bec_widgets/utils/bec_connector.py

@@ -289,6 +289,8 @@ class BECConnector(BECWidget):
             print("No more connections. Shutting down GUI BEC client.")
             self.bec_dispatcher.disconnect_all()
             self.client.shutdown()
+        if hasattr(super(), "cleanup"):
+            super().cleanup()
 
     # def closeEvent(self, event):
     #     self.cleanup()

bec_widgets/utils/bec_widget.py

@@ -1,2 +1,8 @@
 class BECWidget:
     """Base class for all BEC widgets."""
+
+    def closeEvent(self, event):
+        if hasattr(self, "cleanup"):
+            self.cleanup()
+        if hasattr(super(), "closeEvent"):
+            super().closeEvent(event)

bec_widgets/utils/generate_designer_plugin.py

@@ -58,11 +58,12 @@ class DesignerPluginGenerator:
             os.path.dirname(os.path.abspath(__file__)), "plugin_templates"
         )
 
-    def run(self):
+    def run(self, validate=True):
         if self._excluded:
             print(f"Plugin {self.widget.__name__} is excluded from generation.")
             return
-        self._check_class_validity()
+        if validate:
+            self._check_class_validity()
         self._load_templates()
         self._write_templates()
 
@@ -142,7 +143,7 @@ class DesignerPluginGenerator:
 
 if __name__ == "__main__":  # pragma: no cover
     # from bec_widgets.widgets.bec_queue.bec_queue import BECQueue
-    from bec_widgets.widgets.dock import BECDockArea
+    from bec_widgets.widgets.spinner.spinner import SpinnerWidget
 
-    generator = DesignerPluginGenerator(BECDockArea)
-    generator.run()
+    generator = DesignerPluginGenerator(SpinnerWidget)
+    generator.run(validate=False)

bec_widgets/utils/reference_utils.py

@@ -0,0 +1,92 @@
+import os
+import sys
+
+from PIL import Image, ImageChops
+from qtpy.QtGui import QPixmap
+
+import bec_widgets
+
+REFERENCE_DIR = os.path.join(
+    os.path.dirname(os.path.dirname(bec_widgets.__file__)), "tests/references"
+)
+REFERENCE_DIR_FAILURES = os.path.join(
+    os.path.dirname(os.path.dirname(bec_widgets.__file__)), "tests/reference_failures"
+)
+
+
+def compare_images(image1_path: str, reference_image_path: str):
+    """
+    Load two images and compare them pixel by pixel
+
+    Args:
+        image1_path(str): The path to the first image
+        reference_image_path(str): The path to the reference image
+
+    Raises:
+        ValueError: If the images are different
+    """
+    image1 = Image.open(image1_path)
+    image2 = Image.open(reference_image_path)
+    if image1.size != image2.size:
+        raise ValueError("Image size has changed")
+    diff = ImageChops.difference(image1, image2)
+    if diff.getbbox():
+        # copy image1 to the reference directory to upload as artifact
+        os.makedirs(REFERENCE_DIR_FAILURES, exist_ok=True)
+        image_name = os.path.join(REFERENCE_DIR_FAILURES, os.path.basename(image1_path))
+        image1.save(image_name)
+        print(f"Image saved to {image_name}")
+
+        raise ValueError("Images are different")
+
+
+def snap_and_compare(widget: any, output_directory: str, suffix: str = ""):
+    """
+    Save a rendering of a widget and compare it to a reference image
+
+    Args:
+        widget(any): The widget to render
+        output_directory(str): The directory to save the image to
+        suffix(str): A suffix to append to the image name
+
+    Raises:
+        ValueError: If the images are different
+
+    Examples:
+        snap_and_compare(widget, tmpdir, suffix="started")
+
+    """
+
+    if not isinstance(output_directory, str):
+        output_directory = str(output_directory)
+
+    os_suffix = sys.platform
+
+    name = (
+        f"{widget.__class__.__name__}_{suffix}_{os_suffix}.png"
+        if suffix
+        else f"{widget.__class__.__name__}_{os_suffix}.png"
+    )
+
+    # Save the widget to a pixmap
+    test_image_path = os.path.join(output_directory, name)
+    pixmap = QPixmap(widget.size())
+    widget.render(pixmap)
+    pixmap.save(test_image_path)
+
+    try:
+        reference_path = os.path.join(REFERENCE_DIR, f"{widget.__class__.__name__}")
+        reference_image_path = os.path.join(reference_path, name)
+
+        if not os.path.exists(reference_image_path):
+            raise ValueError(f"Reference image not found: {reference_image_path}")
+
+        compare_images(test_image_path, reference_image_path)
+
+    except ValueError:
+        image = Image.open(test_image_path)
+        os.makedirs(REFERENCE_DIR_FAILURES, exist_ok=True)
+        image_name = os.path.join(REFERENCE_DIR_FAILURES, name)
+        image.save(image_name)
+        print(f"Image saved to {image_name}")
+        raise

bec_widgets/widgets/console/console.py

@@ -222,7 +222,7 @@ class _TerminalWidget(QtWidgets.QPlainTextEdit):
     Start ``Backend`` process and render Pyte output as text.
     """
 
-    def __init__(self, parent, numColumns, numLines, **kwargs):
+    def __init__(self, parent, numColumns=125, numLines=50, **kwargs):
         super().__init__(parent)
 
         # file descriptor to communicate with the subprocess

bec_widgets/widgets/device_box/device_box.py

@@ -0,0 +1,197 @@
+import os
+import uuid
+
+from bec_lib.endpoints import MessageEndpoints
+from bec_lib.messages import ScanQueueMessage
+from qtpy.QtCore import Property, Signal, Slot
+from qtpy.QtGui import QDoubleValidator
+from qtpy.QtWidgets import QDoubleSpinBox, QVBoxLayout, QWidget
+
+from bec_widgets.utils import UILoader
+from bec_widgets.utils.bec_connector import BECConnector
+
+
+class DeviceBox(BECConnector, QWidget):
+    device_changed = Signal(str, str)
+
+    def __init__(self, parent=None, device=None, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        QWidget.__init__(self, parent=parent)
+        self.get_bec_shortcuts()
+        self._device = ""
+        self._limits = None
+
+        self.init_ui()
+
+        if device is not None:
+            self.device = device
+            self.init_device()
+
+    def init_ui(self):
+        self.device_changed.connect(self.on_device_change)
+
+        current_path = os.path.dirname(__file__)
+        self.ui = UILoader(self).loader(os.path.join(current_path, "device_box.ui"))
+
+        self.layout = QVBoxLayout(self)
+        self.layout.addWidget(self.ui)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+
+        # fix the size of the device box
+        db = self.ui.device_box
+        db.setFixedHeight(234)
+        db.setFixedWidth(224)
+
+        self.ui.step_size.setStepType(QDoubleSpinBox.AdaptiveDecimalStepType)
+        self.ui.stop.clicked.connect(self.on_stop)
+        self.ui.tweak_right.clicked.connect(self.on_tweak_right)
+        self.ui.tweak_right.setToolTip("Tweak right")
+        self.ui.tweak_left.clicked.connect(self.on_tweak_left)
+        self.ui.tweak_left.setToolTip("Tweak left")
+        self.ui.setpoint.returnPressed.connect(self.on_setpoint_change)
+
+        self.setpoint_validator = QDoubleValidator()
+        self.ui.setpoint.setValidator(self.setpoint_validator)
+        self.ui.spinner_widget.start()
+
+    def init_device(self):
+        if self.device in self.dev:
+            data = self.dev[self.device].read()
+            self.on_device_readback({"signals": data}, {})
+
+    @Property(str)
+    def device(self):
+        return self._device
+
+    @device.setter
+    def device(self, value):
+        if not value or not isinstance(value, str):
+            return
+        old_device = self._device
+        self._device = value
+        self.device_changed.emit(old_device, value)
+
+    @Slot(str, str)
+    def on_device_change(self, old_device: str, new_device: str):
+        if new_device not in self.dev:
+            print(f"Device {new_device} not found in the device list")
+            return
+        print(f"Device changed from {old_device} to {new_device}")
+        self.init_device()
+        self.bec_dispatcher.disconnect_slot(
+            self.on_device_readback, MessageEndpoints.device_readback(old_device)
+        )
+        self.bec_dispatcher.connect_slot(
+            self.on_device_readback, MessageEndpoints.device_readback(new_device)
+        )
+        self.ui.device_box.setTitle(new_device)
+        self.ui.readback.setToolTip(f"{self.device} readback")
+        self.ui.setpoint.setToolTip(f"{self.device} setpoint")
+        self.ui.step_size.setToolTip(f"Step size for {new_device}")
+
+        precision = self.dev[new_device].precision
+        if precision is not None:
+            self.ui.step_size.setDecimals(precision)
+            self.ui.step_size.setValue(10**-precision * 10)
+
+    @Slot(dict, dict)
+    def on_device_readback(self, msg_content: dict, metadata: dict):
+        signals = msg_content.get("signals", {})
+        # pylint: disable=protected-access
+        hinted_signals = self.dev[self.device]._hints
+        precision = self.dev[self.device].precision
+
+        readback_val = None
+        setpoint_val = None
+
+        if len(hinted_signals) == 1:
+            signal = hinted_signals[0]
+            readback_val = signals.get(signal, {}).get("value")
+
+        if f"{self.device}_setpoint" in signals:
+            setpoint_val = signals.get(f"{self.device}_setpoint", {}).get("value")
+
+        if f"{self.device}_motor_is_moving" in signals:
+            is_moving = signals.get(f"{self.device}_motor_is_moving", {}).get("value")
+            if is_moving:
+                self.ui.spinner_widget.start()
+                self.ui.spinner_widget.setToolTip("Device is moving")
+            else:
+                self.ui.spinner_widget.stop()
+                self.ui.spinner_widget.setToolTip("Device is idle")
+
+        if readback_val is not None:
+            self.ui.readback.setText(f"{readback_val:.{precision}f}")
+
+        if setpoint_val is not None:
+            self.ui.setpoint.setText(f"{setpoint_val:.{precision}f}")
+
+        limits = self.dev[self.device].limits
+        self.update_limits(limits)
+        if limits is not None and readback_val is not None and limits[0] != limits[1]:
+            pos = (readback_val - limits[0]) / (limits[1] - limits[0])
+            self.ui.position_indicator.on_position_update(pos)
+
+    def update_limits(self, limits):
+        if limits == self._limits:
+            return
+        self._limits = limits
+        if limits is not None and limits[0] != limits[1]:
+            self.ui.position_indicator.setToolTip(f"Min: {limits[0]}, Max: {limits[1]}")
+            self.setpoint_validator.setRange(limits[0], limits[1])
+        else:
+            self.ui.position_indicator.setToolTip("No limits set")
+            self.setpoint_validator.setRange(float("-inf"), float("inf"))
+
+    @Slot()
+    def on_stop(self):
+        request_id = str(uuid.uuid4())
+        params = {
+            "device": self.device,
+            "rpc_id": request_id,
+            "func": "stop",
+            "args": [],
+            "kwargs": {},
+        }
+        msg = ScanQueueMessage(
+            scan_type="device_rpc",
+            parameter=params,
+            queue="emergency",
+            metadata={"RID": request_id, "response": False},
+        )
+        self.client.connector.send(MessageEndpoints.scan_queue_request(), msg)
+
+    @property
+    def step_size(self):
+        return self.ui.step_size.value()
+
+    @Slot()
+    def on_tweak_right(self):
+        self.dev[self.device].move(self.step_size, relative=True)
+
+    @Slot()
+    def on_tweak_left(self):
+        self.dev[self.device].move(-self.step_size, relative=True)
+
+    @Slot()
+    def on_setpoint_change(self):
+        self.ui.setpoint.clearFocus()
+        setpoint = self.ui.setpoint.text()
+        self.dev[self.device].move(float(setpoint), relative=False)
+        self.ui.tweak_left.setToolTip(f"Tweak left by {self.step_size}")
+        self.ui.tweak_right.setToolTip(f"Tweak right by {self.step_size}")
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    import qdarktheme
+    from qtpy.QtWidgets import QApplication
+
+    app = QApplication(sys.argv)
+    qdarktheme.setup_theme("light")
+    widget = DeviceBox(device="samx")
+
+    widget.show()
+    sys.exit(app.exec_())

bec_widgets/widgets/device_box/device_box.pyproject

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