2.2.0

Automatically generated by python-semantic-release

CHANGELOG.md

@@ -1,6 +1,27 @@
 # CHANGELOG
 
 
+## v2.2.0 (2025-05-09)
+
+### Features
+
+- **launcher**: Add support for launching plugin widget
+  ([`1fb680a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1fb680abb40668e72007c245f32c80112466c46e))
+
+### Refactoring
+
+- **launch_window**: Widget tile added
+  ([`b9e56c9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b9e56c96cbae561beb893cedb7d18e9b6a7bfc76))
+
+
+## v2.1.3 (2025-05-07)
+
+### Bug Fixes
+
+- **bec-dispatcher**: Fix reference to boundmethods to avoid duplicated subscriptions
+  ([`cf59d31`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cf59d311132cd1a21f1893c19cc9f2a7e45101d0))
+
+
 ## v2.1.2 (2025-05-06)
 
 ### Bug Fixes

bec_widgets/applications/launch_window.py

@@ -2,10 +2,10 @@ from __future__ import annotations
 
 import os
 import xml.etree.ElementTree as ET
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Callable
 
 from bec_lib.logger import bec_logger
-from qtpy.QtCore import Qt, Signal
+from qtpy.QtCore import Qt, Signal  # type: ignore
 from qtpy.QtGui import QPainter, QPainterPath, QPixmap
 from qtpy.QtWidgets import (
     QApplication,
@@ -21,8 +21,10 @@ from qtpy.QtWidgets import (
 
 import bec_widgets
 from bec_widgets.cli.rpc.rpc_register import RPCRegister
+from bec_widgets.utils.bec_plugin_helper import get_all_plugin_widgets
 from bec_widgets.utils.container_utils import WidgetContainerUtils
 from bec_widgets.utils.error_popups import SafeSlot
+from bec_widgets.utils.name_utils import pascal_to_snake
 from bec_widgets.utils.plugin_utils import get_plugin_auto_updates
 from bec_widgets.utils.round_frame import RoundedFrame
 from bec_widgets.utils.toolbar import ModularToolBar
@@ -35,6 +37,8 @@ from bec_widgets.widgets.utility.visual.dark_mode_button.dark_mode_button import
 if TYPE_CHECKING:  # pragma: no cover
     from qtpy.QtCore import QObject
 
+    from bec_widgets.utils.bec_widget import BECWidget
+
 logger = bec_logger.logger
 MODULE_PATH = os.path.dirname(bec_widgets.__file__)
 
@@ -141,6 +145,7 @@ class LaunchWindow(BECMainWindow):
         super().__init__(parent=parent, gui_id=gui_id, window_title=window_title, **kwargs)
 
         self.app = QApplication.instance()
+        self.tiles: dict[str, LaunchTile] = {}
 
         # Toolbar
         self.dark_mode_button = DarkModeButton(parent=self, toolbar=True)
@@ -156,58 +161,105 @@ class LaunchWindow(BECMainWindow):
         self.central_widget.layout = QHBoxLayout(self.central_widget)
         self.setCentralWidget(self.central_widget)
 
-        self.tile_dock_area = LaunchTile(
+        self.register_tile(
+            name="dock_area",
             icon_path=os.path.join(MODULE_PATH, "assets", "app_icons", "bec_widgets_icon.png"),
             top_label="Get started",
             main_label="BEC Dock Area",
             description="Highly flexible and customizable dock area application with modular widgets.",
+            action_button=lambda: self.launch("dock_area"),
+            show_selector=False,
         )
-        self.tile_dock_area.setFixedSize(*self.TILE_SIZE)
 
-        self.tile_auto_update = LaunchTile(
+        self.available_auto_updates: dict[str, type[AutoUpdates]] = (
+            self._update_available_auto_updates()
+        )
+        self.register_tile(
+            name="auto_update",
             icon_path=os.path.join(MODULE_PATH, "assets", "app_icons", "auto_update.png"),
             top_label="Get automated",
             main_label="BEC Auto Update Dock Area",
             description="Dock area with auto update functionality for BEC widgets plotting.",
+            action_button=self._open_auto_update,
             show_selector=True,
+            selector_items=list(self.available_auto_updates.keys()) + ["Default"],
         )
-        self.tile_auto_update.setFixedSize(*self.TILE_SIZE)
 
-        self.tile_ui_file = LaunchTile(
+        self.register_tile(
+            name="custom_ui_file",
             icon_path=os.path.join(MODULE_PATH, "assets", "app_icons", "ui_loader_tile.png"),
             top_label="Get customized",
             main_label="Launch Custom UI File",
             description="GUI application with custom UI file.",
+            action_button=self._open_custom_ui_file,
+            show_selector=False,
         )
-        self.tile_ui_file.setFixedSize(*self.TILE_SIZE)
 
-        # Add tiles to the main layout
-        self.central_widget.layout.addWidget(self.tile_dock_area)
-        self.central_widget.layout.addWidget(self.tile_auto_update)
-        self.central_widget.layout.addWidget(self.tile_ui_file)
-
-        # hacky solution no time to waste
-        self.tiles = [self.tile_dock_area, self.tile_auto_update, self.tile_ui_file]
-
-        # Connect signals
-        self.tile_dock_area.action_button.clicked.connect(lambda: self.launch("dock_area"))
-        self.tile_auto_update.action_button.clicked.connect(self._open_auto_update)
-        self.tile_ui_file.action_button.clicked.connect(self._open_custom_ui_file)
-        self._update_theme()
-
-        # Auto updates
-        self.available_auto_updates: dict[str, type[AutoUpdates]] = (
-            self._update_available_auto_updates()
-        )
-        if self.tile_auto_update.selector is not None:
-            self.tile_auto_update.selector.addItems(
-                list(self.available_auto_updates.keys()) + ["Default"]
+        # plugin widgets
+        self.available_widgets: dict[str, BECWidget] = get_all_plugin_widgets()
+        if self.available_widgets:
+            plugin_repo_name = next(iter(self.available_widgets.values())).__module__.split(".")[0]
+            plugin_repo_name = plugin_repo_name.removesuffix("_bec").upper()
+            self.register_tile(
+                name="widget",
+                icon_path=os.path.join(
+                    MODULE_PATH, "assets", "app_icons", "widget_launch_tile.png"
+                ),
+                top_label="Get quickly started",
+                main_label=f"Launch a {plugin_repo_name} Widget",
+                description=f"GUI application with one widget from the {plugin_repo_name} repository.",
+                action_button=self._open_widget,
+                show_selector=True,
+                selector_items=list(self.available_widgets.keys()),
             )
 
+        self._update_theme()
+
         self.register = RPCRegister()
         self.register.callbacks.append(self._turn_off_the_lights)
         self.register.broadcast()
 
+    def register_tile(
+        self,
+        name: str,
+        icon_path: str | None = None,
+        top_label: str | None = None,
+        main_label: str | None = None,
+        description: str | None = None,
+        action_button: Callable | None = None,
+        show_selector: bool = False,
+        selector_items: list[str] | None = None,
+    ):
+        """
+        Register a tile in the launcher window.
+
+        Args:
+            name(str): The name of the tile.
+            icon_path(str): The path to the icon.
+            top_label(str): The top label of the tile.
+            main_label(str): The main label of the tile.
+            description(str): The description of the tile.
+            action_button(callable): The action to be performed when the button is clicked.
+            show_selector(bool): Whether to show a selector or not.
+            selector_items(list[str]): The items to be shown in the selector.
+        """
+
+        tile = LaunchTile(
+            icon_path=icon_path,
+            top_label=top_label,
+            main_label=main_label,
+            description=description,
+            show_selector=show_selector,
+        )
+        tile.setFixedSize(*self.TILE_SIZE)
+        if action_button:
+            tile.action_button.clicked.connect(action_button)
+        if show_selector and selector_items:
+            tile.selector.addItems(selector_items)
+        self.central_widget.layout.addWidget(tile)
+
+        self.tiles[name] = tile
+
     def launch(
         self,
         launch_script: str,
@@ -256,6 +308,12 @@ class LaunchWindow(BECMainWindow):
                 auto_update = kwargs.pop("auto_update", None)
                 return self._launch_auto_update(auto_update)
 
+            if launch_script == "widget":
+                widget = kwargs.pop("widget", None)
+                if widget is None:
+                    raise ValueError("Widget name must be provided.")
+                return self._launch_widget(widget)
+
             launch = getattr(bw_launch, launch_script, None)
             if launch is None:
                 raise ValueError(f"Launch script {launch_script} not found.")
@@ -273,6 +331,7 @@ class LaunchWindow(BECMainWindow):
             else:
                 window = BECMainWindow()
                 window.setCentralWidget(result_widget)
+                window.setWindowTitle(f"BEC - {result_widget.objectName()}")
                 window.show()
             return result_widget
 
@@ -321,11 +380,28 @@ class LaunchWindow(BECMainWindow):
         window.show()
         return window
 
+    def _launch_widget(self, widget: type[BECWidget]) -> QWidget:
+        name = pascal_to_snake(widget.__name__)
+
+        WidgetContainerUtils.raise_for_invalid_name(name)
+
+        window = BECMainWindow()
+
+        widget_instance = widget(root_widget=True, object_name=name)
+        assert isinstance(widget_instance, QWidget)
+        QApplication.processEvents()
+
+        window.setCentralWidget(widget_instance)
+        window.resize(window.minimumSizeHint())
+        window.setWindowTitle(f"BEC - {widget_instance.objectName()}")
+        window.show()
+        return window
+
     def apply_theme(self, theme: str):
         """
         Change the theme of the application.
         """
-        for tile in self.tiles:
+        for tile in self.tiles.values():
             tile.apply_theme(theme)
 
         super().apply_theme(theme)
@@ -334,14 +410,25 @@ class LaunchWindow(BECMainWindow):
         """
         Open the auto update window.
         """
-        if self.tile_auto_update.selector is None:
+        if self.tiles["auto_update"].selector is None:
             auto_update = None
         else:
-            auto_update = self.tile_auto_update.selector.currentText()
+            auto_update = self.tiles["auto_update"].selector.currentText()
             if auto_update == "Default":
                 auto_update = None
         return self.launch("auto_update", auto_update=auto_update)
 
+    def _open_widget(self):
+        """
+        Open a widget from the available widgets.
+        """
+        if self.tiles["widget"].selector is None:
+            return
+        widget = self.tiles["widget"].selector.currentText()
+        if widget not in self.available_widgets:
+            raise ValueError(f"Widget {widget} not found in available widgets.")
+        return self.launch("widget", widget=self.available_widgets[widget])
+
     @SafeSlot(popup_error=True)
     def _open_custom_ui_file(self):
         """

bec_widgets/utils/bec_dispatcher.py

@@ -4,8 +4,9 @@ import collections
 import random
 import string
 from collections.abc import Callable
-from typing import TYPE_CHECKING, Union
+from typing import TYPE_CHECKING, DefaultDict, Hashable, Union
 
+import louie
 import redis
 from bec_lib.client import BECClient
 from bec_lib.logger import bec_logger
@@ -41,15 +42,25 @@ class QtThreadSafeCallback(QObject):
         self.cb_info = cb_info
 
         self.cb = cb
+        self.cb_ref = louie.saferef.safe_ref(cb)
         self.cb_signal.connect(self.cb)
+        self.topics = set()
 
     def __hash__(self):
         # make 2 differents QtThreadSafeCallback to look
         # identical when used as dictionary keys, if the
         # callback is the same
-        return f"{id(self.cb)}{self.cb_info}".__hash__()
+        return f"{id(self.cb_ref)}{self.cb_info}".__hash__()
+
+    def __eq__(self, other):
+        if not isinstance(other, QtThreadSafeCallback):
+            return False
+        return self.cb_ref == other.cb_ref and self.cb_info == other.cb_info
 
     def __call__(self, msg_content, metadata):
+        if self.cb_ref() is None:
+            # callback has been deleted
+            return
         self.cb_signal.emit(msg_content, metadata)
 
 
@@ -96,7 +107,7 @@ class BECDispatcher:
         cls,
         client=None,
         config: str | ServiceConfig | None = None,
-        gui_id: str = None,
+        gui_id: str | None = None,
         *args,
         **kwargs,
     ):
@@ -109,7 +120,9 @@ class BECDispatcher:
         if self._initialized:
             return
 
-        self._slots = collections.defaultdict(set)
+        self._registered_slots: DefaultDict[Hashable, QtThreadSafeCallback] = (
+            collections.defaultdict()
+        )
         self.client = client
 
         if self.client is None:
@@ -162,10 +175,13 @@ class BECDispatcher:
             topics (EndpointInfo | str | list): A topic or list of topics that can typically be acquired via bec_lib.MessageEndpoints
             cb_info (dict | None): A dictionary containing information about the callback. Defaults to None.
         """
-        slot = QtThreadSafeCallback(cb=slot, cb_info=cb_info)
-        self.client.connector.register(topics, cb=slot, **kwargs)
+        qt_slot = QtThreadSafeCallback(cb=slot, cb_info=cb_info)
+        if qt_slot not in self._registered_slots:
+            self._registered_slots[qt_slot] = qt_slot
+        qt_slot = self._registered_slots[qt_slot]
+        self.client.connector.register(topics, cb=qt_slot, **kwargs)
         topics_str, _ = self.client.connector._convert_endpointinfo(topics)
-        self._slots[slot].update(set(topics_str))
+        qt_slot.topics.update(set(topics_str))
 
     def disconnect_slot(self, slot: Callable, topics: Union[str, list]):
         """
@@ -178,16 +194,16 @@ class BECDispatcher:
         # find the right slot to disconnect from ;
         # slot callbacks are wrapped in QtThreadSafeCallback objects,
         # but the slot we receive here is the original callable
-        for connected_slot in self._slots:
+        for connected_slot in self._registered_slots.values():
             if connected_slot.cb == slot:
                 break
         else:
             return
         self.client.connector.unregister(topics, cb=connected_slot)
         topics_str, _ = self.client.connector._convert_endpointinfo(topics)
-        self._slots[connected_slot].difference_update(set(topics_str))
-        if not self._slots[connected_slot]:
-            del self._slots[connected_slot]
+        self._registered_slots[connected_slot].topics.difference_update(set(topics_str))
+        if not self._registered_slots[connected_slot].topics:
+            del self._registered_slots[connected_slot]
 
     def disconnect_topics(self, topics: Union[str, list]):
         """
@@ -198,11 +214,16 @@ class BECDispatcher:
         """
         self.client.connector.unregister(topics)
         topics_str, _ = self.client.connector._convert_endpointinfo(topics)
-        for slot in list(self._slots.keys()):
-            slot_topics = self._slots[slot]
-            slot_topics.difference_update(set(topics_str))
-            if not slot_topics:
-                del self._slots[slot]
+
+        remove_slots = []
+        for connected_slot in self._registered_slots.values():
+            connected_slot.topics.difference_update(set(topics_str))
+
+            if not connected_slot.topics:
+                remove_slots.append(connected_slot)
+
+        for connected_slot in remove_slots:
+            self._registered_slots.pop(connected_slot, None)
 
     def disconnect_all(self, *args, **kwargs):
         """

pyproject.toml

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

tests/unit_tests/test_bec_dispatcher.py

@@ -7,7 +7,7 @@ import pytest
 from bec_lib.messages import ScanMessage
 from bec_lib.serialization import MsgpackSerialization
 
-from bec_widgets.utils.bec_dispatcher import QtRedisConnector
+from bec_widgets.utils.bec_dispatcher import QtRedisConnector, QtThreadSafeCallback
 
 
 @pytest.fixture
@@ -27,6 +27,7 @@ def bec_dispatcher_w_connector(bec_dispatcher, topics_msg_list, send_msg_event):
     connector = QtRedisConnector("localhost:1", redis_class_mock)
     bec_dispatcher.client.connector = connector
     yield bec_dispatcher
+    connector.shutdown()
 
 
 dummy_msg = MsgpackSerialization.dumps(ScanMessage(point_id=0, scan_id="0", data={}))
@@ -62,7 +63,6 @@ def test_dispatcher_disconnect_all(bec_dispatcher_w_connector, qtbot, send_msg_e
 
 @pytest.mark.parametrize("topics_msg_list", [(("topic1", dummy_msg), ("topic2", dummy_msg))])
 def test_dispatcher_disconnect_one(bec_dispatcher_w_connector, qtbot, send_msg_event):
-    # test for BEC issue #276
     bec_dispatcher = bec_dispatcher_w_connector
     cb1 = mock.Mock(spec=[])
     cb2 = mock.Mock(spec=[])
@@ -86,12 +86,21 @@ def test_dispatcher_2_cb_same_topic(bec_dispatcher_w_connector, qtbot, send_msg_
     cb1 = mock.Mock(spec=[])
     cb2 = mock.Mock(spec=[])
 
+    num_slots = len(bec_dispatcher._registered_slots)
+
     bec_dispatcher.connect_slot(cb1, "topic1")
     bec_dispatcher.connect_slot(cb2, "topic1")
+
+    # The redis connector should only subscribe once to the topic
     assert len(bec_dispatcher.client.connector._topics_cb) == 1
-    assert len(bec_dispatcher._slots) == 2
+
+    # The the given topic, two callbacks should be registered
+    assert len(bec_dispatcher.client.connector._topics_cb["topic1"]) == 2
+
+    # The dispatcher should have two slots
+    assert len(bec_dispatcher._registered_slots) == num_slots + 2
     bec_dispatcher.disconnect_slot(cb1, "topic1")
-    assert len(bec_dispatcher._slots) == 1
+    assert len(bec_dispatcher._registered_slots) == num_slots + 1
 
     send_msg_event.set()
     qtbot.wait(10)
@@ -99,9 +108,31 @@ def test_dispatcher_2_cb_same_topic(bec_dispatcher_w_connector, qtbot, send_msg_
     cb2.assert_called_once()
 
 
+@pytest.mark.parametrize("topics_msg_list", [(("topic1", dummy_msg),)])
+def test_dispatcher_2_cb_same_topic_same_slot(bec_dispatcher_w_connector, qtbot, send_msg_event):
+    bec_dispatcher = bec_dispatcher_w_connector
+    cb1 = mock.Mock(spec=[])
+
+    bec_dispatcher.connect_slot(cb1, "topic1")
+    bec_dispatcher.connect_slot(cb1, "topic1")
+    assert len(bec_dispatcher.client.connector._topics_cb) == 1
+    assert (
+        len(list(filter(lambda slot: slot.cb == cb1, bec_dispatcher._registered_slots.values())))
+        == 1
+    )
+
+    send_msg_event.set()
+    qtbot.wait(10)
+    assert cb1.call_count == 1
+    bec_dispatcher.disconnect_slot(cb1, "topic1")
+    assert (
+        len(list(filter(lambda slot: slot.cb == cb1, bec_dispatcher._registered_slots.values())))
+        == 0
+    )
+
+
 @pytest.mark.parametrize("topics_msg_list", [(("topic1", dummy_msg), ("topic2", dummy_msg))])
 def test_dispatcher_2_topic_same_cb(bec_dispatcher_w_connector, qtbot, send_msg_event):
-    # test for BEC issue #276
     bec_dispatcher = bec_dispatcher_w_connector
     cb1 = mock.Mock(spec=[])
 
@@ -114,3 +145,36 @@ def test_dispatcher_2_topic_same_cb(bec_dispatcher_w_connector, qtbot, send_msg_
     send_msg_event.set()
     qtbot.wait(10)
     cb1.assert_called_once()
+
+
+@pytest.mark.parametrize("topics_msg_list", [(("topic1", dummy_msg), ("topic2", dummy_msg))])
+def test_dispatcher_2_topic_same_cb_with_boundmethod(
+    bec_dispatcher_w_connector, qtbot, send_msg_event
+):
+    bec_dispatcher = bec_dispatcher_w_connector
+
+    class MockObject:
+        def mock_slot(self, msg, metadata):
+            pass
+
+    cb1 = MockObject()
+
+    bec_dispatcher.connect_slot(cb1.mock_slot, "topic1", {"metadata": "test"})
+    bec_dispatcher.connect_slot(cb1.mock_slot, "topic1", {"metadata": "test"})
+
+    def _get_slots():
+        return list(
+            filter(
+                lambda slot: slot == QtThreadSafeCallback(cb1.mock_slot, {"metadata": "test"}),
+                bec_dispatcher._registered_slots.values(),
+            )
+        )
+
+    assert len(bec_dispatcher.client.connector._topics_cb) == 1
+    assert len(_get_slots()) == 1
+    bec_dispatcher.disconnect_slot(cb1.mock_slot, "topic1")
+    assert len(bec_dispatcher.client.connector._topics_cb) == 0
+    assert len(_get_slots()) == 0
+
+    send_msg_event.set()
+    qtbot.wait(10)

tests/unit_tests/test_launch_window.py

@@ -64,7 +64,7 @@ def test_launch_window_launch_ui_file_raises_for_qmainwindow(bec_launch_window):
 
 def test_launch_window_launch_default_auto_update(bec_launch_window):
     # Mock the auto update selection
-    bec_launch_window.tile_auto_update.selector.setCurrentText("Default")
+    bec_launch_window.tiles["auto_update"].selector.setCurrentText("Default")
 
     # Call the method to launch the auto update
     res = bec_launch_window._open_auto_update()
@@ -82,11 +82,11 @@ def test_launch_window_launch_plugin_auto_update(bec_launch_window):
     class PluginAutoUpdate(AutoUpdates): ...
 
     bec_launch_window.available_auto_updates = {"PluginAutoUpdate": PluginAutoUpdate}
-    bec_launch_window.tile_auto_update.selector.clear()
-    bec_launch_window.tile_auto_update.selector.addItems(
+    bec_launch_window.tiles["auto_update"].selector.clear()
+    bec_launch_window.tiles["auto_update"].selector.addItems(
         list(bec_launch_window.available_auto_updates.keys()) + ["Default"]
     )
-    bec_launch_window.tile_auto_update.selector.setCurrentText("PluginAutoUpdate")
+    bec_launch_window.tiles["auto_update"].selector.setCurrentText("PluginAutoUpdate")
     res = bec_launch_window._open_auto_update()
     assert isinstance(res, PluginAutoUpdate)
     assert res.windowTitle() == "BEC - PluginAutoUpdate"