bec-widgets 2.0.3__tar.gz → 2.1.0__tar.gz

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/.gitlab-ci.yml

@@ -77,7 +77,7 @@ formatter:
   stage: Formatter
   needs: []
   script:
-    - pip install bec_lib[dev]
+    - pip install -e ./[dev]
     - isort --check --diff --line-length=100 --profile=black --multi-line=3 --trailing-comma ./
     - black --check --diff --color --line-length=100 --skip-magic-trailing-comma ./
   rules:

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/CHANGELOG.md

@@ -1,6 +1,39 @@
 # CHANGELOG
 
 
+## v2.1.0 (2025-05-05)
+
+### Bug Fixes
+
+- Ensure rpc object do not collide with protected names
+  ([`94463af`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/94463afdba11fe2da5958a371ef49572889b8622))
+
+### Chores
+
+- **formatter**: Upgrade to black v25
+  ([`452124b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/452124b528c41db14d1e34ab98db95f6f7230ad6))
+
+### Continuous Integration
+
+- Install dev dependencies for formatter
+  ([`fff4af2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fff4af2489bdea0cf4f6f8db68db59fba411c25e))
+
+### Features
+
+- **SafeSlot**: Slot parameters can be overridden with kwarg; add option to raise
+  ([`9387275`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/93872758517177503b1f868376a6095670131844))
+
+### Refactoring
+
+- **colormap_widget**: Widget is rounded
+  ([`02563b1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/02563b10f3c90bddc069446dfe4137aa5a9727cb))
+
+### Testing
+
+- **Dock**: Add validation for new dock creation with invalid name
+  ([`c16b9dc`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c16b9dce9ce629b794d731cd7f3282a59f8b8c59))
+
+
 ## v2.0.3 (2025-05-02)
 
 ### Bug Fixes

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 2.0.3
+Version: 2.1.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
@@ -12,7 +12,7 @@ Requires-Python: >=3.10
 Requires-Dist: bec-ipython-client<=4.0,>=2.21.4
 Requires-Dist: bec-lib<=4.0,>=3.29
 Requires-Dist: bec-qthemes>=0.7,~=0.7
-Requires-Dist: black~=24.0
+Requires-Dist: black~=25.0
 Requires-Dist: isort>=5.13.2,~=5.13
 Requires-Dist: pydantic~=2.0
 Requires-Dist: pyqtgraph~=0.13
@@ -23,6 +23,7 @@ Requires-Dist: qtpy~=2.4
 Provides-Extra: dev
 Requires-Dist: coverage~=7.0; extra == 'dev'
 Requires-Dist: fakeredis>=2.23.2,~=2.23; extra == 'dev'
+Requires-Dist: isort>=5.13.2,~=5.13; extra == 'dev'
 Requires-Dist: pytest-bec-e2e<=4.0,>=2.21.4; extra == 'dev'
 Requires-Dist: pytest-qt~=4.4; extra == 'dev'
 Requires-Dist: pytest-random-order~=1.1; extra == 'dev'

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/applications/launch_window.py

@@ -235,10 +235,8 @@ class LaunchWindow(BECMainWindow):
                     raise ValueError(
                         f"Name {name} must be unique for dock areas, but already exists: {existing_dock_areas}."
                     )
-                if not WidgetContainerUtils.has_name_valid_chars(name):
-                    raise ValueError(
-                        f"Name {name} contains invalid characters. Only alphanumeric characters, underscores, and dashes are allowed."
-                    )
+                WidgetContainerUtils.raise_for_invalid_name(name)
+
             else:
                 name = "dock_area"
                 name = WidgetContainerUtils.generate_unique_name(name, existing_dock_areas)
@@ -284,6 +282,8 @@ class LaunchWindow(BECMainWindow):
             raise ValueError("UI file must be provided for custom UI file launch.")
         filename = os.path.basename(ui_file).split(".")[0]
 
+        WidgetContainerUtils.raise_for_invalid_name(filename)
+
         tree = ET.parse(ui_file)
         root = tree.getroot()
         # Check if the top-level widget is a QMainWindow

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/utils/bec_plugin_helper.py

@@ -21,7 +21,7 @@ def _submodule_specs(module: ModuleType) -> tuple[ModuleSpec | None, ...]:
 
 
 def _loaded_submodules_from_specs(
-    submodule_specs: tuple[ModuleSpec | None, ...]
+    submodule_specs: tuple[ModuleSpec | None, ...],
 ) -> Generator[ModuleType, None, None]:
     """Load all submodules from the given specs."""
     for submodule in (

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/utils/bec_signal_proxy.py

@@ -1,6 +1,6 @@
-""" This custom class is a thin wrapper around the SignalProxy class to allow signal calls to be blocked.
+"""This custom class is a thin wrapper around the SignalProxy class to allow signal calls to be blocked.
 Unblocking the proxy needs to be done through the slot unblock_proxy. The most likely use case for this class is
-when the callback function is potentially initiating a slower progress, i.e. requesting a data analysis routine to 
+when the callback function is potentially initiating a slower progress, i.e. requesting a data analysis routine to
 analyse data. Requesting a new fit may lead to request piling up and an overall slow done of performance. This proxy
 will allow you to decide by yourself when to unblock and execute the callback again."""
 

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/utils/container_utils.py

@@ -1,11 +1,10 @@
 from __future__ import annotations
 
-import itertools
-from typing import Literal, Type
+from typing import Any, Type
 
 from qtpy.QtWidgets import QWidget
 
-from bec_widgets.cli.rpc.rpc_register import RPCRegister
+from bec_widgets.cli.client_utils import BECGuiClient
 
 
 class WidgetContainerUtils:
@@ -73,3 +72,36 @@ class WidgetContainerUtils:
             return None
         else:
             raise ValueError(f"No widget of class {widget_class} found.")
+
+    @staticmethod
+    def name_is_protected(name: str, container: Any = None) -> bool:
+        """
+        Check if the name is not protected.
+
+        Args:
+            name(str): The name to be checked.
+
+        Returns:
+            bool: True if the name is not protected, False otherwise.
+        """
+        if container is None:
+            container = BECGuiClient
+        gui_client_methods = set(filter(lambda x: not x.startswith("_"), dir(container)))
+        return name in gui_client_methods
+
+    @staticmethod
+    def raise_for_invalid_name(name: str, container: Any = None) -> None:
+        """
+        Check if the name is valid. If not, raise a ValueError.
+
+        Args:
+            name(str): The name to be checked.
+        Raises:
+            ValueError: If the name is not valid.
+        """
+        if not WidgetContainerUtils.has_name_valid_chars(name):
+            raise ValueError(
+                f"Name '{name}' contains invalid characters. Only alphanumeric characters, underscores, and dashes are allowed."
+            )
+        if WidgetContainerUtils.name_is_protected(name, container):
+            raise ValueError(f"Name '{name}' is protected. Please choose another name.")

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/utils/error_popups.py

@@ -99,16 +99,30 @@ def SafeSlot(*slot_args, **slot_kwargs):  # pylint: disable=invalid-name
     'verify_sender' keyword argument can be passed with boolean value if the sender should be verified
     before executing the slot. If True, the slot will only execute if the sender is a QObject. This is
     useful to prevent function calls from already deleted objects.
+    'raise_error' keyword argument can be passed with boolean value if the error should be raised
+    after the error is displayed. This is useful to propagate the error to the caller but should be used
+    with great care to avoid segfaults.
+
+    The keywords above are stored in a container which can be overridden by passing
+    '_override_slot_params' keyword argument with a dictionary containing the keywords to override.
+    This is useful to override the default behavior of the decorator for a specific function call.
+
     """
-    popup_error = bool(slot_kwargs.pop("popup_error", False))
-    verify_sender = bool(slot_kwargs.pop("verify_sender", False))
+    _slot_params = {
+        "popup_error": bool(slot_kwargs.pop("popup_error", False)),
+        "verify_sender": bool(slot_kwargs.pop("verify_sender", False)),
+        "raise_error": bool(slot_kwargs.pop("raise_error", False)),
+    }
 
     def error_managed(method):
         @Slot(*slot_args, **slot_kwargs)
         @functools.wraps(method)
         def wrapper(*args, **kwargs):
+
+            _override_slot_params = kwargs.pop("_override_slot_params", {})
+            _slot_params.update(_override_slot_params)
             try:
-                if not verify_sender or len(args) == 0:
+                if not _slot_params["verify_sender"] or len(args) == 0:
                     return method(*args, **kwargs)
 
                 _instance = args[0]
@@ -126,11 +140,11 @@ def SafeSlot(*slot_args, **slot_kwargs):  # pylint: disable=invalid-name
             except Exception:
                 slot_name = f"{method.__module__}.{method.__qualname__}"
                 error_msg = traceback.format_exc()
-                if popup_error:
-                    ErrorPopupUtility().custom_exception_hook(
-                        *sys.exc_info(), popup_error=popup_error
-                    )
+                if _slot_params["popup_error"]:
+                    ErrorPopupUtility().custom_exception_hook(*sys.exc_info(), popup_error=True)
                 logger.error(f"SafeSlot error in slot '{slot_name}':\n{error_msg}")
+                if _slot_params["raise_error"]:
+                    raise
 
         return wrapper
 

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/utils/linear_region_selector.py

@@ -1,5 +1,5 @@
-""" Module for a thin wrapper (LinearRegionWrapper) around the LinearRegionItem in pyqtgraph.
-The class is mainly designed for usage with the BECWaveform and 1D plots. """
+"""Module for a thin wrapper (LinearRegionWrapper) around the LinearRegionItem in pyqtgraph.
+The class is mainly designed for usage with the BECWaveform and 1D plots."""
 
 from __future__ import annotations
 

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/widgets/containers/dock/dock.py

@@ -303,11 +303,7 @@ class BECDock(BECWidget, Dock):
             shift(Literal["down", "up", "left", "right"]): The direction to shift the widgets if the position is occupied.
         """
         if name is not None:
-            if not WidgetContainerUtils.has_name_valid_chars(name):
-                raise ValueError(
-                    f"Name {name} contains invalid characters. "
-                    f"Only alphanumeric characters and underscores are allowed."
-                )
+            WidgetContainerUtils.raise_for_invalid_name(name, container=self)
 
         if row is None:
             row = self.layout.rowCount()

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/widgets/containers/dock/dock_area.py

@@ -366,11 +366,8 @@ class BECDockArea(BECWidget, QWidget):
                     f"Name {name} must be unique for docks, but already exists in DockArea "
                     f"with name: {self.object_name} and id {self.gui_id}."
                 )
-            if not WidgetContainerUtils.has_name_valid_chars(name):
-                raise ValueError(
-                    f"Name {name} contains invalid characters. "
-                    f"Only alphanumeric characters and underscores are allowed."
-                )
+            WidgetContainerUtils.raise_for_invalid_name(name, container=self)
+
         else:  # Name is not provided
             name = WidgetContainerUtils.generate_unique_name(name="dock", list_of_names=dock_names)
 

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/widgets/control/device_control/positioner_group/positioner_group.py

@@ -1,4 +1,4 @@
-""" Module for a PositionerGroup widget to control a positioner device."""
+"""Module for a PositionerGroup widget to control a positioner device."""
 
 from __future__ import annotations
 

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/widgets/dap/dap_combo_box/dap_combo_box.py

@@ -1,4 +1,4 @@
-""" Module for DapComboBox widget class to select a DAP model from a combobox. """
+"""Module for DapComboBox widget class to select a DAP model from a combobox."""
 
 from bec_lib.logger import bec_logger
 from qtpy.QtCore import Property, Signal, Slot

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/widgets/editors/console/console.py

@@ -1,5 +1,5 @@
 """
-BECConsole is a Qt widget that runs a Bash shell. 
+BECConsole is a Qt widget that runs a Bash shell.
 
 BECConsole VT100 emulation is powered by Pyte,
 (https://github.com/selectel/pyte).
@@ -56,12 +56,12 @@ control_keys_mapping = {
     QtCore.Qt.Key_G: b"\x07",  # Ctrl-G (Bell)
     QtCore.Qt.Key_H: b"\x08",  # Ctrl-H (Backspace)
     QtCore.Qt.Key_I: b"\x09",  # Ctrl-I (Tab)
-    QtCore.Qt.Key_J: b"\x0A",  # Ctrl-J (Line Feed)
-    QtCore.Qt.Key_K: b"\x0B",  # Ctrl-K (Vertical Tab)
-    QtCore.Qt.Key_L: b"\x0C",  # Ctrl-L (Form Feed)
-    QtCore.Qt.Key_M: b"\x0D",  # Ctrl-M (Carriage Return)
-    QtCore.Qt.Key_N: b"\x0E",  # Ctrl-N
-    QtCore.Qt.Key_O: b"\x0F",  # Ctrl-O
+    QtCore.Qt.Key_J: b"\x0a",  # Ctrl-J (Line Feed)
+    QtCore.Qt.Key_K: b"\x0b",  # Ctrl-K (Vertical Tab)
+    QtCore.Qt.Key_L: b"\x0c",  # Ctrl-L (Form Feed)
+    QtCore.Qt.Key_M: b"\x0d",  # Ctrl-M (Carriage Return)
+    QtCore.Qt.Key_N: b"\x0e",  # Ctrl-N
+    QtCore.Qt.Key_O: b"\x0f",  # Ctrl-O
     QtCore.Qt.Key_P: b"\x10",  # Ctrl-P
     QtCore.Qt.Key_Q: b"\x11",  # Ctrl-Q
     QtCore.Qt.Key_R: b"\x12",  # Ctrl-R
@@ -72,10 +72,10 @@ control_keys_mapping = {
     QtCore.Qt.Key_W: b"\x17",  # Ctrl-W
     QtCore.Qt.Key_X: b"\x18",  # Ctrl-X
     QtCore.Qt.Key_Y: b"\x19",  # Ctrl-Y
-    QtCore.Qt.Key_Z: b"\x1A",  # Ctrl-Z
-    QtCore.Qt.Key_Escape: b"\x1B",  # Ctrl-Escape
-    QtCore.Qt.Key_Backslash: b"\x1C",  # Ctrl-\
-    QtCore.Qt.Key_Underscore: b"\x1F",  # Ctrl-_
+    QtCore.Qt.Key_Z: b"\x1a",  # Ctrl-Z
+    QtCore.Qt.Key_Escape: b"\x1b",  # Ctrl-Escape
+    QtCore.Qt.Key_Backslash: b"\x1c",  # Ctrl-\
+    QtCore.Qt.Key_Underscore: b"\x1f",  # Ctrl-_
 }
 
 normal_keys_mapping = {
@@ -89,7 +89,7 @@ normal_keys_mapping = {
     QtCore.Qt.Key_Left: b"\x02",
     QtCore.Qt.Key_Up: b"\x10",
     QtCore.Qt.Key_Right: b"\x06",
-    QtCore.Qt.Key_Down: b"\x0E",
+    QtCore.Qt.Key_Down: b"\x0e",
     QtCore.Qt.Key_PageUp: b"\x49",
     QtCore.Qt.Key_PageDown: b"\x51",
     QtCore.Qt.Key_F1: b"\x1b\x31",

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/widgets/services/bec_status_box/status_item.py

@@ -1,4 +1,4 @@
-""" Module for a StatusItem widget to display status and metrics for a BEC service.
+"""Module for a StatusItem widget to display status and metrics for a BEC service.
 The widget is bound to be used with the BECStatusBox widget."""
 
 import enum

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/widgets/utility/logpanel/_util.py

@@ -1,4 +1,4 @@
-""" Utilities for filtering and formatting in the LogPanel"""
+"""Utilities for filtering and formatting in the LogPanel"""
 
 from __future__ import annotations
 

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/bec_widgets/widgets/utility/visual/colormap_widget/colormap_widget.py

@@ -1,4 +1,5 @@
 from pyqtgraph.widgets.ColorMapButton import ColorMapButton
+from qtpy import QtCore, QtGui
 from qtpy.QtCore import Property, Signal, Slot
 from qtpy.QtWidgets import QSizePolicy, QVBoxLayout, QWidget
 
@@ -6,6 +7,23 @@ from bec_widgets.utils import Colors
 from bec_widgets.utils.bec_widget import BECWidget
 
 
+class RoundedColorMapButton(ColorMapButton):
+    """Thin wrapper around pyqtgraph ColorMapButton to add rounded clipping."""
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.setAttribute(QtCore.Qt.WA_TranslucentBackground)
+
+    def paintEvent(self, evt):
+        painter = QtGui.QPainter(self)
+        painter.setRenderHint(QtGui.QPainter.Antialiasing)
+        path = QtGui.QPainterPath()
+        path.addRoundedRect(self.rect(), 8, 8)
+        painter.setClipPath(path)
+        self.paintColorMap(painter, self.contentsRect())
+        painter.end()
+
+
 class BECColorMapWidget(BECWidget, QWidget):
     colormap_changed_signal = Signal(str)
     ICON_NAME = "palette"
@@ -15,7 +33,7 @@ class BECColorMapWidget(BECWidget, QWidget):
     def __init__(self, parent=None, cmap: str = "plasma", **kwargs):
         super().__init__(parent=parent, **kwargs)
         # Create the ColorMapButton
-        self.button = ColorMapButton()
+        self.button = RoundedColorMapButton()
 
         # Set the size policy and minimum width
         size_policy = QSizePolicy(QSizePolicy.Preferred, QSizePolicy.Fixed)

{bec_widgets-2.0.3 → bec_widgets-2.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "2.0.3"
+version = "2.1.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [
@@ -16,7 +16,7 @@ dependencies = [
     "bec_ipython_client>=2.21.4, <=4.0", # needed for jupyter console
     "bec_lib>=3.29, <=4.0",
     "bec_qthemes~=0.7, >=0.7",
-    "black~=24.0",                       # needed for bw-generate-cli
+    "black~=25.0",                       # needed for bw-generate-cli
     "isort~=5.13, >=5.13.2",             # needed for bw-generate-cli
     "pydantic~=2.0",
     "pyqtgraph~=0.13",
@@ -31,6 +31,7 @@ dependencies = [
 dev = [
     "coverage~=7.0",
     "fakeredis~=2.23, >=2.23.2",
+    "isort~=5.13, >=5.13.2",
     "pytest-bec-e2e>=2.21.4, <=4.0",
     "pytest-qt~=4.4",
     "pytest-random-order~=1.1",