docs: added video tutorial section with BSEG YT video

Automatically generated by python-semantic-release

CHANGELOG.md

@@ -1,5 +1,29 @@
 # CHANGELOG
 
+## v0.93.0 (2024-08-05)
+
+### Feature
+
+* feat(themes): moved themes to bec_qthemes
+
+This reverts commit fd6ae91993a23a7b8dbb2cf3c4b7c3eda6d2b0f6 ([`5aad401`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5aad401ef8774c7330784f72cd3b9d8c253e2b6a))
+
+## v0.92.5 (2024-08-05)
+
+### Fix
+
+* fix(spinner): stop timer on close event ([`30fef92`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/30fef929cf6fb4b73f48151c92a0ee54c734031d))
+
+* fix(status_box): fix cleanup of status box ([`1f30dd7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1f30dd73a9c1e3135087a5eef92c7329f54a604e))
+
+### Refactor
+
+* refactor(queue): refactored bec queue to inherit only from qwidget ([`7616ca0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7616ca0e145e233ccb48029a8c0b54b54b5b4194))
+
+### Test
+
+* test: register all widgets with qtbot and close them ([`73cd11e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/73cd11e47277e4437554b785a9551b28a572094f))
+
 ## v0.92.4 (2024-07-31)
 
 ### Fix
@@ -122,28 +146,6 @@ This reverts commit 3798714369adf4023f833b7749d2f46a0ec74eee ([`fd6ae91`](https:
 
 ## v0.88.1 (2024-07-22)
 
-### Documentation
-
-* docs: readthedocs icon path fixed ([`2bcaa42`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2bcaa4256d6daaefacb3ead8c72458d7b1498e29))
-
-### Fix
-
-* fix(plot_base): set_xy autorange moved to plotbase from waveform ([`a3dff7d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a3dff7decc16115c12dc6b4ef1572552368da309))
-
 ### Refactor
 
 * refactor(toolbar): generalizations of the ToolBarAction ([`ad112d1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ad112d1f08157f6987edd48a0bacf9f669ef1997))
-
-## v0.88.0 (2024-07-19)
-
-### Fix
-
-* fix(waveform_widget): plot API unified with BECFigure ([`2c8764a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2c8764a27de89b39b717032b58465e120ec57fbc))
-
-* fix(colormap_selector): compatibility for PyQt6 when using designer fixed ([`50135b5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/50135b5fe90a88618291e9357f180cb19251dace))
-
-* fix(waveform_widget): adapted for BECWidget base class ([`6eb313f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6eb313fa76e559d62ecd8fa8849142b83817e47c))
-
-### Test
-
-* test(waveform_widget): test added ([`8d764e2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8d764e2d46a1e017dadc3c4630648c1ca708afc2))

bec_widgets/utils/colors.py

@@ -2,11 +2,10 @@ import itertools
 import re
 from typing import Literal
 
+import bec_qthemes
 import numpy as np
 import pyqtgraph as pg
-import qdarkstyle
 from pydantic_core import PydanticCustomError
-from qdarkstyle import DarkPalette, LightPalette
 from qtpy.QtGui import QColor
 from qtpy.QtWidgets import QApplication
 
@@ -14,7 +13,7 @@ CURRENT_THEME = "dark"
 
 
 def get_theme_palette():
-    return DarkPalette if CURRENT_THEME == "dark" else LightPalette
+    return bec_qthemes.load_palette(CURRENT_THEME)
 
 
 def apply_theme(theme: Literal["dark", "light"]):
@@ -30,7 +29,7 @@ def apply_theme(theme: Literal["dark", "light"]):
         pg_widget.setBackground("k" if theme == "dark" else "w")
 
     # now define stylesheet according to theme and apply it
-    style = qdarkstyle.load_stylesheet(palette=get_theme_palette())
+    style = bec_qthemes.load_stylesheet(theme)
     app.setStyleSheet(style)
 
 

bec_widgets/widgets/bec_queue/bec_queue.py

@@ -1,12 +1,12 @@
 from bec_lib.endpoints import MessageEndpoints
 from qtpy.QtCore import Qt, Slot
-from qtpy.QtWidgets import QHeaderView, QTableWidget, QTableWidgetItem, QWidget
+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, QTableWidget):
+class BECQueue(BECWidget, QWidget):
     """
     Widget to display the BEC queue.
     """
@@ -19,10 +19,14 @@ class BECQueue(BECWidget, QTableWidget):
         gui_id: str = None,
     ):
         super().__init__(client, config, gui_id)
-        QTableWidget.__init__(self, parent=parent)
-        self.setColumnCount(3)
-        self.setHorizontalHeaderLabels(["Scan Number", "Type", "Status"])
-        header = self.horizontalHeader()
+        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()
@@ -38,8 +42,8 @@ class BECQueue(BECWidget, QTableWidget):
         """
         # only show the primary queue for now
         queue_info = content.get("queue", {}).get("primary", {}).get("info", [])
-        self.setRowCount(len(queue_info))
-        self.clearContents()
+        self.table.setRowCount(len(queue_info))
+        self.table.clearContents()
 
         if not queue_info:
             self.reset_content()
@@ -73,6 +77,8 @@ class BECQueue(BECWidget, QTableWidget):
         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
@@ -88,16 +94,16 @@ class BECQueue(BECWidget, QTableWidget):
             status (str): The status.
         """
 
-        self.setItem(index, 0, self.format_item(scan_number))
-        self.setItem(index, 1, self.format_item(scan_type))
-        self.setItem(index, 2, self.format_item(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.setRowCount(1)
+        self.table.setRowCount(1)
         self.set_row(0, "", "", "")
 
 

bec_widgets/widgets/bec_status_box/bec_status_box.py

@@ -56,6 +56,11 @@ class BECServiceStatusMixin(QObject):
         self.client._update_existing_services()
         self.services_update.emit(self.client._services_info, self.client._services_metric)
 
+    def cleanup(self):
+        """Cleanup the BECServiceStatusMixin."""
+        self._service_update_timer.stop()
+        self._service_update_timer.deleteLater()
+
 
 class BECStatusBox(BECWidget, QWidget):
     """An autonomous widget to display the status of BEC services.
@@ -290,6 +295,11 @@ class BECStatusBox(BECWidget, QWidget):
             if objects["item"] == item:
                 objects["widget"].show_popup()
 
+    def cleanup(self):
+        """Cleanup the BECStatusBox widget."""
+        self.bec_service_status.cleanup()
+        return super().cleanup()
+
 
 def main():
     """Main method to run the BECStatusBox widget."""

bec_widgets/widgets/spinner/spinner.py

@@ -55,7 +55,7 @@ class SpinnerWidget(QWidget):
 
         color_palette = get_theme_palette()
 
-        color = QColor(color_palette.COLOR_ACCENT_4)
+        color = QColor(color_palette.accent().color())
 
         rect.adjust(line_width, line_width, -line_width, -line_width)
 
@@ -75,6 +75,10 @@ class SpinnerWidget(QWidget):
             painter.drawArc(adjusted_rect, self.angle * 16, int(angle_span))
         painter.end()
 
+    def closeEvent(self, event):
+        self.timer.stop()
+        super().closeEvent(event)
+
 
 if __name__ == "__main__":  # pragma: no cover
     app = QApplication(sys.argv)

docs/user/getting_started/getting_started.md

@@ -11,4 +11,5 @@ hidden: true
 installation/
 quick_start/
 auto_updates/
+video_tutorials/
 ```

docs/user/getting_started/video_tutorials.md

@@ -0,0 +1,17 @@
+(user.video_tutorials)=
+
+# Video Tutorials
+
+This section includes video tutorials that demonstrate various use cases of `bec-widgets`, including video tutorials,
+presentations, and conference talks.
+
+## BSEG Meeting 24th July 2024
+
+This video is a presentation of the BEC Widgets project at the BSEG meeting on the 24th July 2024. The presentation
+covers the basic interactions, including visualization of live data acquisition and how to steer experiments using
+user-friendly tools. Learn how BEC Widgets can enhance your experimental control projects with its intuitive interface
+and powerful features.
+
+Used version of BEC Widgets: 0.91.0
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/qZ8fWXRAdHE" frameborder="0" allowfullscreen></iframe>

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.92.4"
+version = "0.93.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [
@@ -19,7 +19,7 @@ dependencies = [
     "isort~=5.13, >=5.13.2",    # needed for bw-generate-cli
     "pydantic~=2.0",
     "pyqtgraph~=0.13",
-    "qdarkstyle>=3.2.2",
+    "bec_qthemes~=0.0",
     "qtconsole~=5.5, >=5.5.1",  # needed for jupyter console
     "qtpy~=2.4",
     "pyte",                     # needed for vt100 console

tests/end-2-end/test_scan_control_e2e.py

@@ -12,6 +12,7 @@ def scan_control(qtbot, bec_client_lib):  # , mock_dev):
     qtbot.addWidget(widget)
     qtbot.waitExposed(widget)
     yield widget
+    widget.close()
 
 
 def test_scan_control_populate_scans_e2e(scan_control):

tests/unit_tests/conftest.py

@@ -8,6 +8,7 @@ from bec_widgets.utils import bec_dispatcher as bec_dispatcher_module
 @pytest.fixture(autouse=True)
 def qapplication(qapp):  # pylint: disable=unused-argument
     yield
+    qapp.processEvents()  # make sure all events are processed before shutting down
 
 
 @pytest.fixture(autouse=True)

tests/unit_tests/test_bec_queue.py

@@ -93,19 +93,20 @@ def bec_queue(qtbot, mocked_client):
     qtbot.addWidget(widget)
     qtbot.waitExposed(widget)
     yield widget
+    widget.close()
 
 
 def test_bec_queue(bec_queue, bec_queue_msg_full):
     bec_queue.update_queue(bec_queue_msg_full.content, {})
-    assert bec_queue.rowCount() == 1
-    assert bec_queue.item(0, 0).text() == "1289"
-    assert bec_queue.item(0, 1).text() == "line_scan"
-    assert bec_queue.item(0, 2).text() == "COMPLETED"
+    assert bec_queue.table.rowCount() == 1
+    assert bec_queue.table.item(0, 0).text() == "1289"
+    assert bec_queue.table.item(0, 1).text() == "line_scan"
+    assert bec_queue.table.item(0, 2).text() == "COMPLETED"
 
 
 def test_bec_queue_empty(bec_queue):
     bec_queue.update_queue({}, {})
-    assert bec_queue.rowCount() == 1
-    assert bec_queue.item(0, 0).text() == ""
-    assert bec_queue.item(0, 1).text() == ""
-    assert bec_queue.item(0, 2).text() == ""
+    assert bec_queue.table.rowCount() == 1
+    assert bec_queue.table.item(0, 0).text() == ""
+    assert bec_queue.table.item(0, 1).text() == ""
+    assert bec_queue.table.item(0, 2).text() == ""

tests/unit_tests/test_bec_status_box.py

@@ -20,6 +20,7 @@ def status_box(qtbot, mocked_client, service_status_fixture):
     qtbot.addWidget(widget)
     qtbot.waitExposed(widget)
     yield widget
+    widget.close()
 
 
 def test_update_top_item(status_box):

tests/unit_tests/test_device_input_base.py

@@ -8,13 +8,18 @@ from .client_mocks import mocked_client
 
 # DeviceInputBase is meant to be mixed in a QWidget
 class DeviceInputWidget(DeviceInputBase, QWidget):
-    pass
+    def __init__(self, parent=None, client=None, config=None, gui_id=None):
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent=parent)
 
 
 @pytest.fixture
-def device_input_base(mocked_client):
+def device_input_base(qtbot, mocked_client):
     widget = DeviceInputWidget(client=mocked_client)
+    qtbot.addWidget(widget)
+    qtbot.waitExposed(widget)
     yield widget
+    widget.close()
 
 
 def test_device_input_base_init(device_input_base):

tests/unit_tests/test_scan_control.py

@@ -220,6 +220,7 @@ def scan_control(qtbot, mocked_client):  # , mock_dev):
     qtbot.addWidget(widget)
     qtbot.waitExposed(widget)
     yield widget
+    widget.close()
 
 
 def test_populate_scans(scan_control, mocked_client):

tests/unit_tests/test_setting_dialog.py

@@ -46,23 +46,23 @@ def test_setting_widget_display_current_settings(setting_widget):
 # SettingsDialog tests
 ###################################
 @pytest.fixture
-def settings_dialog(qtbot):
+def settings_dialog(qtbot, setting_widget):
     parent_widget = QWidget()
-    settings_widget = SettingWidget()
-    settings_widget.set_target_widget = MagicMock()
-    settings_widget.display_current_settings = MagicMock()
-    settings_widget.accept_changes = MagicMock()
+    setting_widget.set_target_widget = MagicMock()
+    setting_widget.display_current_settings = MagicMock()
+    setting_widget.accept_changes = MagicMock()
 
     dialog = SettingsDialog(
         parent=parent_widget,
-        settings_widget=settings_widget,
+        settings_widget=setting_widget,
         window_title="Test Settings",
         config={"setting1": "value1", "setting2": "value2"},
     )
     qtbot.addWidget(dialog)
     qtbot.waitExposed(dialog)
-    yield dialog, parent_widget, settings_widget
+    yield dialog, parent_widget, setting_widget
     dialog.close()
+    parent_widget.close()
 
 
 def test_settings_dialog_initialization(settings_dialog):

tests/unit_tests/test_spinner.py

@@ -12,6 +12,7 @@ def spinner_widget(qtbot):
     qtbot.addWidget(spinner)
     qtbot.waitExposed(spinner)
     yield spinner
+    spinner.close()
 
 
 def test_spinner_widget_paint_event(spinner_widget, qtbot):

tests/unit_tests/test_toggle.py

@@ -10,6 +10,7 @@ def toggle(qtbot):
     qtbot.addWidget(widget)
     qtbot.waitExposed(widget)
     yield widget
+    widget.close()
 
 
 def test_toggle(toggle):

tests/unit_tests/test_vscode_widget.py

@@ -14,7 +14,9 @@ from .client_mocks import mocked_client
 def vscode_widget(qtbot, mocked_client):
     with mock.patch("bec_widgets.widgets.vscode.vscode.subprocess.Popen") as mock_popen:
         widget = VSCodeEditor(client=mocked_client)
+        # qtbot.addWidget(widget)
         yield widget
+        # widget.close()
 
 
 def test_vscode_widget(qtbot, vscode_widget):