bec-widgets 0.60.0__tar.gz → 0.61.0__tar.gz

{bec_widgets-0.60.0 → bec_widgets-0.61.0}/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 
 
+## v0.61.0 (2024-06-12)
+
+### Feature
+
+* feat(widgets/stop_button): General stop button added ([`61ba08d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/61ba08d0b8df9f48f5c54c7c2b4e6d395206e7e6))
+
+### Refactor
+
+* refactor: improve labe of auto_update script ([`40b5688`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/40b568815893cd41af3531bb2e647ca1e2e315f4))
+
+
 ## v0.60.0 (2024-06-08)
 
 ### Ci
@@ -150,11 +161,3 @@
 ### Documentation
 
 * docs(bar): docs updated ([`4be0d14`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4be0d14b7445c2322c2aef86257db168a841265c))
-
-### Fix
-
-* fix(ring): automatic updates are disabled uf user specify updates manually with .set_update; 'scan_progres' do not reset number of rings ([`e883dba`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e883dbad814dbcc0a19c341041c6d836e58a5918))
-
-* fix(ring): enable_auto_updates(True) do not reset properties of already setup bars ([`a2abad3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a2abad344f4c0039516eb60a825afb6822c5b19a))
-
-* fix(ring): set_min_max accepts floats ([`d44b1cf`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d44b1cf8b107cf02deedd9154b77d01c7f9ed05d))

{bec_widgets-0.60.0 → bec_widgets-0.61.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.60.0
+Version: 0.61.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-0.60.0 → bec_widgets-0.61.0}/bec_widgets/cli/auto_updates.py

@@ -118,7 +118,7 @@ class AutoUpdates:
         if not dev_y:
             return
         fig.clear_all()
-        plt = fig.plot(x_name=dev_x, y_name=dev_y)
+        plt = fig.plot(x_name=dev_x, y_name=dev_y, label=f"Scan {info.scan_number} - {dev_y}")
         plt.set(title=f"Scan {info.scan_number}", x_label=dev_x, y_label=dev_y)
 
     def simple_grid_scan(self, info: ScanInfo) -> None:
@@ -132,7 +132,9 @@ class AutoUpdates:
         dev_y = info.scan_report_devices[1]
         dev_z = self.get_selected_device(info.monitored_devices, self.gui.selected_device)
         fig.clear_all()
-        plt = fig.plot(x_name=dev_x, y_name=dev_y, z_name=dev_z, label=f"Scan {info.scan_number}")
+        plt = fig.plot(
+            x_name=dev_x, y_name=dev_y, z_name=dev_z, label=f"Scan {info.scan_number} - {dev_z}"
+        )
         plt.set(title=f"Scan {info.scan_number}", x_label=dev_x, y_label=dev_y)
 
     def best_effort(self, info: ScanInfo) -> None:
@@ -147,5 +149,5 @@ class AutoUpdates:
         if not dev_y:
             return
         fig.clear_all()
-        plt = fig.plot(x_name=dev_x, y_name=dev_y, label=f"Scan {info.scan_number}")
+        plt = fig.plot(x_name=dev_x, y_name=dev_y, label=f"Scan {info.scan_number} - {dev_y}")
         plt.set(title=f"Scan {info.scan_number}", x_label=dev_x, y_label=dev_y)

{bec_widgets-0.60.0 → bec_widgets-0.61.0}/bec_widgets/widgets/__init__.py

@@ -1,3 +1,4 @@
+from .buttons import StopButton
 from .dock import BECDock, BECDockArea
 from .figure import BECFigure, FigureConfig
 from .scan_control import ScanControl

bec_widgets-0.61.0/bec_widgets/widgets/buttons/__init__.py

@@ -0,0 +1 @@
+from .stop_button.stop_button import StopButton

bec_widgets-0.61.0/bec_widgets/widgets/buttons/stop_button/stop_button.py

@@ -0,0 +1,32 @@
+from qtpy.QtWidgets import QPushButton
+
+from bec_widgets.utils import BECConnector
+
+
+class StopButton(BECConnector, QPushButton):
+    """A button that stops the current scan."""
+
+    def __init__(self, parent=None, client=None, config=None, gui_id=None):
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QPushButton.__init__(self, parent=parent)
+
+        self.get_bec_shortcuts()
+        self.setText("Stop")
+        self.setStyleSheet("background-color:  #cc181e; color: white")
+        self.clicked.connect(self.stop_scan)
+
+    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-0.61.0/docs/user/widgets/buttons.md

@@ -0,0 +1,38 @@
+(user.widgets.buttons)=
+
+# Buttons Widgets
+
+This section consolidates various custom buttons used within the BEC GUIs, facilitating the integration of these
+controls into different layouts.
+
+## Stop Button
+
+**Purpose:**
+
+The `Stop Button` provides a user interface control to immediately halt the execution of the current operation in the
+BEC Client. It is designed for easy integration into any BEC GUI layout.
+
+**Key Features:**
+
+- **Immediate Termination:** Halts the execution of the current script or process.
+- **Queue Management:** Clears any pending operations in the scan queue, ensuring the system is ready for new tasks.
+
+**Code example:**
+
+Integrating the `StopButton` into a BEC GUI layout is straightforward. The following example demonstrates how to embed
+a `StopButton` within a GUI layout:
+
+```python
+from qtpy.QtWidgets import QWidget, QVBoxLayout
+from bec_widgets.widgets import StopButton
+
+
+class MyGui(QWidget):
+    def __init__(self):
+        super().__init__()
+        self.setLayout(QVBoxLayout(self))  # Initialize the layout for the widget
+
+        # Create and add the StopButton to the layout
+        self.stop_button = StopButton()
+        self.layout().addWidget(self.stop_button)
+```

{bec_widgets-0.60.0 → bec_widgets-0.61.0}/docs/user/widgets/widgets.md

@@ -11,6 +11,7 @@ hidden: false
 bec_figure/
 spiral_progress_bar/
 website/
+buttons/
 ```
 
 

{bec_widgets-0.60.0 → bec_widgets-0.61.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.60.0"
+version = "0.61.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [

{bec_widgets-0.60.0 → bec_widgets-0.61.0}/tests/end-2-end/test_bec_dock_rpc_e2e.py

@@ -253,8 +253,14 @@ def test_auto_update(bec_client_lib, rpc_server_dock):
     plt_data = widgets[0].get_all_data()
 
     # check plotted data
-    assert plt_data["bpm4i-bpm4i"]["x"] == last_scan_data["samx"]["samx"].val
-    assert plt_data["bpm4i-bpm4i"]["y"] == last_scan_data["bpm4i"]["bpm4i"].val
+    assert (
+        plt_data[f"Scan {status.scan.scan_number} - bpm4i"]["x"]
+        == last_scan_data["samx"]["samx"].val
+    )
+    assert (
+        plt_data[f"Scan {status.scan.scan_number} - bpm4i"]["y"]
+        == last_scan_data["bpm4i"]["bpm4i"].val
+    )
 
     status = scans.grid_scan(
         dev.samx, -10, 10, 5, dev.samy, -5, 5, 5, exp_time=0.05, relative=False
@@ -268,5 +274,11 @@ def test_auto_update(bec_client_lib, rpc_server_dock):
     last_scan_data = queue.scan_storage.storage[-1].data
 
     # check plotted data
-    assert plt_data[f"Scan {status.scan.scan_number}"]["x"] == last_scan_data["samx"]["samx"].val
-    assert plt_data[f"Scan {status.scan.scan_number}"]["y"] == last_scan_data["samy"]["samy"].val
+    assert (
+        plt_data[f"Scan {status.scan.scan_number} - {dock.selected_device}"]["x"]
+        == last_scan_data["samx"]["samx"].val
+    )
+    assert (
+        plt_data[f"Scan {status.scan.scan_number} - {dock.selected_device}"]["y"]
+        == last_scan_data["samy"]["samy"].val
+    )

bec_widgets-0.61.0/tests/unit_tests/test_stop_button.py

@@ -0,0 +1,25 @@
+# pylint: disable=missing-function-docstring, missing-module-docstring, unused-import
+
+import pytest
+
+from bec_widgets.widgets import StopButton
+
+from .client_mocks import mocked_client
+
+
+@pytest.fixture
+def stop_button(qtbot, mocked_client):
+    widget = StopButton(client=mocked_client)
+    qtbot.addWidget(widget)
+    qtbot.waitExposed(widget)
+    yield widget
+    widget.close()
+
+
+def test_stop_button(stop_button):
+    assert stop_button.text() == "Stop"
+    assert stop_button.styleSheet() == "background-color:  #cc181e; color: white"
+    stop_button.click()
+    assert stop_button.queue.request_scan_abortion.called
+    assert stop_button.queue.request_queue_reset.called
+    stop_button.close()