bec-widgets 0.106.0__tar.gz → 0.108.0__tar.gz

{bec_widgets-0.106.0 → bec_widgets-0.108.0}/CHANGELOG.md

@@ -1,5 +1,35 @@
 # CHANGELOG
 
+## v0.108.0 (2024-09-06)
+
+### Documentation
+
+* docs(progressbar): added docs ([`7d07cea`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7d07cea946f9c884477b01bebfb60b332ff09e0a))
+
+### Feature
+
+* feat(progressbar): added bec progressbar ([`f6d1d0b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f6d1d0bbe3ba30a3b7291cd36a1f7f8e6bd5b895))
+
+* feat(generate_cli): added support for property and qproperty setter ([`a52182d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a52182dca978833bfc3fad755c596d3a2ef45c42))
+
+## v0.107.0 (2024-09-06)
+
+### Documentation
+
+* docs: extend waveform docs ([`e6976dc`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e6976dc15105209852090a00a97b7cda723142e9))
+
+### Feature
+
+* feat: add roi select for dap, allow automatic clear curves on plot request ([`7bdca84`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7bdca8431496fe6562d2c28f5a6af869d1a2e654))
+
+### Refactor
+
+* refactor: change style to bec_accent_colors ([`bd126dd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/bd126dddbbec3e6c448cce263433d328d577c5c0))
+
+### Test
+
+* test: add tests, including extension to end-2-end test ([`b1aff6d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b1aff6d791ff847eb2f628e66ccaa4672fdeea08))
+
 ## v0.106.0 (2024-09-05)
 
 ### Feature
@@ -131,29 +161,3 @@
 * fix(positioner_box): fixed positioner box dialog; added test; closes #332 ([`0bf1cf9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0bf1cf9b8ab2f9171d5ff63d4e3672eb93e9a5fa))
 
 ## v0.99.14 (2024-08-30)
-
-### Fix
-
-* fix(color_button): signal and slot added for selecting color and for emitting color after change ([`99a98de`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/99a98de8a3b7a83d71e4b567e865ac6f5c62a754))
-
-* fix(color_button): inheritance changed to QWidget ([`3c0e501`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3c0e501c56227d4d98ff0ac2186ff5065bff8d7a))
-
-## v0.99.13 (2024-08-30)
-
-### Documentation
-
-* docs: minor updates to the widget tutorial ([`ec9c8f2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ec9c8f29633364c45ebd998a5411d428c1ce488d))
-
-* docs(widget tutorial): step by step guide added ([`b32ced8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b32ced85fff628a9e1303a781630cdae3865238e))
-
-### Fix
-
-* fix(dark mode button): fixed dark mode button state for external updates, including auto ([`a3110d9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a3110d98147295dcb1f9353f9aaf5461cba9232a))
-
-## v0.99.12 (2024-08-29)
-
-### Fix
-
-* fix(toolbar): widget action added ([`2efd487`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2efd48736cbe04e84533f7933c552ea8274e2162))
-
-* fix(reset_button): reset button added ([`6ed1efc`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6ed1efc6af193908f70aa37fb73157d2ca6a62f4))

{bec_widgets-0.106.0 → bec_widgets-0.108.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.106.0
+Version: 0.108.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

{bec_widgets-0.106.0 → bec_widgets-0.108.0}/bec_widgets/cli/client.py

@@ -19,6 +19,7 @@ class Widgets(str, enum.Enum):
     BECFigure = "BECFigure"
     BECImageWidget = "BECImageWidget"
     BECMotorMapWidget = "BECMotorMapWidget"
+    BECProgressBar = "BECProgressBar"
     BECQueue = "BECQueue"
     BECStatusBox = "BECStatusBox"
     BECWaveformWidget = "BECWaveformWidget"
@@ -1693,6 +1694,57 @@ class BECPlotBase(RPCBase):
         """
 
 
+class BECProgressBar(RPCBase):
+    @rpc_call
+    def set_value(self, value):
+        """
+        Set the value of the progress bar.
+
+        Args:
+            value (float): The value to set.
+        """
+
+    @rpc_call
+    def set_maximum(self, maximum: float):
+        """
+        Set the maximum value of the progress bar.
+
+        Args:
+            maximum (float): The maximum value.
+        """
+
+    @rpc_call
+    def set_minimum(self, minimum: float):
+        """
+        Set the minimum value of the progress bar.
+
+        Args:
+            minimum (float): The minimum value.
+        """
+
+    @property
+    @rpc_call
+    def label_template(self):
+        """
+        The template for the center label. Use $value, $maximum, and $percentage to insert the values.
+
+        Examples:
+        >>> progressbar.label_template = "$value / $maximum - $percentage %"
+        >>> progressbar.label_template = "$value / $percentage %"
+        """
+
+    @label_template.setter
+    @rpc_call
+    def label_template(self):
+        """
+        The template for the center label. Use $value, $maximum, and $percentage to insert the values.
+
+        Examples:
+        >>> progressbar.label_template = "$value / $maximum - $percentage %"
+        >>> progressbar.label_template = "$value / $percentage %"
+        """
+
+
 class BECQueue(RPCBase):
     @property
     @rpc_call
@@ -1887,7 +1939,7 @@ class BECWaveform(RPCBase):
         """
 
     @rpc_call
-    def get_all_data(self, output: "Literal['dict', 'pandas']" = "dict") -> "dict | pd.DataFrame":
+    def get_all_data(self, output: "Literal['dict', 'pandas']" = "dict") -> "dict":
         """
         Extract all curve data into a dictionary or a pandas DataFrame.
 
@@ -2050,6 +2102,25 @@ class BECWaveform(RPCBase):
             size(int): Font size of the legend.
         """
 
+    @rpc_call
+    def toggle_roi(self, toggled: "bool") -> "None":
+        """
+        Toggle the linear region selector on the plot.
+
+        Args:
+            toggled(bool): If True, enable the linear region selector.
+        """
+
+    @rpc_call
+    def select_roi(self, region: "tuple[float, float]"):
+        """
+        Set the fit region of the plot widget. At the moment only a single region is supported.
+        To remove the roi region again, use toggle_roi_region
+
+        Args:
+            region(tuple[float, float]): The fit region.
+        """
+
 
 class BECWaveformWidget(RPCBase):
     @property
@@ -2321,6 +2392,24 @@ class BECWaveformWidget(RPCBase):
         Export the plot widget to Matplotlib.
         """
 
+    @rpc_call
+    def toggle_roi(self, checked: "bool"):
+        """
+        Toggle the linear region selector.
+
+        Args:
+            checked(bool): If True, enable the linear region selector.
+        """
+
+    @rpc_call
+    def select_roi(self, region: "tuple"):
+        """
+        Set the region of interest of the plot widget.
+
+        Args:
+            region(tuple): Region of interest.
+        """
+
 
 class DapComboBox(RPCBase):
     @rpc_call

{bec_widgets-0.106.0 → bec_widgets-0.108.0}/bec_widgets/cli/generate_cli.py

@@ -8,6 +8,7 @@ import sys
 
 import black
 import isort
+from qtpy.QtCore import Property as QtProperty
 
 from bec_widgets.utils.generate_designer_plugin import DesignerPluginGenerator
 from bec_widgets.utils.plugin_utils import BECClassContainer, get_rpc_classes
@@ -90,11 +91,27 @@ class {class_name}(RPCBase):"""
             self.content += """...
     """
         for method in cls.USER_ACCESS:
-            obj = getattr(cls, method)
-            if isinstance(obj, property):
-                self.content += """
+            is_property_setter = False
+            obj = getattr(cls, method, None)
+            if obj is None:
+                obj = getattr(cls, method.split(".setter")[0], None)
+                is_property_setter = True
+                method = method.split(".setter")[0]
+            if obj is None:
+                raise AttributeError(
+                    f"Method {method} not found in class {cls.__name__}. Please check the USER_ACCESS list."
+                )
+            if isinstance(obj, (property, QtProperty)):
+                # for the cli, we can map qt properties to regular properties
+                if is_property_setter:
+                    self.content += f"""
+    @{method}.setter
+    @rpc_call"""
+                else:
+                    self.content += """
     @property
     @rpc_call"""
+
                 sig = str(inspect.signature(obj.fget))
                 doc = inspect.getdoc(obj.fget)
             else:

{bec_widgets-0.106.0 → bec_widgets-0.108.0}/bec_widgets/cli/server.py

@@ -86,10 +86,15 @@ class BECWidgetsCLIServer:
         return obj
 
     def run_rpc(self, obj, method, args, kwargs):
+        logger.debug(f"Running RPC instruction: {method} with args: {args}, kwargs: {kwargs}")
         method_obj = getattr(obj, method)
         # check if the method accepts args and kwargs
         if not callable(method_obj):
-            res = method_obj
+            if not args:
+                res = method_obj
+            else:
+                setattr(obj, method, args[0])
+                res = None
         else:
             sig = inspect.signature(method_obj)
             if sig.parameters:
@@ -245,5 +250,5 @@ def main():
 
 
 if __name__ == "__main__":  # pragma: no cover
-    sys.argv = ["bec_widgets.cli.server", "--id", "test", "--gui_class", "BECDockArea"]
+    sys.argv = ["bec_widgets.cli.server", "--id", "e2860", "--gui_class", "BECDockArea"]
     main()

bec_widgets-0.108.0/bec_widgets/utils/linear_region_selector.py

@@ -0,0 +1,72 @@
+""" Module for a thin wrapper (LinearRegionWrapper) around the LinearRegionItem in pyqtgraph.
+The class is mainly designed for usage with the BECWaveform and 1D plots. """
+
+import pyqtgraph as pg
+from qtpy.QtCore import QObject, Signal, Slot
+from qtpy.QtGui import QColor
+
+
+class LinearRegionWrapper(QObject):
+    """Wrapper class for the LinearRegionItem in pyqtgraph for 1D plots (BECWaveform)
+
+    Args:
+        plot_item (pg.PlotItem): The plot item to add the region selector to.
+        parent (QObject): The parent object.
+        color (QColor): The color of the region selector.
+        hover_color (QColor): The color of the region selector when the mouse is over it.
+    """
+
+    # Signal with the region tuble (start, end)
+    region_changed = Signal(tuple)
+
+    def __init__(
+        self, plot_item: pg.PlotItem, color: QColor = None, hover_color: QColor = None, parent=None
+    ):
+        super().__init__(parent)
+        self._edge_width = 2
+        self.plot_item = plot_item
+        self.linear_region_selector = pg.LinearRegionItem()
+        self.proxy = None
+        self.change_roi_color((color, hover_color))
+
+    # Slot for changing the color of the region selector (edge and fill)
+    @Slot(tuple)
+    def change_roi_color(self, colors: tuple[QColor | str | tuple, QColor | str | tuple]):
+        """Change the color and hover color of the region selector.
+        Hover color means the color when the mouse is over the region.
+
+        Args:
+            colors (tuple): Tuple with the color and hover color
+        """
+        color, hover_color = colors
+        if color is not None:
+            self.linear_region_selector.setBrush(pg.mkBrush(color))
+        if hover_color is not None:
+            self.linear_region_selector.setHoverBrush(pg.mkBrush(hover_color))
+
+    @Slot()
+    def add_region_selector(self):
+        """Add the region selector to the plot item"""
+        self.plot_item.addItem(self.linear_region_selector)
+        # Use proxy to limit the update rate of the region change signal to 10Hz
+        self.proxy = pg.SignalProxy(
+            self.linear_region_selector.sigRegionChanged,
+            rateLimit=10,
+            slot=self._region_change_proxy,
+        )
+
+    @Slot()
+    def remove_region_selector(self):
+        """Remove the region selector from the plot item"""
+        self.proxy.disconnect()
+        self.proxy = None
+        self.plot_item.removeItem(self.linear_region_selector)
+
+    def _region_change_proxy(self):
+        """Emit the region change signal"""
+        region = self.linear_region_selector.getRegion()
+        self.region_changed.emit(region)
+
+    def cleanup(self):
+        """Cleanup the widget."""
+        self.remove_region_selector()

bec_widgets-0.108.0/bec_widgets/widgets/bec_progressbar/bec_progress_bar.pyproject

@@ -0,0 +1 @@
+{'files': ['bec_progressbar.py']}

bec_widgets-0.108.0/bec_widgets/widgets/bec_progressbar/bec_progress_bar_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.bec_progressbar.bec_progressbar import BECProgressBar
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='BECProgressBar' name='bec_progress_bar'>
+    </widget>
+</ui>
+"""
+
+
+class BECProgressBarPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = BECProgressBar(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Utils"
+
+    def icon(self):
+        return designer_material_icon(BECProgressBar.ICON_NAME)
+
+    def includeFile(self):
+        return "bec_progress_bar"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "BECProgressBar"
+
+    def toolTip(self):
+        return "A custom progress bar with smooth transitions and a modern design."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets-0.108.0/bec_widgets/widgets/bec_progressbar/bec_progressbar.py

@@ -0,0 +1,257 @@
+import sys
+from string import Template
+
+from qtpy.QtCore import Property, QEasingCurve, QPropertyAnimation, QRectF, Qt, QTimer, Slot
+from qtpy.QtGui import QColor, QPainter, QPainterPath
+from qtpy.QtWidgets import QApplication, QLabel, QVBoxLayout, QWidget
+
+from bec_widgets.utils.bec_widget import BECWidget
+
+
+class BECProgressBar(BECWidget, QWidget):
+    """
+    A custom progress bar with smooth transitions. The displayed text can be customized using a template.
+    """
+
+    USER_ACCESS = [
+        "set_value",
+        "set_maximum",
+        "set_minimum",
+        "label_template",
+        "label_template.setter",
+    ]
+    ICON_NAME = "page_control"
+
+    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)
+
+        accent_colors = QApplication.instance().theme.accent_colors
+
+        # internal values
+        self._oversampling_factor = 50
+        self._value = 0
+        self._target_value = 0
+        self._maximum = 100 * self._oversampling_factor
+
+        # User values
+        self._user_value = 0
+        self._user_minimum = 0
+        self._user_maximum = 100
+        self._label_template = "$value / $maximum - $percentage %"
+
+        # Color settings
+        self._background_color = QColor(30, 30, 30)
+        self._progress_color = accent_colors.highlight  # QColor(210, 55, 130)
+
+        self._completed_color = accent_colors.success
+        self._border_color = QColor(50, 50, 50)
+
+        # layout settings
+        self._value_animation = QPropertyAnimation(self, b"_progressbar_value")
+        self._value_animation.setDuration(200)
+        self._value_animation.setEasingCurve(QEasingCurve.Type.OutCubic)
+
+        # label on top of the progress bar
+        self.center_label = QLabel(self)
+        self.center_label.setAlignment(Qt.AlignCenter)
+        self.center_label.setStyleSheet("color: white;")
+        self.center_label.setMinimumSize(0, 0)
+
+        layout = QVBoxLayout(self)
+        layout.setContentsMargins(0, 0, 0, 0)
+        layout.setSpacing(0)
+        layout.addWidget(self.center_label)
+        self.setLayout(layout)
+
+        self.update()
+
+    @Property(str, doc="The template for the center label. Use $value, $maximum, and $percentage.")
+    def label_template(self):
+        """
+        The template for the center label. Use $value, $maximum, and $percentage to insert the values.
+
+        Examples:
+        >>> progressbar.label_template = "$value / $maximum - $percentage %"
+        >>> progressbar.label_template = "$value / $percentage %"
+
+        """
+        return self._label_template
+
+    @label_template.setter
+    def label_template(self, template):
+        self._label_template = template
+        self.set_value(self._user_value)
+        self.update()
+
+    @Property(float, designable=False)
+    def _progressbar_value(self):
+        """
+        The current value of the progress bar.
+        """
+        return self._value
+
+    @_progressbar_value.setter
+    def _progressbar_value(self, val):
+        self._value = val
+        self.update()
+
+    def _update_template(self):
+        template = Template(self._label_template)
+        return template.safe_substitute(
+            value=self._user_value,
+            maximum=self._user_maximum,
+            percentage=int((self.map_value(self._user_value) / self._maximum) * 100),
+        )
+
+    @Slot(float)
+    @Slot(int)
+    def set_value(self, value):
+        """
+        Set the value of the progress bar.
+
+        Args:
+            value (float): The value to set.
+        """
+        if value > self._user_maximum:
+            value = self._user_maximum
+        elif value < self._user_minimum:
+            value = self._user_minimum
+        self._target_value = self.map_value(value)
+        self._user_value = value
+        self.center_label.setText(self._update_template())
+        self.animate_progress()
+
+    def paintEvent(self, event):
+        painter = QPainter(self)
+        painter.setRenderHint(QPainter.Antialiasing)
+        rect = self.rect().adjusted(10, 0, -10, -1)
+
+        # Draw background
+        painter.setBrush(self._background_color)
+        painter.setPen(Qt.NoPen)
+        painter.drawRoundedRect(rect, 10, 10)  # Rounded corners
+
+        # Draw border
+        painter.setBrush(Qt.NoBrush)
+        painter.setPen(self._border_color)
+        painter.drawRoundedRect(rect, 10, 10)
+
+        # Determine progress color based on completion
+        if self._value >= self._maximum:
+            current_color = self._completed_color
+        else:
+            current_color = self._progress_color
+
+        # Set clipping region to preserve the background's rounded corners
+        progress_rect = rect.adjusted(
+            0, 0, int(-rect.width() + (self._value / self._maximum) * rect.width()), 0
+        )
+        clip_path = QPainterPath()
+        clip_path.addRoundedRect(QRectF(rect), 10, 10)  # Clip to the background's rounded corners
+        painter.setClipPath(clip_path)
+
+        # Draw progress bar
+        painter.setBrush(current_color)
+        painter.drawRect(progress_rect)  # Less rounded, no additional rounding
+
+        painter.end()
+
+    def animate_progress(self):
+        """
+        Animate the progress bar from the current value to the target value.
+        """
+        self._value_animation.stop()
+        self._value_animation.setStartValue(self._value)
+        self._value_animation.setEndValue(self._target_value)
+        self._value_animation.start()
+
+    @Property(float)
+    def maximum(self):
+        """
+        The maximum value of the progress bar.
+        """
+        return self._user_maximum
+
+    @maximum.setter
+    def maximum(self, maximum: float):
+        """
+        Set the maximum value of the progress bar.
+        """
+        self.set_maximum(maximum)
+
+    @Property(float)
+    def minimum(self):
+        """
+        The minimum value of the progress bar.
+        """
+        return self._user_minimum
+
+    @minimum.setter
+    def minimum(self, minimum: float):
+        self.set_minimum(minimum)
+
+    @Property(float)
+    def initial_value(self):
+        """
+        The initial value of the progress bar.
+        """
+        return self._user_value
+
+    @initial_value.setter
+    def initial_value(self, value: float):
+        self.set_value(value)
+
+    @Slot(float)
+    def set_maximum(self, maximum: float):
+        """
+        Set the maximum value of the progress bar.
+
+        Args:
+            maximum (float): The maximum value.
+        """
+        self._user_maximum = maximum
+        self.set_value(self._user_value)  # Update the value to fit the new range
+        self.update()
+
+    @Slot(float)
+    def set_minimum(self, minimum: float):
+        """
+        Set the minimum value of the progress bar.
+
+        Args:
+            minimum (float): The minimum value.
+        """
+        self._user_minimum = minimum
+        self.set_value(self._user_value)  # Update the value to fit the new range
+        self.update()
+
+    def map_value(self, value: float):
+        """
+        Map the user value to the range [0, 100*self._oversampling_factor] for the progress
+        """
+        return (
+            (value - self._user_minimum) / (self._user_maximum - self._user_minimum) * self._maximum
+        )
+
+
+if __name__ == "__main__":  # pragma: no cover
+    app = QApplication(sys.argv)
+
+    progressBar = BECProgressBar()
+    progressBar.show()
+    progressBar.set_minimum(-100)
+    progressBar.set_maximum(0)
+
+    # Example of setting values
+    def update_progress():
+        value = progressBar._user_value + 2.5
+        if value > progressBar._user_maximum:
+            value = -100  # progressBar._maximum / progressBar._upsampling_factor
+        progressBar.set_value(value)
+
+    timer = QTimer()
+    timer.timeout.connect(update_progress)
+    timer.start(200)  # Update every half second
+
+    sys.exit(app.exec())

bec_widgets-0.108.0/bec_widgets/widgets/bec_progressbar/register_bec_progress_bar.py

@@ -0,0 +1,15 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.bec_progressbar.bec_progress_bar_plugin import BECProgressBarPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(BECProgressBarPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()