bec-widgets 0.99.15__py3-none-any.whl → 0.100.0__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## v0.100.0 (2024-09-01)
+
+### Documentation
+
+* docs(becwidget): improvements to the bec widget base class docs; fixed type hint import for sphinx ([`99d5e8e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/99d5e8e71c7f89a53d7967126f4056dde005534c))
+
+### Feature
+
+* feat(theme): added theme handler to bec widget base class; added tests ([`7fb938a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7fb938a8506685278ee5eeb6fe9a03f74b713cf8))
+
+### Fix
+
+* fix(pyqt slot): removed slot decorator to avoid problems with pyqt6 ([`6c1f89a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6c1f89ad39b7240ab1d1c1123422b99ae195bf01))
+
 ## v0.99.15 (2024-08-31)
 
 ### Fix
@@ -137,21 +151,3 @@
 * fix(color maps): color maps should take the background color into account; fixed min colors to 10 ([`060935f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/060935ffc5472a958c337bf60834c5291f104ece))
 
 ## v0.99.2 (2024-08-27)
-
-### Ci
-
-* ci: additional tests are not allowed to fail ([`bb385f0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/bb385f07ca18904461a541b5cadde05398c84438))
-
-### Fix
-
-* fix(widgets): fixed default theme for widgets
-
-If not theme is set, the init of the BECWidget base class sets the default theme to "dark" ([`cf28730`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cf28730515e3c2d5914e0205768734c578711e5c))
-
-## v0.99.1 (2024-08-27)
-
-### Fix
-
-* fix(crosshair): emit all crosshair events, not just line coordinates ([`2265458`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2265458dcc57970db18c62619f5877d542d72e81))
-
-## v0.99.0 (2024-08-25)

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.99.15
+Version: 0.100.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/qt_utils/toolbar.py

@@ -1,4 +1,6 @@
 # pylint: disable=no-name-in-module
+from __future__ import annotations
+
 import os
 from abc import ABC, abstractmethod
 from collections import defaultdict

bec_widgets/utils/bec_widget.py

@@ -1,3 +1,6 @@
+from __future__ import annotations
+
+from qtpy.QtCore import Slot
 from qtpy.QtWidgets import QApplication, QWidget
 
 from bec_widgets.utils.bec_connector import BECConnector, ConnectionConfig
@@ -11,7 +14,30 @@ class BECWidget(BECConnector):
     # from fonts.google.com/icons. Override this in subclasses to set the icon name.
     ICON_NAME = "widgets"
 
-    def __init__(self, client=None, config: ConnectionConfig = None, gui_id: str = None):
+    def __init__(
+        self,
+        client=None,
+        config: ConnectionConfig = None,
+        gui_id: str = None,
+        theme_update: bool = False,
+    ):
+        """
+        Base class for all BEC widgets. This class should be used as a mixin class for all BEC widgets, e.g.:
+
+
+        >>> class MyWidget(BECWidget, QWidget):
+        >>>     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)
+
+
+        Args:
+            client(BECClient, optional): The BEC client.
+            config(ConnectionConfig, optional): The connection configuration.
+            gui_id(str, optional): The GUI ID.
+            theme_update(bool, optional): Whether to subscribe to theme updates. Defaults to False. When set to True, the
+                widget's apply_theme method will be called when the theme changes.
+        """
         if not isinstance(self, QWidget):
             raise RuntimeError(f"{repr(self)} is not a subclass of QWidget")
         super().__init__(client, config, gui_id)
@@ -19,7 +45,35 @@ class BECWidget(BECConnector):
         # Set the theme to auto if it is not set yet
         app = QApplication.instance()
         if not hasattr(app, "theme"):
-            set_theme("dark")
+            set_theme("auto")
+
+        if theme_update:
+            self._connect_to_theme_change()
+
+    def _connect_to_theme_change(self):
+        """Connect to the theme change signal."""
+        qapp = QApplication.instance()
+        if hasattr(qapp, "theme_signal"):
+            qapp.theme_signal.theme_updated.connect(self._update_theme)
+
+    def _update_theme(self, theme: str):
+        """Update the theme."""
+        if theme is None:
+            qapp = QApplication.instance()
+            if hasattr(qapp, "theme"):
+                theme = qapp.theme["theme"]
+            else:
+                theme = "dark"
+        self.apply_theme(theme)
+
+    @Slot(str)
+    def apply_theme(self, theme: str):
+        """
+        Apply the theme to the widget.
+
+        Args:
+            theme(str, optional): The theme to be applied.
+        """
 
     def cleanup(self):
         """Cleanup the widget."""

bec_widgets/utils/colors.py

@@ -19,6 +19,17 @@ def get_theme_palette():
     return bec_qthemes.load_palette(theme)
 
 
+def _theme_update_callback():
+    """
+    Internal callback function to update the theme based on the system theme.
+    """
+    app = QApplication.instance()
+    # pylint: disable=protected-access
+    app.theme["theme"] = app.os_listener._theme.lower()
+    app.theme_signal.theme_updated.emit(app.theme["theme"])
+    apply_theme(app.os_listener._theme.lower())
+
+
 def set_theme(theme: Literal["dark", "light", "auto"]):
     """
     Set the theme for the application.
@@ -27,23 +38,17 @@ def set_theme(theme: Literal["dark", "light", "auto"]):
         theme (Literal["dark", "light", "auto"]): The theme to set. "auto" will automatically switch between dark and light themes based on the system theme.
     """
     app = QApplication.instance()
-    bec_qthemes.setup_theme(theme)
-    pg.setConfigOption("background", "w" if app.theme["theme"] == "light" else "k")
+    bec_qthemes.setup_theme(theme, install_event_filter=False)
+
     app.theme_signal.theme_updated.emit(theme)
     apply_theme(theme)
 
-    # pylint: disable=protected-access
     if theme != "auto":
         return
 
-    def callback():
-        app.theme["theme"] = listener._theme.lower()
-        app.theme_signal.theme_updated.emit(app.theme["theme"])
-        apply_theme(listener._theme.lower())
-
-    listener = OSThemeSwitchListener(callback)
-
-    app.installEventFilter(listener)
+    if not hasattr(app, "os_listener") or app.os_listener is None:
+        app.os_listener = OSThemeSwitchListener(_theme_update_callback)
+        app.installEventFilter(app.os_listener)
 
 
 def apply_theme(theme: Literal["dark", "light"]):
@@ -55,21 +60,12 @@ def apply_theme(theme: Literal["dark", "light"]):
     children = itertools.chain.from_iterable(
         top.findChildren(pg.GraphicsLayoutWidget) for top in app.topLevelWidgets()
     )
-    pg.setConfigOptions(foreground="d" if theme == "dark" else "k")
+    pg.setConfigOptions(
+        foreground="d" if theme == "dark" else "k", background="k" if theme == "dark" else "w"
+    )
     for pg_widget in children:
         pg_widget.setBackground("k" if theme == "dark" else "w")
 
-    dark_mode_buttons = [
-        button
-        for button in app.topLevelWidgets()
-        if hasattr(button, "dark_mode_enabled")
-        and hasattr(button, "mode_button")
-        and isinstance(button.mode_button, (QPushButton, QToolButton))
-    ]
-
-    for button in dark_mode_buttons:
-        button.dark_mode_enabled = theme == "dark"
-        button.update_mode_button()
     # now define stylesheet according to theme and apply it
     style = bec_qthemes.load_stylesheet(theme)
     app.setStyleSheet(style)

bec_widgets/widgets/dark_mode_button/dark_mode_button.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from bec_qthemes import material_icon
 from qtpy.QtCore import Property, Qt, Slot
 from qtpy.QtWidgets import QApplication, QHBoxLayout, QPushButton, QToolButton, QWidget
@@ -18,7 +20,7 @@ class DarkModeButton(BECWidget, QWidget):
         gui_id: str | None = None,
         toolbar: bool = False,
     ) -> None:
-        super().__init__(client=client, gui_id=gui_id)
+        super().__init__(client=client, gui_id=gui_id, theme_update=True)
         QWidget.__init__(self, parent)
 
         self._dark_mode_enabled = False
@@ -39,6 +41,17 @@ class DarkModeButton(BECWidget, QWidget):
         self.setLayout(self.layout)
         self.setFixedSize(40, 40)
 
+    @Slot(str)
+    def apply_theme(self, theme: str):
+        """
+        Apply the theme to the widget.
+
+        Args:
+            theme(str, optional): The theme to be applied.
+        """
+        self.dark_mode_enabled = theme == "dark"
+        self.update_mode_button()
+
     def _get_qapp_dark_mode_state(self) -> bool:
         """
         Get the dark mode state from the QApplication.

bec_widgets/widgets/figure/plots/plot_base.py

@@ -99,30 +99,32 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
 
         self.add_legend()
         self.crosshair = None
-        self.connect_to_theme_change()
-        self.apply_theme()
+        self._connect_to_theme_change()
 
-    def connect_to_theme_change(self):
+    def _connect_to_theme_change(self):
         """Connect to the theme change signal."""
         qapp = QApplication.instance()
         if hasattr(qapp, "theme_signal"):
-            qapp.theme_signal.theme_updated.connect(self.apply_theme)
+            qapp.theme_signal.theme_updated.connect(self._update_theme)
 
     @Slot(str)
-    @Slot()
-    def apply_theme(self, theme: str | None = None):
-        """
-        Apply the theme to the plot widget.
-
-        Args:
-            theme(str, optional): The theme to be applied.
-        """
+    def _update_theme(self, theme: str):
+        """Update the theme."""
         if theme is None:
             qapp = QApplication.instance()
             if hasattr(qapp, "theme"):
                 theme = qapp.theme["theme"]
             else:
                 theme = "dark"
+        self.apply_theme(theme)
+
+    def apply_theme(self, theme: str):
+        """
+        Apply the theme to the plot widget.
+
+        Args:
+            theme(str, optional): The theme to be applied.
+        """
         palette = bec_qthemes.load_palette(theme)
         text_pen = pg.mkPen(color=palette.text().color())
 

{bec_widgets-0.99.15.dist-info → bec_widgets-0.100.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.99.15
+Version: 0.100.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.99.15.dist-info → bec_widgets-0.100.0.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=HE_stq5wl-0wE5ZetfEmaaDbectk20jX7Z2cxwsBegg,8348
 .pylintrc,sha256=eeY8YwSI74oFfq6IYIbCqnx3Vk8ZncKaatv96n_Y8Rs,18544
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=_HCeY9bzET0OS8ksAlJtZPE2LccyFanuUVeUFjWVY4U,6695
+CHANGELOG.md,sha256=4klTHcSrZVAZ03F0WQ1nRQLwGgHsyFC3ZrYuz_X9HdE,6664
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=qo2aifx_l3H1ofv9U1qzWJ7Y-0Kahsy79VLTF36ncgY,1334
+PKG-INFO,sha256=lYGRB6sUQh1tCnb-JCVMuNj2wLacFwAud4ub2-tQsOQ,1334
 README.md,sha256=Od69x-RS85Hph0-WwWACwal4yUd67XkEn4APEfHhHFw,2649
-pyproject.toml,sha256=4zOaAOMO3mwmQh3XdEw776I_hGGc4Qjw8wM2DY61zek,2544
+pyproject.toml,sha256=5WM5Q3BsITnjKAY0Cij4nOk6WK8lTHot7e3wQVWbRfc,2544
 .git_hooks/pre-commit,sha256=n3RofIZHJl8zfJJIUomcMyYGFi_rwq4CC19z0snz3FI,286
 .gitlab/issue_templates/bug_report_template.md,sha256=gAuyEwl7XlnebBrkiJ9AqffSNOywmr8vygUFWKTuQeI,386
 .gitlab/issue_templates/documentation_update_template.md,sha256=FHLdb3TS_D9aL4CYZCjyXSulbaW5mrN2CmwTaeLPbNw,860
@@ -46,14 +46,14 @@ bec_widgets/qt_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hS
 bec_widgets/qt_utils/error_popups.py,sha256=y9gKKWaafp468ioHr96nBhf02ZpEgjDc-BAVOTWh-e8,7680
 bec_widgets/qt_utils/redis_message_waiter.py,sha256=fvL_QgC0cTDv_FPJdRyp5AKjf401EJU4z3r38p47ydY,1745
 bec_widgets/qt_utils/settings_dialog.py,sha256=NhtzTer_xzlB2lLLrGklkI1QYLJEWQpJoZbCz4o5daI,3645
-bec_widgets/qt_utils/toolbar.py,sha256=NhpXw5An2qNefv0iQdCyDUbkanPcsQoD_8vDOGhQEOs,8494
+bec_widgets/qt_utils/toolbar.py,sha256=oP1Lxos03MuwSTonPeILknHEXfZlKsuK13jrXoI2pck,8530
 bec_widgets/utils/__init__.py,sha256=1930ji1Jj6dVuY81Wd2kYBhHYNV-2R0bN_L4o9zBj1U,533
 bec_widgets/utils/bec_connector.py,sha256=SivHKXVyNVqeu3kCXYEPpbleTVw8g1cW0FKq1QrQgco,9987
 bec_widgets/utils/bec_designer.py,sha256=Z3MeMju-KmTz8POtm23VQfp4rvtD2sF6eIOKQkl2F7w,4729
 bec_widgets/utils/bec_dispatcher.py,sha256=NkObWO_gRO9Uobz-fy0gVTZqQsbFRaKj6fbjYZoErFI,6400
 bec_widgets/utils/bec_table.py,sha256=nA2b8ukSeUfquFMAxGrUVOqdrzMoDYD6O_4EYbOG2zk,717
-bec_widgets/utils/bec_widget.py,sha256=vMJy-mR0kmcGaI5u1WytEuIoTJfMEcgepxIpv8yVmHY,1113
-bec_widgets/utils/colors.py,sha256=YuExmqsu2sbaWE2RIYGjNaGfOwZV_SmPA08B9PXm6zw,12504
+bec_widgets/utils/bec_widget.py,sha256=ANFx-Ll5mjOjmILniTH5jKBITDijUtfFLb1eoiXoFws,2881
+bec_widgets/utils/colors.py,sha256=N3GbVBpExfC1m_dnYFDoua-iRLM90E5kTKVOIkZVmDM,12372
 bec_widgets/utils/container_utils.py,sha256=0wr3ZfuMiAFKCrQHVjxjw-Vuk8wsHdridqcjy2eY840,1531
 bec_widgets/utils/crosshair.py,sha256=8lik9k69WI2WMj5FGLbrKtny9duxqXUJAhpX8tHoyp0,11543
 bec_widgets/utils/entry_validator.py,sha256=3skJIsUwTYicT76AMHm_M78RiWtUgyD2zb-Rxo2HdHQ,1313
@@ -110,7 +110,7 @@ bec_widgets/widgets/colormap_selector/colormap_selector_plugin.py,sha256=c5Kk4do
 bec_widgets/widgets/colormap_selector/register_colormap_selector.py,sha256=bfw7RWmTmMLTLxGT-izSwcGtxGLKvL3jdivJw2z8oN4,512
 bec_widgets/widgets/console/console.py,sha256=NG0cBuqqPX4hC-sHhk_UEkT-nHhhN9Y7karJITPLzyo,17864
 bec_widgets/widgets/dark_mode_button/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/widgets/dark_mode_button/dark_mode_button.py,sha256=2mjLC6FiICy_xucxLlvwZPGinJoJYYDqdCbsAj1qtLs,2929
+bec_widgets/widgets/dark_mode_button/dark_mode_button.py,sha256=ZvCDO_FWtEn6M1Jxaw8x8GifsulJc2NsaXNvLKAKBs0,3259
 bec_widgets/widgets/dark_mode_button/dark_mode_button.pyproject,sha256=Lbi9zb6HNlIq14k6hlzR-oz6PIFShBuF7QxE6d87d64,34
 bec_widgets/widgets/dark_mode_button/dark_mode_button_plugin.py,sha256=RJWeBEqR9BueUxUSuPcU-AmnzfIzt3j4jtsIacp-2Ug,1335
 bec_widgets/widgets/dark_mode_button/register_dark_mode_button.py,sha256=_4Fw6j1KLuluko8X2B7zf_DT5eA07G0CqR-aRMAn0iA,489
@@ -143,7 +143,7 @@ bec_widgets/widgets/figure/figure.py,sha256=kd7enVkT7df79HWzYjCzAZ1qF8jtlzqNfo7Y
 bec_widgets/widgets/figure/plots/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/figure/plots/axis_settings.py,sha256=QxRpQwgfBr1H0HTjfOpiXi_-n8I0BaZhS8LRXNeVfFg,3544
 bec_widgets/widgets/figure/plots/axis_settings.ui,sha256=a2qIuK9lyi9HCyrSvPr6wxzmm1FymaWcpmyOhMIiFt8,11013
-bec_widgets/widgets/figure/plots/plot_base.py,sha256=VB_erv2ITXA87NpCcYtL-Y_tTnNb9Xoqt9Z7I8XQX0I,15078
+bec_widgets/widgets/figure/plots/plot_base.py,sha256=mCrQS9itby4jnwUGCQXqTQzGnP-yLZoyqI2flQvXsuc,15135
 bec_widgets/widgets/figure/plots/image/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/figure/plots/image/image.py,sha256=y2MqgJv6Njv-huDN_exn0Fq1rAh5vs_assKCKHgQH6I,24941
 bec_widgets/widgets/figure/plots/image/image_item.py,sha256=RljjbkqJEr2cKDlqj1j5GQ1h89jpqOV-OpFz1TbED8I,10937
@@ -238,8 +238,8 @@ bec_widgets/widgets/website/register_website_widget.py,sha256=LIQJpV9uqcBiPR9cEA
 bec_widgets/widgets/website/website.py,sha256=kDlqjwtx0yft1ZNRhTdHnYh_5KZHfqT_ZGPOKT4C-yI,2619
 bec_widgets/widgets/website/website_widget.pyproject,sha256=scOiV3cV1_BjbzpPzy2N8rIJL5P2qIZz8ObTJ-Uvdtg,25
 bec_widgets/widgets/website/website_widget_plugin.py,sha256=pz38_C2cZ0yvPPS02wdIPcmhFo_yiwUhflsASocAPQQ,1341
-bec_widgets-0.99.15.dist-info/METADATA,sha256=qo2aifx_l3H1ofv9U1qzWJ7Y-0Kahsy79VLTF36ncgY,1334
-bec_widgets-0.99.15.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-bec_widgets-0.99.15.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
-bec_widgets-0.99.15.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.99.15.dist-info/RECORD,,
+bec_widgets-0.100.0.dist-info/METADATA,sha256=lYGRB6sUQh1tCnb-JCVMuNj2wLacFwAud4ub2-tQsOQ,1334
+bec_widgets-0.100.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+bec_widgets-0.100.0.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
+bec_widgets-0.100.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.100.0.dist-info/RECORD,,

pyproject.toml

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