bec-widgets 1.17.1__py3-none-any.whl → 1.18.0__py3-none-any.whl

.gitlab-ci.yml

@@ -78,9 +78,9 @@ formatter:
   stage: Formatter
   needs: []
   script:
-    - pip install black isort
-    - isort --check --diff ./
-    - black --check --diff --color ./
+    - pip install bec_lib[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:
     - if: $CI_PROJECT_PATH == "bec/bec_widgets"
 
@@ -148,7 +148,7 @@ tests:
     - *clone-repos
     - *install-os-packages
     - *install-repos
-    - pip install -e .[dev,pyqt6]
+    - pip install -e .[dev,pyside6]
     - coverage run --source=./bec_widgets -m pytest -v --junitxml=report.xml --maxfail=2 --random-order --full-trace ./tests/unit_tests
     - coverage report
     - coverage xml
@@ -172,7 +172,6 @@ test-matrix:
           - "3.12"
         QT_PCKG:
           - "pyside6"
-          - "pyqt6"
 
   stage: AdditionalTests
   needs: []
@@ -211,7 +210,7 @@ end-2-end-conda:
     - cd ../
     - pip install -e ./ophyd_devices
 
-    - pip install -e .[dev,pyqt6]
+    - pip install -e .[dev,pyside6]
     - cd ./tests/end-2-end
     - pytest -v --start-servers --flush-redis --random-order
 

CHANGELOG.md

@@ -1,6 +1,39 @@
 # CHANGELOG
 
 
+## v1.18.0 (2025-01-30)
+
+### Bug Fixes
+
+- **generate_cli**: Widgets can be tagged with RPC=False, then they are excluded from client.py for
+  RPC
+  ([`48fc63d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/48fc63d83e26889843b09b1eb4792612b53200ec))
+
+### Build System
+
+- Pyqt6 support dropped
+  ([`a20935e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a20935e8625a9490e6c451a3b4012476e19317e5))
+
+### Continuous Integration
+
+- Fix formatter 2024 versions
+  ([`4f8e683`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4f8e6835fe2312151dc2b40f0ab9eb50a9173f7c))
+
+### Features
+
+- **plot_base_next_gen**: New type of plot base inherited from QWidget
+  ([`e7c9729`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e7c97290cd783d19128625567835d7ae9a414989))
+
+
+## v1.17.2 (2025-01-28)
+
+### Bug Fixes
+
+- **widget_state_manager**: Skip QLabel saving; skip_setting property widget excluded from INI;
+  stored=False property excluded from INI
+  ([`b2b0450`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b2b0450bcb07c974e5f8002e084b350599c32d39))
+
+
 ## v1.17.1 (2025-01-26)
 
 ### Bug Fixes

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 1.17.1
+Version: 1.18.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
@@ -28,8 +28,5 @@ Requires-Dist: pytest-random-order~=1.1; extra == 'dev'
 Requires-Dist: pytest-timeout~=2.2; extra == 'dev'
 Requires-Dist: pytest-xvfb~=3.0; extra == 'dev'
 Requires-Dist: pytest~=8.0; extra == 'dev'
-Provides-Extra: pyqt6
-Requires-Dist: pyqt6-webengine>=6.7; extra == 'pyqt6'
-Requires-Dist: pyqt6>=6.7; extra == 'pyqt6'
 Provides-Extra: pyside6
 Requires-Dist: pyside6==6.7.2; extra == 'pyside6'

README.md

@@ -1,12 +1,17 @@
 # BEC Widgets
 
+**⚠️ Important Notice:**
+
+🚨 **PyQt6 is no longer supported** due to incompatibilities with Qt Designer. Please use **PySide6** instead. 🚨
+
 BEC Widgets is a GUI framework designed for interaction with [BEC (Beamline Experiment Control)](https://gitlab.psi.ch/bec/bec).
+
 ## Installation
 
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install BEC Widgets:
 
 ```bash
-pip install bec_widgets PyQt6
+pip install bec_widgets[pyside6]
 ```
 
 For development purposes, you can clone the repository and install the package locally in editable mode:
@@ -14,22 +19,12 @@ For development purposes, you can clone the repository and install the package l
 ```bash
 git clone https://gitlab.psi.ch/bec/bec-widgets
 cd bec_widgets
-pip install -e .[dev,pyqt6]
+pip install -e .[dev,pyside6]
 ```
 
-BEC Widgets currently supports both Pyside6 and PyQt6, however, no default distribution is specified. As a result, users must install one of the supported
-Python Qt distributions manually.
-
-To select a specific Python Qt distribution, install the package with an additional tag:
-
-```bash
-pip install bec_widgets[pyqt6]
-```
-or 
+BEC Widgets now **only supports PySide6**. Users must manually install PySide6 as no default Qt distribution is
+specified.
 
-```bash
-pip install bec_widgets[pyside6]
-```
 ## Documentation
 
 Documentation of BEC Widgets can be found [here](https://bec-widgets.readthedocs.io/en/latest/). The documentation of the BEC can be found [here](https://bec.readthedocs.io/en/latest/).
@@ -39,7 +34,7 @@ Documentation of BEC Widgets can be found [here](https://bec-widgets.readthedocs
 All commits should use the Angular commit scheme:
 
 > #### <a name="commit-header"></a>Angular Commit Message Header
-> 
+>
 > ```
 > <type>(<scope>): <short summary>
 >   │       │             │
@@ -53,13 +48,13 @@ All commits should use the Angular commit scheme:
 >   │
 >   └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test
 > ```
-> 
+>
 > The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional.
 
 > ##### Type
-> 
+>
 > Must be one of the following:
-> 
+>
 > * **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 > * **ci**: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs)
 > * **docs**: Documentation only changes
@@ -71,4 +66,5 @@ All commits should use the Angular commit scheme:
 
 ## License
 
-[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)
+[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)
+

bec_widgets/cli/generate_cli.py

@@ -43,14 +43,21 @@ from bec_widgets.cli.rpc.rpc_base import RPCBase, rpc_call
 
     def generate_client(self, class_container: BECClassContainer):
         """
-        Generate the client for the published classes.
+        Generate the client for the published classes, skipping any classes
+        that have `RPC = False`.
 
         Args:
             class_container: The class container with the classes to generate the client for.
         """
-        rpc_top_level_classes = class_container.rpc_top_level_classes
+        # Filter out classes that explicitly have RPC=False
+        rpc_top_level_classes = [
+            cls for cls in class_container.rpc_top_level_classes if getattr(cls, "RPC", True)
+        ]
         rpc_top_level_classes.sort(key=lambda x: x.__name__)
-        connector_classes = class_container.connector_classes
+
+        connector_classes = [
+            cls for cls in class_container.connector_classes if getattr(cls, "RPC", True)
+        ]
         connector_classes.sort(key=lambda x: x.__name__)
 
         self.write_client_enum(rpc_top_level_classes)
@@ -81,13 +88,13 @@ class Widgets(str, enum.Enum):
 
         class_name = cls.__name__
 
-        # Generate the content
-        if cls.__name__ == "BECDockArea":
+        if class_name == "BECDockArea":
             self.content += f"""
 class {class_name}(RPCBase):"""
         else:
             self.content += f"""
 class {class_name}(RPCBase):"""
+
         if not cls.USER_ACCESS:
             self.content += """...
     """
@@ -100,8 +107,10 @@ class {class_name}(RPCBase):"""
                 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."
+                    f"Method {method} not found in class {cls.__name__}. "
+                    f"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:

bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -20,6 +20,7 @@ from bec_widgets.widgets.containers.dock import BECDockArea
 from bec_widgets.widgets.containers.figure import BECFigure
 from bec_widgets.widgets.containers.layout_manager.layout_manager import LayoutManagerWidget
 from bec_widgets.widgets.editors.jupyter_console.jupyter_console import BECJupyterConsole
+from bec_widgets.widgets.plots_next_gen.plot_base import PlotBase
 
 
 class JupyterConsoleWindow(QWidget):  # pragma: no cover:
@@ -62,6 +63,8 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
                     "btn4": self.btn4,
                     "btn5": self.btn5,
                     "btn6": self.btn6,
+                    "pb": self.pb,
+                    "pi": self.pi,
                 }
             )
 
@@ -92,6 +95,15 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         third_tab_layout.addWidget(self.lm)
         tab_widget.addTab(third_tab, "Layout Manager Widget")
 
+        fourth_tab = QWidget()
+        fourth_tab_layout = QVBoxLayout(fourth_tab)
+        self.pb = PlotBase()
+        self.pi = self.pb.plot_item
+        fourth_tab_layout.addWidget(self.pb)
+        tab_widget.addTab(fourth_tab, "PltoBase")
+
+        tab_widget.setCurrentIndex(3)
+
         group_box = QGroupBox("Jupyter Console", splitter)
         group_box_layout = QVBoxLayout(group_box)
         self.console = BECJupyterConsole(inprocess=True)

bec_widgets/qt_utils/round_frame.py

@@ -29,6 +29,7 @@ class RoundedFrame(BECWidget, QFrame):
         self._radius = radius
 
         # Apply rounded frame styling
+        self.setProperty("skip_settings", True)
         self.setObjectName("roundedFrame")
         self.update_style()
 
@@ -113,10 +114,12 @@ class RoundedFrame(BECWidget, QFrame):
 
             # Apply axis label and tick colors
             plot_item = self.content_widget.getPlotItem()
-            plot_item.getAxis("left").setPen(pg.mkPen(color=axis_color))
-            plot_item.getAxis("bottom").setPen(pg.mkPen(color=axis_color))
-            plot_item.getAxis("left").setTextPen(pg.mkPen(color=label_color))
-            plot_item.getAxis("bottom").setTextPen(pg.mkPen(color=label_color))
+            for axis in ["left", "right", "top", "bottom"]:
+                plot_item.getAxis(axis).setPen(pg.mkPen(color=axis_color))
+                plot_item.getAxis(axis).setTextPen(pg.mkPen(color=label_color))
+
+            # Change title color
+            plot_item.titleLabel.setText(plot_item.titleLabel.text, color=label_color)
 
             # Apply border style via stylesheet
             self.content_widget.setStyleSheet(

bec_widgets/qt_utils/side_panel.py

@@ -5,18 +5,18 @@ from qtpy.QtCore import Property, QEasingCurve, QPropertyAnimation
 from qtpy.QtGui import QAction
 from qtpy.QtWidgets import (
     QApplication,
+    QFrame,
     QHBoxLayout,
     QLabel,
     QMainWindow,
+    QScrollArea,
     QSizePolicy,
-    QSpacerItem,
     QStackedWidget,
     QVBoxLayout,
     QWidget,
 )
 
 from bec_widgets.qt_utils.toolbar import MaterialIconAction, ModularToolBar
-from bec_widgets.widgets.plots.waveform.waveform_widget import BECWaveformWidget
 
 
 class SidePanel(QWidget):
@@ -34,11 +34,13 @@ class SidePanel(QWidget):
     ):
         super().__init__(parent=parent)
 
+        self.setProperty("skip_settings", True)
+        self.setObjectName("SidePanel")
+
         self._orientation = orientation
         self._panel_max_width = panel_max_width
         self._animation_duration = animation_duration
         self._animations_enabled = animations_enabled
-        self._orientation = orientation
 
         self._panel_width = 0
         self._panel_height = 0
@@ -68,6 +70,7 @@ class SidePanel(QWidget):
             self.stack_widget = QStackedWidget()
             self.stack_widget.setSizePolicy(QSizePolicy.Fixed, QSizePolicy.Expanding)
             self.stack_widget.setMinimumWidth(5)
+            self.stack_widget.setMaximumWidth(self._panel_max_width)
 
             if self._orientation == "left":
                 self.main_layout.addWidget(self.toolbar)
@@ -77,7 +80,10 @@ class SidePanel(QWidget):
                 self.main_layout.addWidget(self.toolbar)
 
             self.container.layout.addWidget(self.stack_widget)
-            self.stack_widget.setMaximumWidth(self._panel_max_width)
+
+            self.menu_anim = QPropertyAnimation(self, b"panel_width")
+            self.setSizePolicy(QSizePolicy.Fixed, QSizePolicy.Expanding)
+            self.panel_width = 0  # start hidden
 
         else:
             self.main_layout = QVBoxLayout(self)
@@ -94,6 +100,7 @@ class SidePanel(QWidget):
             self.stack_widget = QStackedWidget()
             self.stack_widget.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Fixed)
             self.stack_widget.setMinimumHeight(5)
+            self.stack_widget.setMaximumHeight(self._panel_max_width)
 
             if self._orientation == "top":
                 self.main_layout.addWidget(self.toolbar)
@@ -103,74 +110,46 @@ class SidePanel(QWidget):
                 self.main_layout.addWidget(self.toolbar)
 
             self.container.layout.addWidget(self.stack_widget)
-            self.stack_widget.setMaximumHeight(self._panel_max_width)
 
-        if self._orientation in ("left", "right"):
-            self.menu_anim = QPropertyAnimation(self, b"panel_width")
-        else:
             self.menu_anim = QPropertyAnimation(self, b"panel_height")
+            self.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Fixed)
+            self.panel_height = 0  # start hidden
 
         self.menu_anim.setDuration(self._animation_duration)
         self.menu_anim.setEasingCurve(QEasingCurve.InOutQuad)
 
-        if self._orientation in ("left", "right"):
-            self.panel_width = 0
-        else:
-            self.panel_height = 0
-
     @Property(int)
     def panel_width(self):
-        """
-        Get the panel width.
-        """
+        """Get the panel width."""
         return self._panel_width
 
     @panel_width.setter
     def panel_width(self, width: int):
-        """
-        Set the panel width.
-
-        Args:
-            width(int): The width of the panel.
-        """
+        """Set the panel width."""
         self._panel_width = width
         if self._orientation in ("left", "right"):
             self.stack_widget.setFixedWidth(width)
 
     @Property(int)
     def panel_height(self):
-        """
-        Get the panel height.
-        """
+        """Get the panel height."""
         return self._panel_height
 
     @panel_height.setter
     def panel_height(self, height: int):
-        """
-        Set the panel height.
-
-        Args:
-            height(int): The height of the panel.
-        """
+        """Set the panel height."""
         self._panel_height = height
         if self._orientation in ("top", "bottom"):
             self.stack_widget.setFixedHeight(height)
 
     @Property(int)
     def panel_max_width(self):
-        """
-        Get the maximum width of the panel.
-        """
+        """Get the maximum width of the panel."""
         return self._panel_max_width
 
     @panel_max_width.setter
     def panel_max_width(self, size: int):
-        """
-        Set the maximum width of the panel.
-
-        Args:
-            size(int): The maximum width of the panel.
-        """
+        """Set the maximum width of the panel."""
         self._panel_max_width = size
         if self._orientation in ("left", "right"):
             self.stack_widget.setMaximumWidth(self._panel_max_width)
@@ -179,45 +158,28 @@ class SidePanel(QWidget):
 
     @Property(int)
     def animation_duration(self):
-        """
-        Get the duration of the animation.
-        """
+        """Get the duration of the animation."""
         return self._animation_duration
 
     @animation_duration.setter
     def animation_duration(self, duration: int):
-        """
-        Set the duration of the animation.
-
-        Args:
-            duration(int): The duration of the animation.
-        """
+        """Set the duration of the animation."""
         self._animation_duration = duration
         self.menu_anim.setDuration(duration)
 
     @Property(bool)
     def animations_enabled(self):
-        """
-        Get the status of the animations.
-        """
+        """Get the status of the animations."""
         return self._animations_enabled
 
     @animations_enabled.setter
     def animations_enabled(self, enabled: bool):
-        """
-        Set the status of the animations.
-
-        Args:
-            enabled(bool): The status of the animations.
-        """
+        """Set the status of the animations."""
         self._animations_enabled = enabled
 
     def show_panel(self, idx: int):
         """
         Show the side panel with animation and switch to idx.
-
-        Args:
-            idx(int): The index of the panel to show.
         """
         self.stack_widget.setCurrentIndex(idx)
         self.panel_visible = True
@@ -265,9 +227,6 @@ class SidePanel(QWidget):
     def switch_to(self, idx: int):
         """
         Switch to the specified index without animation.
-
-        Args:
-            idx(int): The index of the panel to switch to.
         """
         if self.current_index != idx:
             self.stack_widget.setCurrentIndex(idx)
@@ -284,21 +243,35 @@ class SidePanel(QWidget):
             widget(QWidget): The widget to add to the panel.
             title(str): The title of the panel.
         """
+        # container_widget: top-level container for the stacked page
         container_widget = QWidget()
         container_layout = QVBoxLayout(container_widget)
-        container_widget.setStyleSheet("background-color: rgba(0,0,0,0);")
+        container_layout.setContentsMargins(0, 0, 0, 0)
+        container_layout.setSpacing(5)
+
         title_label = QLabel(f"<b>{title}</b>")
         title_label.setStyleSheet("font-size: 16px;")
-        spacer = QSpacerItem(0, 0, QSizePolicy.Minimum, QSizePolicy.Expanding)
         container_layout.addWidget(title_label)
-        container_layout.addWidget(widget)
-        container_layout.addItem(spacer)
-        container_layout.setContentsMargins(5, 5, 5, 5)
-        container_layout.setSpacing(5)
 
+        # Create a QScrollArea for the actual widget to ensure scrolling if the widget inside is too large
+        scroll_area = QScrollArea()
+        scroll_area.setFrameShape(QFrame.NoFrame)
+        scroll_area.setWidgetResizable(True)
+        # Let the scroll area expand in both directions if there's room
+        scroll_area.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
+        scroll_area.setWidget(widget)
+
+        # Put the scroll area in the container layout
+        container_layout.addWidget(scroll_area)
+
+        # Optionally stretch the scroll area to fill vertical space
+        container_layout.setStretchFactor(scroll_area, 1)
+
+        # Add container_widget to the stacked widget
         index = self.stack_widget.count()
         self.stack_widget.addWidget(container_widget)
 
+        # Add an action to the toolbar
         action = MaterialIconAction(icon_name=icon_name, tooltip=tooltip, checkable=True)
         self.toolbar.add_action(action_id, action, target_widget=self)
 
@@ -326,6 +299,11 @@ class SidePanel(QWidget):
         action.action.toggled.connect(on_action_toggled)
 
 
+############################################
+# DEMO APPLICATION
+############################################
+
+
 class ExampleApp(QMainWindow):  # pragma: no cover
     def __init__(self):
         super().__init__()
@@ -333,20 +311,24 @@ class ExampleApp(QMainWindow):  # pragma: no cover
 
         central_widget = QWidget()
         self.setCentralWidget(central_widget)
-
-        self.side_panel = SidePanel(self, orientation="left")
-
         self.layout = QHBoxLayout(central_widget)
 
+        # Create side panel
+        self.side_panel = SidePanel(self, orientation="left", panel_max_width=250)
         self.layout.addWidget(self.side_panel)
+
+        from bec_widgets.widgets.plots.waveform.waveform_widget import BECWaveformWidget
+
         self.plot = BECWaveformWidget()
         self.layout.addWidget(self.plot)
+
         self.add_side_menus()
 
     def add_side_menus(self):
         widget1 = QWidget()
-        widget1_layout = QVBoxLayout(widget1)
-        widget1_layout.addWidget(QLabel("This is Widget 1"))
+        layout1 = QVBoxLayout(widget1)
+        for i in range(15):
+            layout1.addWidget(QLabel(f"Widget 1 label row {i}"))
         self.side_panel.add_menu(
             action_id="widget1",
             icon_name="counter_1",
@@ -356,8 +338,8 @@ class ExampleApp(QMainWindow):  # pragma: no cover
         )
 
         widget2 = QWidget()
-        widget2_layout = QVBoxLayout(widget2)
-        widget2_layout.addWidget(QLabel("This is Widget 2"))
+        layout2 = QVBoxLayout(widget2)
+        layout2.addWidget(QLabel("Short widget 2 content"))
         self.side_panel.add_menu(
             action_id="widget2",
             icon_name="counter_2",
@@ -367,8 +349,9 @@ class ExampleApp(QMainWindow):  # pragma: no cover
         )
 
         widget3 = QWidget()
-        widget3_layout = QVBoxLayout(widget3)
-        widget3_layout.addWidget(QLabel("This is Widget 3"))
+        layout3 = QVBoxLayout(widget3)
+        for i in range(10):
+            layout3.addWidget(QLabel(f"Line {i} for Widget 3"))
         self.side_panel.add_menu(
             action_id="widget3",
             icon_name="counter_3",
@@ -381,6 +364,6 @@ class ExampleApp(QMainWindow):  # pragma: no cover
 if __name__ == "__main__":  # pragma: no cover
     app = QApplication(sys.argv)
     window = ExampleApp()
-    window.resize(800, 600)
+    window.resize(1000, 700)
     window.show()
     sys.exit(app.exec())