bec-widgets 1.14.1__tar.gz → 1.15.1__tar.gz

{bec_widgets-1.14.1 → bec_widgets-1.15.1}/CHANGELOG.md

@@ -1,6 +1,25 @@
 # CHANGELOG
 
 
+## v1.15.1 (2025-01-13)
+
+### Bug Fixes
+
+- **error_popups**: Safeproperty wrapper extended to catch more errors and not crash Designer
+  ([`3b04b98`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3b04b985b66a7237703a87f6a53610171eb9ffa5))
+
+
+## v1.15.0 (2025-01-10)
+
+### Features
+
+- **widget_state_manager**: Example app added
+  ([`a00d368`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a00d368c25a19b04d6fbc8a07cff330d1a232e21))
+
+- **widget_state_manager**: State manager for single widget
+  ([`01b4608`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/01b4608331f375aeeeb692328b693f2d2802dc9c))
+
+
 ## v1.14.1 (2025-01-10)
 
 ### Bug Fixes

{bec_widgets-1.14.1 → bec_widgets-1.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 1.14.1
+Version: 1.15.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-1.14.1 → bec_widgets-1.15.1}/bec_widgets/qt_utils/error_popups.py

@@ -2,25 +2,52 @@ import functools
 import sys
 import traceback
 
+from bec_lib.logger import bec_logger
 from qtpy.QtCore import Property, QObject, Qt, Signal, Slot
 from qtpy.QtWidgets import QApplication, QMessageBox, QPushButton, QVBoxLayout, QWidget
 
 
-def SafeProperty(prop_type, *prop_args, popup_error: bool = False, **prop_kwargs):
+def SafeProperty(prop_type, *prop_args, popup_error: bool = False, default=None, **prop_kwargs):
     """
-    Decorator to create a Qt Property with a safe setter that won't crash Designer on errors.
-    Behaves similarly to SafeSlot, but for properties.
+    Decorator to create a Qt Property with safe getter and setter so that
+    Qt Designer won't crash if an exception occurs in either method.
 
     Args:
-        prop_type: The property type (e.g., str, bool, "QStringList", etc.)
-        popup_error (bool): If True, show popup on error, otherwise just handle it silently.
-        *prop_args, **prop_kwargs: Additional arguments and keyword arguments accepted by Property.
+        prop_type: The property type (e.g., str, bool, int, custom classes, etc.)
+        popup_error (bool): If True, show a popup for any error; otherwise, ignore or log silently.
+        default: Any default/fallback value to return if the getter raises an exception.
+        *prop_args, **prop_kwargs: Passed along to the underlying Qt Property constructor.
+
+    Usage:
+        @SafeProperty(int, default=-1)
+        def some_value(self) -> int:
+            # your getter logic
+            return ...   # if an exception is raised, returns -1
+
+        @some_value.setter
+        def some_value(self, val: int):
+            # your setter logic
+            ...
     """
 
-    def decorator(getter):
+    def decorator(py_getter):
+        @functools.wraps(py_getter)
+        def safe_getter(self_):
+            try:
+                return py_getter(self_)
+            except Exception:
+                if popup_error:
+                    ErrorPopupUtility().custom_exception_hook(*sys.exc_info(), popup_error=True)
+                # Return the user-defined default (which might be anything, including None).
+                else:
+                    error_msg = traceback.format_exc()
+                    bec_logger.error(error_msg)
+                return default
+
         class PropertyWrapper:
             def __init__(self, getter_func):
-                self.getter_func = getter_func
+                # We store only our safe_getter in the wrapper
+                self.getter_func = safe_getter
 
             def setter(self, setter_func):
                 @functools.wraps(setter_func)
@@ -32,12 +59,20 @@ def SafeProperty(prop_type, *prop_args, popup_error: bool = False, **prop_kwargs
                             ErrorPopupUtility().custom_exception_hook(
                                 *sys.exc_info(), popup_error=True
                             )
+                        # Swallow the exception; no crash in Designer
                         else:
-                            return
+                            error_msg = traceback.format_exc()
+                            bec_logger.error(error_msg)
+                        return
 
+                # Return the full read/write Property
                 return Property(prop_type, self.getter_func, safe_setter, *prop_args, **prop_kwargs)
 
-        return PropertyWrapper(getter)
+            def __call__(self):
+                # If the user never chains a .setter(...) call, we produce a read-only property
+                return Property(prop_type, self.getter_func, None, *prop_args, **prop_kwargs)
+
+        return PropertyWrapper(py_getter)
 
     return decorator
 

bec_widgets-1.15.1/bec_widgets/utils/widget_state_manager.py

@@ -0,0 +1,151 @@
+from __future__ import annotations
+
+from qtpy.QtCore import QSettings
+from qtpy.QtWidgets import (
+    QApplication,
+    QCheckBox,
+    QFileDialog,
+    QHBoxLayout,
+    QLineEdit,
+    QPushButton,
+    QSpinBox,
+    QVBoxLayout,
+    QWidget,
+)
+
+
+class WidgetStateManager:
+    """
+    A class to manage the state of a widget by saving and loading the state to and from a INI file.
+
+    Args:
+        widget(QWidget): The widget to manage the state for.
+    """
+
+    def __init__(self, widget):
+        self.widget = widget
+
+    def save_state(self, filename: str = None):
+        """
+        Save the state of the widget to a INI file.
+
+        Args:
+            filename(str): The filename to save the state to.
+        """
+        if not filename:
+            filename, _ = QFileDialog.getSaveFileName(
+                self.widget, "Save Settings", "", "INI Files (*.ini)"
+            )
+        if filename:
+            settings = QSettings(filename, QSettings.IniFormat)
+            self._save_widget_state_qsettings(self.widget, settings)
+
+    def load_state(self, filename: str = None):
+        """
+        Load the state of the widget from a INI file.
+
+        Args:
+            filename(str): The filename to load the state from.
+        """
+        if not filename:
+            filename, _ = QFileDialog.getOpenFileName(
+                self.widget, "Load Settings", "", "INI Files (*.ini)"
+            )
+        if filename:
+            settings = QSettings(filename, QSettings.IniFormat)
+            self._load_widget_state_qsettings(self.widget, settings)
+
+    def _save_widget_state_qsettings(self, widget: QWidget, settings: QSettings):
+        """
+        Save the state of the widget to QSettings.
+
+        Args:
+            widget(QWidget): The widget to save the state for.
+            settings(QSettings): The QSettings object to save the state to.
+        """
+        meta = widget.metaObject()
+        settings.beginGroup(widget.objectName())
+        for i in range(meta.propertyCount()):
+            prop = meta.property(i)
+            name = prop.name()
+            value = widget.property(name)
+            settings.setValue(name, value)
+        settings.endGroup()
+
+        # Recursively save child widgets
+        for child in widget.findChildren(QWidget):
+            if child.objectName():
+                self._save_widget_state_qsettings(child, settings)
+
+    def _load_widget_state_qsettings(self, widget: QWidget, settings: QSettings):
+        """
+        Load the state of the widget from QSettings.
+
+        Args:
+            widget(QWidget): The widget to load the state for.
+            settings(QSettings): The QSettings object to load the state from.
+        """
+        meta = widget.metaObject()
+        settings.beginGroup(widget.objectName())
+        for i in range(meta.propertyCount()):
+            prop = meta.property(i)
+            name = prop.name()
+            if settings.contains(name):
+                value = settings.value(name)
+                widget.setProperty(name, value)
+        settings.endGroup()
+
+        # Recursively load child widgets
+        for child in widget.findChildren(QWidget):
+            if child.objectName():
+                self._load_widget_state_qsettings(child, settings)
+
+
+class ExampleApp(QWidget):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self.setObjectName("MainWindow")
+        self.setWindowTitle("State Manager Example")
+
+        layout = QVBoxLayout(self)
+
+        # A line edit to store some user text
+        self.line_edit = QLineEdit(self)
+        self.line_edit.setObjectName("MyLineEdit")
+        self.line_edit.setPlaceholderText("Enter some text here...")
+        layout.addWidget(self.line_edit)
+
+        # A spin box to hold a numeric value
+        self.spin_box = QSpinBox(self)
+        self.spin_box.setObjectName("MySpinBox")
+        self.spin_box.setRange(0, 100)
+        layout.addWidget(self.spin_box)
+
+        # A checkbox to hold a boolean value
+        self.check_box = QCheckBox("Enable feature?", self)
+        self.check_box.setObjectName("MyCheckBox")
+        layout.addWidget(self.check_box)
+
+        # Buttons to save and load state
+        button_layout = QHBoxLayout()
+        self.save_button = QPushButton("Save State", self)
+        self.load_button = QPushButton("Load State", self)
+        button_layout.addWidget(self.save_button)
+        button_layout.addWidget(self.load_button)
+        layout.addLayout(button_layout)
+
+        # Create the state manager
+        self.state_manager = WidgetStateManager(self)
+
+        # Connect buttons
+        self.save_button.clicked.connect(lambda: self.state_manager.save_state())
+        self.load_button.clicked.connect(lambda: self.state_manager.load_state())
+
+
+if __name__ == "__main__":  # pragma: no cover:
+    import sys
+
+    app = QApplication(sys.argv)
+    w = ExampleApp()
+    w.show()
+    sys.exit(app.exec_())

{bec_widgets-1.14.1 → bec_widgets-1.15.1}/pyproject.toml

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