bec-widgets 2.1.1__tar.gz → 2.1.3__tar.gz

{bec_widgets-2.1.1 → bec_widgets-2.1.3}/.gitlab-ci.yml

@@ -230,7 +230,7 @@ end-2-end-conda:
     - pip install -e ./ophyd_devices
 
     - pip install -e .[dev,pyside6]
-    - pytest -v --files-path ./ --start-servers --flush-redis --random-order  ./tests/end-2-end
+    - pytest -v --files-path ./ --start-servers --random-order  ./tests/end-2-end
 
   artifacts:
     when: on_failure

{bec_widgets-2.1.1 → bec_widgets-2.1.3}/CHANGELOG.md

@@ -1,6 +1,36 @@
 # CHANGELOG
 
 
+## 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
+
+- **waveform**: Ignore callbacks for on_async_readback from QtSender objects that are already
+  destroyed; closes #497
+  ([`64a4824`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/64a48240546846fdf4541c2adf3a0a5a0829f948))
+
+### Build System
+
+- Remove flush-redis from ci job
+  ([`a6c479e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a6c479e42ea2a47c45e5a323bb3072bab503ecf1))
+
+### Refactoring
+
+- **bec-progressbar**: Add private method for bec_progressbar, udate client file
+  ([`37f0024`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/37f002427ad5da01164ae3b0f4983695fe61c243))
+
+- **bec-status-box**: Add get_server_state user_access method to BECStatusBox
+  ([`1619446`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1619446ec9839cfa1c666a3790a0c2abc449c4a8))
+
+
 ## v2.1.1 (2025-05-06)
 
 ### Bug Fixes

{bec_widgets-2.1.1 → bec_widgets-2.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 2.1.1
+Version: 2.1.3
 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-2.1.1 → bec_widgets-2.1.3}/bec_widgets/cli/client.py

@@ -470,6 +470,12 @@ class BECProgressBar(RPCBase):
         >>> progressbar.label_template = "$value / $percentage %"
         """
 
+    @rpc_call
+    def _get_label(self) -> str:
+        """
+        Return the label text. mostly used for testing rpc.
+        """
+
 
 class BECQueue(RPCBase):
     """Widget to display the BEC queue."""
@@ -484,6 +490,12 @@ class BECQueue(RPCBase):
 class BECStatusBox(RPCBase):
     """An autonomous widget to display the status of BEC services."""
 
+    @rpc_call
+    def get_server_state(self) -> "str":
+        """
+        Get the state ("RUNNING", "BUSY", "IDLE", "ERROR") of the BEC server
+        """
+
     @rpc_call
     def remove(self):
         """

{bec_widgets-2.1.1 → bec_widgets-2.1.3}/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
@@ -25,21 +26,41 @@ if TYPE_CHECKING:  # pragma: no cover
 
 
 class QtThreadSafeCallback(QObject):
+    """QtThreadSafeCallback is a wrapper around a callback function to make it thread-safe for Qt."""
+
     cb_signal = pyqtSignal(dict, dict)
 
-    def __init__(self, cb):
+    def __init__(self, cb: Callable, cb_info: dict | None = None):
+        """
+        Initialize the QtThreadSafeCallback.
+
+        Args:
+            cb (Callable): The callback function to be wrapped.
+            cb_info (dict, optional): Additional information about the callback. Defaults to None.
+        """
         super().__init__()
+        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 id(self.cb)
+        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)
 
 
@@ -86,7 +107,7 @@ class BECDispatcher:
         cls,
         client=None,
         config: str | ServiceConfig | None = None,
-        gui_id: str = None,
+        gui_id: str | None = None,
         *args,
         **kwargs,
     ):
@@ -99,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:
@@ -141,6 +164,7 @@ class BECDispatcher:
         self,
         slot: Callable,
         topics: Union[EndpointInfo, str, list[Union[EndpointInfo, str]]],
+        cb_info: dict | None = None,
         **kwargs,
     ) -> None:
         """Connect widget's qt slot, so that it is called on new pub/sub topic message.
@@ -149,11 +173,15 @@ class BECDispatcher:
             slot (Callable): A slot method/function that accepts two inputs: content and metadata of
                 the corresponding pub/sub message
             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(slot)
-        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]):
         """
@@ -166,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]):
         """
@@ -186,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):
         """

{bec_widgets-2.1.1 → bec_widgets-2.1.3}/bec_widgets/widgets/plots/waveform/waveform.py

@@ -1182,10 +1182,11 @@ class Waveform(PlotBase):
             self.on_async_readback,
             MessageEndpoints.device_async_readback(self.scan_id, name),
             from_start=True,
+            cb_info={"scan_id": self.scan_id},
         )
         logger.info(f"Setup async curve {name}")
 
-    @SafeSlot(dict, dict)
+    @SafeSlot(dict, dict, verify_sender=True)
     def on_async_readback(self, msg, metadata):
         """
         Get async data readback. This code needs to be fast, therefor we try
@@ -1204,6 +1205,14 @@ class Waveform(PlotBase):
             msg(dict): Message with the async data.
             metadata(dict): Metadata of the message.
         """
+        sender = self.sender()
+        if not hasattr(sender, "cb_info"):
+            logger.info(f"Sender {sender} has no cb_info.")
+            return
+        scan_id = sender.cb_info.get("scan_id", None)
+        if scan_id != self.scan_id:
+            logger.info("Scan ID mismatch, ignoring async readback.")
+
         instruction = metadata.get("async_update", {}).get("type")
         if instruction not in ["add", "add_slice", "replace"]:
             logger.warning(f"Invalid async update instruction: {instruction}")
@@ -1212,6 +1221,7 @@ class Waveform(PlotBase):
         plot_mode = self.x_axis_mode["name"]
         for curve in self._async_curves:
             x_data = None  # Reset x_data
+            y_data = None  # Reset y_data
             # Get the curve data
             async_data = msg["signals"].get(curve.config.signal.entry, None)
             if async_data is None:

{bec_widgets-2.1.1 → bec_widgets-2.1.3}/bec_widgets/widgets/progress/bec_progressbar/bec_progressbar.py

@@ -21,6 +21,7 @@ class BECProgressBar(BECWidget, QWidget):
         "set_minimum",
         "label_template",
         "label_template.setter",
+        "_get_label",
     ]
     ICON_NAME = "page_control"
 
@@ -235,6 +236,10 @@ class BECProgressBar(BECWidget, QWidget):
             (value - self._user_minimum) / (self._user_maximum - self._user_minimum) * self._maximum
         )
 
+    def _get_label(self) -> str:
+        """Return the label text. mostly used for testing rpc."""
+        return self.center_label.text()
+
 
 if __name__ == "__main__":  # pragma: no cover
     app = QApplication(sys.argv)

{bec_widgets-2.1.1 → bec_widgets-2.1.3}/bec_widgets/widgets/services/bec_status_box/bec_status_box.py

@@ -76,6 +76,7 @@ class BECStatusBox(BECWidget, CompactPopupWidget):
 
     PLUGIN = True
     CORE_SERVICES = ["DeviceServer", "ScanServer", "SciHub", "ScanBundler", "FileWriterManager"]
+    USER_ACCESS = ["get_server_state", "remove"]
 
     service_update = Signal(BECServiceInfoContainer)
     bec_core_state = Signal(str)
@@ -134,6 +135,10 @@ class BECStatusBox(BECWidget, CompactPopupWidget):
             "QTreeWidget::item:selected {}"
         )
 
+    def get_server_state(self) -> str:
+        """Get the state ("RUNNING", "BUSY", "IDLE", "ERROR") of the BEC server"""
+        return self.status_container[self.box_name]["info"].status
+
     def _create_status_widget(
         self, service_name: str, status=BECStatus, info: dict = None, metrics: dict = None
     ) -> StatusItem:

{bec_widgets-2.1.1 → bec_widgets-2.1.3}/pyproject.toml

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