bec-widgets 0.101.0__tar.gz → 0.102.0__tar.gz

{bec_widgets-0.101.0 → bec_widgets-0.102.0}/CHANGELOG.md

@@ -1,5 +1,25 @@
 # CHANGELOG
 
+## v0.102.0 (2024-09-04)
+
+### Documentation
+
+* docs(buttons): buttons section of docs split to appearance and queue buttons ([`047aa26`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/047aa26a60220c826cc1375cf81daf11d1f3ab5c))
+
+* docs(tests): added tests tutorial for widget ([`18d8561`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/18d8561c965d149a7662085f7dbe2a39a8c4a475))
+
+### Feature
+
+* feat(queue): BECQueue controls extended with Resume, Stop, Abort, Reset buttons ([`0d7c10e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0d7c10e670e4937787e1afaa19ca8259ac752486))
+
+### Fix
+
+* fix(queue_reset_button): queue reset has to be confirmed with msgBox ([`9dd43aa`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9dd43aa1fd3991368002605df4389a7a7271011b))
+
+### Refactor
+
+* refactor(tests): positioner box test changed to use create_widget fixture ([`df5eff3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/df5eff3147c79ff0278e6a5a09c8f73d5236aed3))
+
 ## v0.101.0 (2024-09-02)
 
 ### Feature
@@ -134,22 +154,6 @@
 
 * docs(buttons): added missing buttons docs ([`4e5520a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4e5520aee2115d2fc0cebb3865433478a5ec8253))
 
-* docs(developer): tutorial for BECWidget base class ([`ac2cb51`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ac2cb5197deef4d51e26ee5beb070eba3ffc210d))
-
 ### Fix
 
 * fix(theme): apply theme to all pyqtgraph widgets on manual updates ([`c550186`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c5501860e8e07a53f4bce144d44ed39eda6290ef))
-
-### Refactor
-
-* refactor(buttons): changed grid and thumbnail fig in gallery ([`4591ba8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4591ba8f73e22aba7258cad93c073f1387cb74a0))
-
-* refactor(icons): removed toolbar icons from assets ([`f335763`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f335763280adb1d83ba31f073ce206e4cb5d15ef))
-
-* refactor(icons): moved widget icons to class attribute ICON_NAME ([`e890091`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e890091d862e42317c7a54fc414ba37c85f268b0))
-
-## v0.99.3 (2024-08-27)
-
-### Build
-
-* build: updated min version of bec qthemes ([`d482434`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d48243483ef8228cc5eb85e40a6b8f5da3b45520))

{bec_widgets-0.101.0 → bec_widgets-0.102.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.101.0
+Version: 0.102.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.101.0 → bec_widgets-0.102.0}/bec_widgets/qt_utils/toolbar.py

@@ -162,6 +162,7 @@ class WidgetAction(ToolBarAction):
     def add_to_toolbar(self, toolbar, target):
         widget = QWidget()
         layout = QHBoxLayout(widget)
+        layout.setContentsMargins(0, 0, 0, 0)
         if self.label is not None:
             label = QLabel(f"{self.label}")
             layout.addWidget(label)

bec_widgets-0.102.0/bec_widgets/widgets/bec_queue/bec_queue.py

@@ -0,0 +1,244 @@
+from __future__ import annotations
+
+from bec_lib.endpoints import MessageEndpoints
+from bec_qthemes import material_icon
+from qtpy.QtCore import Property, Qt, Slot
+from qtpy.QtGui import QColor
+from qtpy.QtWidgets import QHeaderView, QLabel, QTableWidget, QTableWidgetItem, QVBoxLayout, QWidget
+
+from bec_widgets.qt_utils.toolbar import ModularToolBar, SeparatorAction, WidgetAction
+from bec_widgets.utils.bec_connector import ConnectionConfig
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.widgets.button_abort.button_abort import AbortButton
+from bec_widgets.widgets.button_reset.button_reset import ResetButton
+from bec_widgets.widgets.button_resume.button_resume import ResumeButton
+from bec_widgets.widgets.stop_button.stop_button import StopButton
+
+
+class BECQueue(BECWidget, QWidget):
+    """
+    Widget to display the BEC queue.
+    """
+
+    ICON_NAME = "edit_note"
+    status_colors = {
+        "STOPPED": "red",
+        "PENDING": "orange",
+        "IDLE": "gray",
+        "PAUSED": "yellow",
+        "DEFERRED_PAUSE": "lightyellow",
+        "RUNNING": "green",
+        "COMPLETED": "blue",
+    }
+
+    def __init__(
+        self,
+        parent: QWidget | None = None,
+        client=None,
+        config: ConnectionConfig = None,
+        gui_id: str = None,
+        refresh_upon_start: bool = True,
+    ):
+        super().__init__(client, config, gui_id)
+        QWidget.__init__(self, parent=parent)
+        self.layout = QVBoxLayout(self)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+
+        # Set up the toolbar
+        self.set_toolbar()
+
+        # Set up the table
+        self.table = QTableWidget(self)
+        self.layout.addWidget(self.table)
+        self.table.setColumnCount(4)
+        self.table.setHorizontalHeaderLabels(["Scan Number", "Type", "Status", "Cancel"])
+        header = self.table.horizontalHeader()
+        header.setSectionResizeMode(QHeaderView.Stretch)
+
+        self.bec_dispatcher.connect_slot(self.update_queue, MessageEndpoints.scan_queue_status())
+        self.reset_content()
+        if refresh_upon_start:
+            self.refresh_queue()
+
+    def set_toolbar(self):
+        """
+        Set the toolbar.
+        """
+        widget_label = QLabel("Live Queue")
+        widget_label.setStyleSheet("font-weight: bold;")
+        self.toolbar = ModularToolBar(
+            actions={
+                "widget_label": WidgetAction(widget=widget_label),
+                "separator_1": SeparatorAction(),
+                "resume": WidgetAction(widget=ResumeButton(toolbar=False)),
+                "stop": WidgetAction(widget=StopButton(toolbar=False)),
+                "reset": WidgetAction(widget=ResetButton(toolbar=False)),
+            },
+            target_widget=self,
+        )
+
+        self.layout.addWidget(self.toolbar)
+
+    @Property(bool)
+    def hide_toolbar(self):
+        """Property to hide the BEC Queue toolbar."""
+        return not self.toolbar.isVisible()
+
+    @hide_toolbar.setter
+    def hide_toolbar(self, hide: bool):
+        """
+        Setters for the hide_toolbar property.
+
+        Args:
+            hide(bool): Whether to hide the toolbar.
+        """
+        self._hide_toolbar(hide)
+
+    def _hide_toolbar(self, hide: bool):
+        """
+        Hide the toolbar.
+
+        Args:
+            hide(bool): Whether to hide the toolbar.
+        """
+        self.toolbar.setVisible(not hide)
+
+    def refresh_queue(self):
+        """
+        Refresh the queue.
+        """
+        msg = self.client.connector.get(MessageEndpoints.scan_queue_status())
+        self.update_queue(msg.content, msg.metadata)
+
+    @Slot(dict, dict)
+    def update_queue(self, content, _metadata):
+        """
+        Update the queue table with the latest queue information.
+
+        Args:
+            content (dict): The queue content.
+            _metadata (dict): The metadata.
+        """
+        # only show the primary queue for now
+        queue_info = content.get("queue", {}).get("primary", {}).get("info", [])
+        self.table.setRowCount(len(queue_info))
+        self.table.clearContents()
+
+        if not queue_info:
+            self.reset_content()
+            return
+
+        for index, item in enumerate(queue_info):
+            blocks = item.get("request_blocks", [])
+            scan_types = []
+            scan_numbers = []
+            scan_ids = []
+            status = item.get("status", "")
+            for request_block in blocks:
+                scan_type = request_block.get("content", {}).get("scan_type", "")
+                if scan_type:
+                    scan_types.append(scan_type)
+                scan_number = request_block.get("scan_number", "")
+                if scan_number:
+                    scan_numbers.append(str(scan_number))
+                scan_id = request_block.get("scan_id", "")
+                if scan_id:
+                    scan_ids.append(scan_id)
+            if scan_types:
+                scan_types = ", ".join(scan_types)
+            if scan_numbers:
+                scan_numbers = ", ".join(scan_numbers)
+            if scan_ids:
+                scan_ids = ", ".join(scan_ids)
+            self.set_row(index, scan_numbers, scan_types, status, scan_ids)
+
+    def format_item(self, content: str, status=False) -> QTableWidgetItem:
+        """
+        Format the content of the table item.
+
+        Args:
+            content (str): The content to be formatted.
+
+        Returns:
+            QTableWidgetItem: The formatted item.
+        """
+        if not content or not isinstance(content, str):
+            content = ""
+        item = QTableWidgetItem(content)
+        item.setTextAlignment(Qt.AlignHCenter | Qt.AlignVCenter)
+        # item.setFlags(item.flags() & ~Qt.ItemFlag.ItemIsEditable)
+
+        if status:
+            try:
+                color = self.status_colors.get(content, "black")  # Default to black if not found
+                item.setForeground(QColor(color))
+            except:
+                return item
+        return item
+
+    def set_row(self, index: int, scan_number: str, scan_type: str, status: str, scan_id: str):
+        """
+        Set the row of the table.
+
+        Args:
+            index (int): The index of the row.
+            scan_number (str): The scan number.
+            scan_type (str): The scan type.
+            status (str): The status.
+        """
+        abort_button = self._create_abort_button(scan_id)
+        abort_button.button.clicked.connect(self.delete_selected_row)
+
+        self.table.setItem(index, 0, self.format_item(scan_number))
+        self.table.setItem(index, 1, self.format_item(scan_type))
+        self.table.setItem(index, 2, self.format_item(status, status=True))
+        self.table.setCellWidget(index, 3, abort_button)
+
+    def _create_abort_button(self, scan_id: str) -> AbortButton:
+        """
+        Create an abort button with styling for BEC Queue widget for certain scan_id.
+
+        Args:
+            scan_id(str): The scan id to abort.
+
+        Returns:
+            AbortButton: The abort button.
+        """
+        abort_button = AbortButton(scan_id=scan_id)
+
+        abort_button.button.setText("")
+        abort_button.button.setIcon(
+            material_icon("cancel", color="#cc181e", filled=True, convert_to_pixmap=False)
+        )
+        abort_button.button.setStyleSheet("background-color:  rgba(0,0,0,0) ")
+        abort_button.button.setFlat(True)
+
+        return abort_button
+
+    def delete_selected_row(self):
+
+        button = self.sender()
+        row = self.table.indexAt(button.pos()).row()
+        self.table.removeRow(row)
+
+        button.deleteLater()
+
+    def reset_content(self):
+        """
+        Reset the content of the table.
+        """
+
+        self.table.setRowCount(1)
+        self.set_row(0, "", "", "", "")
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    from qtpy.QtWidgets import QApplication
+
+    app = QApplication(sys.argv)
+    widget = BECQueue()
+    widget.show()
+    sys.exit(app.exec_())

{bec_widgets-0.101.0 → bec_widgets-0.102.0}/bec_widgets/widgets/button_abort/button_abort.py

@@ -11,7 +11,9 @@ class AbortButton(BECWidget, QWidget):
 
     ICON_NAME = "cancel"
 
-    def __init__(self, parent=None, client=None, config=None, gui_id=None, toolbar=False):
+    def __init__(
+        self, parent=None, client=None, config=None, gui_id=None, toolbar=False, scan_id=None
+    ):
         super().__init__(client=client, config=config, gui_id=gui_id)
         QWidget.__init__(self, parent=parent)
 
@@ -25,17 +27,19 @@ class AbortButton(BECWidget, QWidget):
         if toolbar:
             icon = material_icon("cancel", color="#666666", filled=True)
             self.button = QToolButton(icon=icon)
-            self.button.triggered.connect(self.abort_scan)
+            self.button.setToolTip("Abort the scan")
         else:
             self.button = QPushButton()
             self.button.setText("Abort")
             self.button.setStyleSheet(
                 "background-color:  #666666; color: white; font-weight: bold; font-size: 12px;"
             )
-            self.button.clicked.connect(self.abort_scan)
+        self.button.clicked.connect(self.abort_scan)
 
         self.layout.addWidget(self.button)
 
+        self.scan_id = scan_id
+
     @SafeSlot()
     def abort_scan(
         self,
@@ -46,4 +50,8 @@ class AbortButton(BECWidget, QWidget):
         Args:
             scan_id(str|None): The scan id to abort. If None, the current scan will be aborted.
         """
-        self.queue.request_scan_abortion()
+        if self.scan_id is not None:
+            print(f"Aborting scan with scan_id: {self.scan_id}")
+            self.queue.request_scan_abortion(scan_id=self.scan_id)
+        else:
+            self.queue.request_scan_abortion()

{bec_widgets-0.101.0 → bec_widgets-0.102.0}/bec_widgets/widgets/button_reset/button_reset.py

@@ -1,13 +1,13 @@
 from bec_qthemes import material_icon
 from qtpy.QtCore import Qt
-from qtpy.QtWidgets import QHBoxLayout, QPushButton, QToolButton, QWidget
+from qtpy.QtWidgets import QHBoxLayout, QMessageBox, QPushButton, QToolButton, QWidget
 
 from bec_widgets.qt_utils.error_popups import SafeSlot
 from bec_widgets.utils.bec_widget import BECWidget
 
 
 class ResetButton(BECWidget, QWidget):
-    """A button that reset the scan queue."""
+    """A button that resets the scan queue."""
 
     ICON_NAME = "restart_alt"
 
@@ -23,20 +23,37 @@ class ResetButton(BECWidget, QWidget):
         self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
 
         if toolbar:
-            icon = material_icon("restart_alt", color="#F19E39", filled=True)
+            icon = material_icon(
+                "restart_alt", color="#F19E39", filled=True, convert_to_pixmap=False
+            )
             self.button = QToolButton(icon=icon)
-            self.button.triggered.connect(self.reset_queue)
+            self.button.setToolTip("Reset the scan queue")
         else:
             self.button = QPushButton()
             self.button.setText("Reset Queue")
             self.button.setStyleSheet(
                 "background-color:  #F19E39; color: white; font-weight: bold; font-size: 12px;"
             )
-            self.button.clicked.connect(self.reset_queue)
+        self.button.clicked.connect(self.confirm_reset_queue)
 
         self.layout.addWidget(self.button)
 
+    @SafeSlot()
+    def confirm_reset_queue(self):
+        """Prompt the user to confirm the queue reset."""
+        msg_box = QMessageBox()
+        msg_box.setIcon(QMessageBox.Warning)
+        msg_box.setWindowTitle("Confirm Reset")
+        msg_box.setText(
+            "Are you sure you want to reset the scan queue? This action cannot be undone."
+        )
+        msg_box.setStandardButtons(QMessageBox.Yes | QMessageBox.No)
+        msg_box.setDefaultButton(QMessageBox.No)
+
+        if msg_box.exec_() == QMessageBox.Yes:
+            self.reset_queue()
+
     @SafeSlot()
     def reset_queue(self):
-        """Stop the scan."""
+        """Reset the scan queue."""
         self.queue.request_queue_reset()

{bec_widgets-0.101.0 → bec_widgets-0.102.0}/bec_widgets/widgets/button_resume/button_resume.py

@@ -23,16 +23,16 @@ class ResumeButton(BECWidget, QWidget):
         self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
 
         if toolbar:
-            icon = material_icon("resume", color="#2793e8", filled=True)
+            icon = material_icon("resume", color="#2793e8", filled=True, convert_to_pixmap=False)
             self.button = QToolButton(icon=icon)
-            self.button.triggered.connect(self.continue_scan)
+            self.button.setToolTip("Resume the scan queue")
         else:
             self.button = QPushButton()
             self.button.setText("Resume")
             self.button.setStyleSheet(
                 "background-color:  #2793e8; color: white; font-weight: bold; font-size: 12px;"
             )
-            self.button.clicked.connect(self.continue_scan)
+        self.button.clicked.connect(self.continue_scan)
 
         self.layout.addWidget(self.button)
 

{bec_widgets-0.101.0 → bec_widgets-0.102.0}/bec_widgets/widgets/stop_button/stop_button.py

@@ -23,16 +23,16 @@ class StopButton(BECWidget, QWidget):
         self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
 
         if toolbar:
-            icon = material_icon("stop", color="#cc181e", filled=True)
+            icon = material_icon("stop", color="#cc181e", filled=True, convert_to_pixmap=False)
             self.button = QToolButton(icon=icon)
-            self.button.triggered.connect(self.stop_scan)
+            self.button.setToolTip("Stop the scan queue")
         else:
             self.button = QPushButton()
             self.button.setText("Stop")
             self.button.setStyleSheet(
                 "background-color:  #cc181e; color: white; font-weight: bold; font-size: 12px;"
             )
-            self.button.clicked.connect(self.stop_scan)
+        self.button.clicked.connect(self.stop_scan)
 
         self.layout.addWidget(self.button)
 

{bec_widgets-0.101.0 → bec_widgets-0.102.0}/pyproject.toml

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

bec_widgets-0.101.0/bec_widgets/widgets/bec_queue/bec_queue.py

@@ -1,122 +0,0 @@
-from __future__ import annotations
-
-from bec_lib.endpoints import MessageEndpoints
-from qtpy.QtCore import Qt, Slot
-from qtpy.QtWidgets import QHBoxLayout, QHeaderView, QTableWidget, QTableWidgetItem, QWidget
-
-from bec_widgets.utils.bec_connector import ConnectionConfig
-from bec_widgets.utils.bec_widget import BECWidget
-
-
-class BECQueue(BECWidget, QWidget):
-    """
-    Widget to display the BEC queue.
-    """
-
-    ICON_NAME = "edit_note"
-
-    def __init__(
-        self,
-        parent: QWidget | None = None,
-        client=None,
-        config: ConnectionConfig = None,
-        gui_id: str = None,
-    ):
-        super().__init__(client, config, gui_id)
-        QWidget.__init__(self, parent=parent)
-        self.table = QTableWidget(self)
-        self.layout = QHBoxLayout(self)
-        self.layout.addWidget(self.table)
-
-        self.table.setColumnCount(3)
-        self.table.setHorizontalHeaderLabels(["Scan Number", "Type", "Status"])
-        header = self.table.horizontalHeader()
-        header.setSectionResizeMode(QHeaderView.Stretch)
-        self.bec_dispatcher.connect_slot(self.update_queue, MessageEndpoints.scan_queue_status())
-        self.reset_content()
-
-    @Slot(dict, dict)
-    def update_queue(self, content, _metadata):
-        """
-        Update the queue table with the latest queue information.
-
-        Args:
-            content (dict): The queue content.
-            _metadata (dict): The metadata.
-        """
-        # only show the primary queue for now
-        queue_info = content.get("queue", {}).get("primary", {}).get("info", [])
-        self.table.setRowCount(len(queue_info))
-        self.table.clearContents()
-
-        if not queue_info:
-            self.reset_content()
-            return
-
-        for index, item in enumerate(queue_info):
-            blocks = item.get("request_blocks", [])
-            scan_types = []
-            scan_numbers = []
-            status = item.get("status", "")
-            for request_block in blocks:
-                scan_type = request_block.get("content", {}).get("scan_type", "")
-                if scan_type:
-                    scan_types.append(scan_type)
-                scan_number = request_block.get("scan_number", "")
-                if scan_number:
-                    scan_numbers.append(str(scan_number))
-            if scan_types:
-                scan_types = ", ".join(scan_types)
-            if scan_numbers:
-                scan_numbers = ", ".join(scan_numbers)
-            self.set_row(index, scan_numbers, scan_types, status)
-
-    def format_item(self, content: str) -> QTableWidgetItem:
-        """
-        Format the content of the table item.
-
-        Args:
-            content (str): The content to be formatted.
-
-        Returns:
-            QTableWidgetItem: The formatted item.
-        """
-        if not content or not isinstance(content, str):
-            content = ""
-        item = QTableWidgetItem(content)
-        item.setTextAlignment(Qt.AlignHCenter | Qt.AlignVCenter)
-        return item
-
-    def set_row(self, index: int, scan_number: str, scan_type: str, status: str):
-        """
-        Set the row of the table.
-
-        Args:
-            index (int): The index of the row.
-            scan_number (str): The scan number.
-            scan_type (str): The scan type.
-            status (str): The status.
-        """
-
-        self.table.setItem(index, 0, self.format_item(scan_number))
-        self.table.setItem(index, 1, self.format_item(scan_type))
-        self.table.setItem(index, 2, self.format_item(status))
-
-    def reset_content(self):
-        """
-        Reset the content of the table.
-        """
-
-        self.table.setRowCount(1)
-        self.set_row(0, "", "", "")
-
-
-if __name__ == "__main__":  # pragma: no cover
-    import sys
-
-    from qtpy.QtWidgets import QApplication
-
-    app = QApplication(sys.argv)
-    widget = BECQueue()
-    widget.show()
-    sys.exit(app.exec_())