bec-widgets 0.71.1__tar.gz → 0.72.1__tar.gz

{bec_widgets-0.71.1 → bec_widgets-0.72.1}/CHANGELOG.md

@@ -1,5 +1,25 @@
 # CHANGELOG
 
+## v0.72.1 (2024-06-24)
+
+### Fix
+
+* fix: renamed spiral progress bar to ring progress bar; closes #235 ([`e5c0087`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e5c0087c9aed831edbe1c172746325a772a3bafa))
+
+### Test
+
+* test: bugfix to prohibit leackage of mock ([`4348ed1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4348ed1bb2182da6bdecaf372d6db85279e60af8))
+
+## v0.72.0 (2024-06-24)
+
+### Feature
+
+* feat(connector): added threadpool wrapper ([`4ca1efe`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4ca1efeeb8955604069f7b98374c7f82e1a8da67))
+
+### Unknown
+
+* tests(status_box_test): temporary disabled tests for status_box due to high rate of failures ([`aa7ce2e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/aa7ce2ea27bb9564d4f5104bbff30725b8656453))
+
 ## v0.71.1 (2024-06-23)
 
 ### Fix
@@ -133,21 +153,3 @@ in their parent process ([`ce37416`](https://gitlab.psi.ch/bec/bec_widgets/-/com
 ### Feature
 
 * feat(rpc): discover widgets automatically ([`ef25f56`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ef25f5638032f931ceb292540ada618508bb2aed))
-
-## v0.65.2 (2024-06-20)
-
-### Fix
-
-* fix(pyqt): webengine must be imported before qcoreapplication ([`cbbd23a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cbbd23aa33095141e4c265719d176c4aa8c25996))
-
-## v0.65.1 (2024-06-20)
-
-### Fix
-
-* fix: prevent segfault by closing the QCoreApplication, if any ([`fa344a5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fa344a5799b07a2d8ace63cc7010b69bc4ed6f1d))
-
-## v0.65.0 (2024-06-20)
-
-### Test
-
-* test(device_input): tests added ([`1a0a98a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1a0a98a45367db414bed813bbd346b3e1ae8d550))

{bec_widgets-0.71.1 → bec_widgets-0.72.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.71.1
+Version: 0.72.1
 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.71.1 → bec_widgets-0.72.1}/bec_widgets/cli/client.py

@@ -17,8 +17,8 @@ class Widgets(str, enum.Enum):
     BECDock = "BECDock"
     BECDockArea = "BECDockArea"
     BECFigure = "BECFigure"
+    RingProgressBar = "RingProgressBar"
     ScanControl = "ScanControl"
-    SpiralProgressBar = "SpiralProgressBar"
     TextBox = "TextBox"
     VSCodeEditor = "VSCodeEditor"
     WebsiteWidget = "WebsiteWidget"
@@ -1824,25 +1824,7 @@ class Ring(RPCBase):
         """
 
 
-class ScanControl(RPCBase):
-    @property
-    @rpc_call
-    def config_dict(self) -> "dict":
-        """
-        Get the configuration of the widget.
-
-        Returns:
-            dict: The configuration of the widget.
-        """
-
-    @rpc_call
-    def get_all_rpc(self) -> "dict":
-        """
-        Get all registered RPC objects.
-        """
-
-
-class SpiralProgressBar(RPCBase):
+class RingProgressBar(RPCBase):
     @rpc_call
     def get_all_rpc(self) -> "dict":
         """
@@ -1874,7 +1856,7 @@ class SpiralProgressBar(RPCBase):
         """
 
     @rpc_call
-    def update_config(self, config: "SpiralProgressBarConfig | dict"):
+    def update_config(self, config: "RingProgressBarConfig | dict"):
         """
         Update the configuration of the widget.
 
@@ -2021,6 +2003,24 @@ class SpiralProgressBar(RPCBase):
         """
 
 
+class ScanControl(RPCBase):
+    @property
+    @rpc_call
+    def config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+
+        Returns:
+            dict: The configuration of the widget.
+        """
+
+    @rpc_call
+    def get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
+
 class StopButton(RPCBase):
     @property
     @rpc_call

{bec_widgets-0.71.1 → bec_widgets-0.72.1}/bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -116,7 +116,7 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         self.d2 = self.dock.add_dock(name="dock_2", position="bottom")
         self.fig2 = self.d2.add_widget("BECFigure", row=0, col=0)
         self.fig2.plot(x_name="samx", y_name="bpm4i")
-        self.bar = self.d2.add_widget("SpiralProgressBar", row=0, col=1)
+        self.bar = self.d2.add_widget("RingProgressBar", row=0, col=1)
         self.bar.set_diameter(200)
 
         self.dock.save_state()

{bec_widgets-0.71.1 → bec_widgets-0.72.1}/bec_widgets/utils/bec_connector.py

@@ -2,10 +2,11 @@
 from __future__ import annotations
 
 import time
-from typing import Optional, Type
+from typing import Optional
 
-from bec_lib.utils.import_utils import lazy_import, lazy_import_from
+from bec_lib.utils.import_utils import lazy_import_from
 from pydantic import BaseModel, Field, field_validator
+from qtpy.QtCore import QObject, QRunnable, QThreadPool, Signal
 from qtpy.QtCore import Slot as pyqtSlot
 
 from bec_widgets.cli.rpc_register import RPCRegister
@@ -33,6 +34,31 @@ class ConnectionConfig(BaseModel):
         return v
 
 
+class WorkerSignals(QObject):
+    progress = Signal(dict)
+    completed = Signal()
+
+
+class Worker(QRunnable):
+    """
+    Worker class to run a function in a separate thread.
+    """
+
+    def __init__(self, func, *args, **kwargs):
+        super().__init__()
+        self.signals = WorkerSignals()
+        self.func = func
+        self.args = args
+        self.kwargs = kwargs
+
+    def run(self):
+        """
+        Run the specified function in the thread.
+        """
+        self.func(*self.args, **self.kwargs)
+        self.signals.completed.emit()
+
+
 class BECConnector:
     """Connection mixin class for all BEC widgets, to handle BEC client and device manager"""
 
@@ -63,6 +89,43 @@ class BECConnector:
         self.rpc_register = RPCRegister()
         self.rpc_register.add_rpc(self)
 
+        self._thread_pool = QThreadPool.globalInstance()
+
+    def submit_task(self, fn, *args, on_complete: pyqtSlot = None, **kwargs) -> Worker:
+        """
+        Submit a task to run in a separate thread. The task will run the specified
+        function with the provided arguments and emit the completed signal when done.
+
+        Use this method if you want to wait for a task to complete without blocking the
+        main thread.
+
+        Args:
+            fn: Function to run in a separate thread.
+            *args: Arguments for the function.
+            on_complete: Slot to run when the task is complete.
+            **kwargs: Keyword arguments for the function.
+
+        Returns:
+            worker: The worker object that will run the task.
+
+        Examples:
+            >>> def my_function(a, b):
+            >>>     print(a + b)
+            >>> self.submit_task(my_function, 1, 2)
+
+            >>> def my_function(a, b):
+            >>>     print(a + b)
+            >>> def on_complete():
+            >>>     print("Task complete")
+            >>> self.submit_task(my_function, 1, 2, on_complete=on_complete)
+
+        """
+        worker = Worker(fn, *args, **kwargs)
+        if on_complete:
+            worker.signals.completed.connect(on_complete)
+        self._thread_pool.start(worker)
+        return worker
+
     def get_all_rpc(self) -> dict:
         """Get all registered RPC objects."""
         all_connections = self.rpc_register.list_all_connections()

bec_widgets-0.72.1/bec_widgets/widgets/__init__.py

@@ -0,0 +1 @@
+

{bec_widgets-0.71.1 → bec_widgets-0.72.1}/bec_widgets/widgets/bec_status_box/bec_status_box.py

@@ -11,7 +11,7 @@ import qdarktheme
 from bec_lib.utils.import_utils import lazy_import_from
 from pydantic import BaseModel, Field, field_validator
 from qtpy.QtCore import QObject, QTimer, Signal, Slot
-from qtpy.QtWidgets import QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget
+from qtpy.QtWidgets import QTreeWidget, QTreeWidgetItem
 
 from bec_widgets.utils.bec_connector import BECConnector, ConnectionConfig
 from bec_widgets.widgets.bec_status_box.status_item import StatusItem
@@ -108,6 +108,7 @@ class BECStatusBox(BECConnector, QTreeWidget):
         service_name: str = "BEC Server",
         client: BECClient = None,
         config: BECStatusBoxConfig | dict = None,
+        bec_service_status_mixin: BECServiceStatusMixin = None,
         gui_id: str = None,
     ):
         if config is None:
@@ -124,7 +125,10 @@ class BECStatusBox(BECConnector, QTreeWidget):
         self.bec_service_info_container = {}
         self.tree_items = {}
         self.tree_top_item = None
-        self.bec_service_status = BECServiceStatusMixin(client=self.client)
+
+        if not bec_service_status_mixin:
+            bec_service_status_mixin = BECServiceStatusMixin(client=self.client)
+        self.bec_service_status = bec_service_status_mixin
 
         self.init_ui()
         self.bec_service_status.services_update.connect(self.update_service_status)

bec_widgets-0.72.1/bec_widgets/widgets/ring_progress_bar/__init__.py

@@ -0,0 +1 @@
+from .ring_progress_bar import RingProgressBar

{bec_widgets-0.71.1/bec_widgets/widgets/spiral_progress_bar → bec_widgets-0.72.1/bec_widgets/widgets/ring_progress_bar}/ring.py

@@ -10,12 +10,13 @@ from qtpy import QtGui
 from bec_widgets.utils import BECConnector, ConnectionConfig
 
 
-class RingConnections(BaseModel):
+class ProgressbarConnections(BaseModel):
     slot: Literal["on_scan_progress", "on_device_readback"] = None
     endpoint: EndpointInfo | str = None
     model_config: dict = {"validate_assignment": True}
 
     @field_validator("endpoint")
+    @classmethod
     def validate_endpoint(cls, v, values):
         slot = values.data["slot"]
         v = v.endpoint if isinstance(v, EndpointInfo) else v
@@ -36,7 +37,7 @@ class RingConnections(BaseModel):
         return v
 
 
-class RingConfig(ConnectionConfig):
+class ProgressbarConfig(ConnectionConfig):
     value: int | float | None = Field(0, description="Value for the progress bars.")
     direction: int | None = Field(
         -1, description="Direction of the progress bars. -1 for clockwise, 1 for counter-clockwise."
@@ -62,8 +63,17 @@ class RingConfig(ConnectionConfig):
     update_behaviour: Literal["manual", "auto"] | None = Field(
         "auto", description="Update behaviour for the progress bars."
     )
-    connections: RingConnections | None = Field(
-        default_factory=RingConnections, description="Connections for the progress bars."
+    connections: ProgressbarConnections | None = Field(
+        default_factory=ProgressbarConnections, description="Connections for the progress bars."
+    )
+
+
+class RingConfig(ProgressbarConfig):
+    index: int | None = Field(0, description="Index of the progress bar. 0 is outer ring.")
+    start_position: int | None = Field(
+        90,
+        description="Start position for the progress bars in degrees. Default is 90 degrees - corespons to "
+        "the top of the ring.",
     )
 
 
@@ -230,7 +240,7 @@ class Ring(BECConnector):
             self.bec_dispatcher.disconnect_slot(
                 self.config.connections.slot, self.config.connections.endpoint
             )
-            self.config.connections = RingConnections(slot=slot, endpoint=endpoint)
+            self.config.connections = ProgressbarConnections(slot=slot, endpoint=endpoint)
             self.bec_dispatcher.connect_slot(getattr(self, slot), endpoint)
 
     def reset_connection(self):
@@ -240,7 +250,7 @@ class Ring(BECConnector):
         self.bec_dispatcher.disconnect_slot(
             self.config.connections.slot, self.config.connections.endpoint
         )
-        self.config.connections = RingConnections()
+        self.config.connections = ProgressbarConnections()
 
     def on_scan_progress(self, msg, meta):
         """

bec_widgets-0.71.1/bec_widgets/widgets/spiral_progress_bar/spiral_progress_bar.py → bec_widgets-0.72.1/bec_widgets/widgets/ring_progress_bar/ring_progress_bar.py

@@ -11,10 +11,10 @@ from qtpy.QtCore import QSize, Slot
 from qtpy.QtWidgets import QSizePolicy, QWidget
 
 from bec_widgets.utils import BECConnector, Colors, ConnectionConfig, EntryValidator
-from bec_widgets.widgets.spiral_progress_bar.ring import Ring, RingConfig
+from bec_widgets.widgets.ring_progress_bar.ring import Ring, RingConfig
 
 
-class SpiralProgressBarConfig(ConnectionConfig):
+class RingProgressBarConfig(ConnectionConfig):
     color_map: Optional[str] = Field(
         "magma", description="Color scheme for the progress bars.", validate_default=True
     )
@@ -32,6 +32,7 @@ class SpiralProgressBarConfig(ConnectionConfig):
     rings: list[RingConfig] | None = Field([], description="List of ring configurations.")
 
     @field_validator("num_bars")
+    @classmethod
     def validate_num_bars(cls, v, values):
         min_number_of_bars = values.data.get("min_number_of_bars", None)
         max_number_of_bars = values.data.get("max_number_of_bars", None)
@@ -43,6 +44,7 @@ class SpiralProgressBarConfig(ConnectionConfig):
             return v
 
     @field_validator("rings")
+    @classmethod
     def validate_rings(cls, v, values):
         if v is not None and v is not []:
             num_bars = values.data.get("num_bars", None)
@@ -64,7 +66,7 @@ class SpiralProgressBarConfig(ConnectionConfig):
     _validate_colormap = field_validator("color_map")(Colors.validate_color_map)
 
 
-class SpiralProgressBar(BECConnector, QWidget):
+class RingProgressBar(BECConnector, QWidget):
     USER_ACCESS = [
         "get_all_rpc",
         "rpc_id",
@@ -89,17 +91,17 @@ class SpiralProgressBar(BECConnector, QWidget):
     def __init__(
         self,
         parent=None,
-        config: SpiralProgressBarConfig | dict | None = None,
+        config: RingProgressBarConfig | dict | None = None,
         client=None,
         gui_id: str | None = None,
         num_bars: int | None = None,
     ):
         if config is None:
-            config = SpiralProgressBarConfig(widget_class=self.__class__.__name__)
+            config = RingProgressBarConfig(widget_class=self.__class__.__name__)
             self.config = config
         else:
             if isinstance(config, dict):
-                config = SpiralProgressBarConfig(**config, widget_class=self.__class__.__name__)
+                config = RingProgressBarConfig(**config, widget_class=self.__class__.__name__)
             self.config = config
         super().__init__(client=client, config=config, gui_id=gui_id)
         QWidget.__init__(self, parent=None)
@@ -129,7 +131,7 @@ class SpiralProgressBar(BECConnector, QWidget):
     def rings(self, value):
         self._rings = value
 
-    def update_config(self, config: SpiralProgressBarConfig | dict):
+    def update_config(self, config: RingProgressBarConfig | dict):
         """
         Update the configuration of the widget.
 
@@ -137,7 +139,7 @@ class SpiralProgressBar(BECConnector, QWidget):
             config(SpiralProgressBarConfig|dict): Configuration to update.
         """
         if isinstance(config, dict):
-            config = SpiralProgressBarConfig(**config, widget_class=self.__class__.__name__)
+            config = RingProgressBarConfig(**config, widget_class=self.__class__.__name__)
         self.config = config
         self.clear_all()
 

{bec_widgets-0.71.1 → bec_widgets-0.72.1}/docs/user/getting_started/quick_start.md

@@ -97,11 +97,11 @@ Note, we chain commands here which is possible since the `add_dock` and `add_wid
 cam_widget.set_title("Camera Image Eiger")
 cam_widget.set_vrange(vmin=0, vmax=100)
 ```
-As a final step, we can now add also a SpiralProgressBar to a new dock, and perform a grid_scan with the motors *samx* and *samy*.
+As a final step, we can now add also a RingProgressBar to a new dock, and perform a grid_scan with the motors *samx* and *samy*.
 As you see in the example below, all docks are arranged below each other. This is the default behavior of the `add_dock` method. However, the docks can be freely arranged by drag and drop as desired by the user. We invite you to explore this by yourself following the example in the video, and build your custom GUI with BEC Widgets.
 
 ```python
-prog_bar = gui.add_dock(name="prog_dock").add_widget('SpiralProgressBar')
+prog_bar = gui.add_dock(name="prog_dock").add_widget('RingProgressBar')
 prog_bar.set_line_widths(15)
 scans.grid_scan(dev.samy, -2, 2, 10, dev.samx, -5, 5, 10, exp_time=0.1, relative=False)
 ```

bec_widgets-0.71.1/docs/user/widgets/spiral_progress_bar.md → bec_widgets-0.72.1/docs/user/widgets/ring_progress_bar.md

@@ -1,9 +1,9 @@
 (user.widgets.spiral_progress_bar)=
-# [Spiral Progress Bar](/api_reference/_autosummary/bec_widgets.cli.client.SpiralProgressBar)
+# [Ring Progress Bar](/api_reference/_autosummary/bec_widgets.cli.client.RingProgressBar)
 
 **Purpose:**
 
-The Spiral Progress Bar widget is a circular progress bar that can be used to visualize the progress of a task. The
+The ring Progress Bar widget is a circular progress bar that can be used to visualize the progress of a task. The
 widget is designed to be used in applications where the progress of a task is represented as a percentage. The Spiral
 Progress Bar widget is a part of the BEC Widgets library and can be controlled directly using its API, or hooked up to
 the progress of a device readback or scan.
@@ -15,22 +15,22 @@ the progress of a device readback or scan.
 - multiple progress rings to show different tasks in parallel.
 
 **Example of Use:**
-![SpiralProgressBar](./progress_bar.gif)
+![RingProgressBar](./progress_bar.gif)
 
 **Code example:**
 
-The following code snipped demonstrates how to create a `SpiralProgressBar` using BEC Widgets within BEC.
+The following code snipped demonstrates how to create a `RingProgressBar` using BEC Widgets within BEC.
 ```python
-# adds a new dock with a spiral progress bar
-progress = gui.add_dock().add_widget("SpiralProgressBar")
+# adds a new dock with a ring progress bar
+progress = gui.add_dock().add_widget("RingProgressBar")
 # customize the size of the ring
 progress.set_line_width(20)
 ```
 
-By default, the Spiral Progress Bar widget will display a single ring. To add more rings, use the add_ring method:
+By default, the Ring Progress Bar widget will display a single ring. To add more rings, use the add_ring method:
 
 ```python
-# adds a new dock with a spiral progress bar
+# adds a new dock with a ring progress bar
 progress.add_ring()
 ```
 
@@ -42,7 +42,7 @@ progress.rings[0].set_line_width(20)  # set the width of the first ring
 progress.rings[1].set_line_width(10)  # set the width of the second ring
 ```
 
-By default, the `SpiralProgressBar` widget is set with `progress.enable_auto_update(True)`, which will automatically
+By default, the `RingProgressBar` widget is set with `progress.enable_auto_update(True)`, which will automatically
 update the bars in the widget. To manually set updates for each progress bar, use the set_update method. Note that
 manually updating a ring will disable the automatic update for the whole widget:
 

{bec_widgets-0.71.1 → bec_widgets-0.72.1}/docs/user/widgets/widgets.md

@@ -9,7 +9,7 @@ hidden: false
 ---
 
 bec_figure/
-spiral_progress_bar/
+ring_progress_bar/
 website/
 buttons/
 text_box/

{bec_widgets-0.71.1 → bec_widgets-0.72.1}/pyproject.toml

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

{bec_widgets-0.71.1 → bec_widgets-0.72.1}/tests/end-2-end/test_bec_dock_rpc_e2e.py

@@ -151,13 +151,13 @@ def test_dock_manipulations_e2e(rpc_server_dock):
     assert len(dock.temp_areas) == 0
 
 
-def test_spiral_bar(rpc_server_dock):
+def test_ring_bar(rpc_server_dock):
     dock = BECDockArea(rpc_server_dock)
 
     d0 = dock.add_dock(name="dock_0")
 
-    bar = d0.add_widget("SpiralProgressBar")
-    assert bar.__class__.__name__ == "SpiralProgressBar"
+    bar = d0.add_widget("RingProgressBar")
+    assert bar.__class__.__name__ == "RingProgressBar"
 
     bar.set_number_of_bars(5)
     bar.set_colors_from_map("viridis")
@@ -173,12 +173,12 @@ def test_spiral_bar(rpc_server_dock):
     assert bar_colors == expected_colors
 
 
-def test_spiral_bar_scan_update(bec_client_lib, rpc_server_dock):
+def test_ring_bar_scan_update(bec_client_lib, rpc_server_dock):
     dock = BECDockArea(rpc_server_dock)
 
     d0 = dock.add_dock("dock_0")
 
-    bar = d0.add_widget("SpiralProgressBar")
+    bar = d0.add_widget("RingProgressBar")
 
     client = bec_client_lib
     dev = client.device_manager.devices

{bec_widgets-0.71.1 → bec_widgets-0.72.1}/tests/unit_tests/test_bec_connector.py

@@ -1,5 +1,9 @@
 # pylint: disable = no-name-in-module,missing-class-docstring, missing-module-docstring
+import time
+
 import pytest
+from qtpy.QtCore import Slot
+from qtpy.QtWidgets import QApplication
 
 from bec_widgets.utils import BECConnector, ConnectionConfig
 
@@ -55,3 +59,22 @@ def test_bec_connector_update_client(bec_connector, mocked_client):
 def test_bec_connector_get_config(bec_connector):
     assert bec_connector.get_config(dict_output=False) == bec_connector.config
     assert bec_connector.get_config() == bec_connector.config.model_dump()
+
+
+def test_bec_connector_submit_task(bec_connector):
+    def test_func():
+        time.sleep(2)
+        print("done")
+
+    completed = False
+
+    @Slot()
+    def complete_func():
+        nonlocal completed
+        completed = True
+
+    bec_connector.submit_task(test_func, on_complete=complete_func)
+    assert not completed
+    while not completed:
+        QApplication.processEvents()
+        time.sleep(0.1)