0.64.0

Automatically generated by python-semantic-release

CHANGELOG.md

@@ -1,6 +1,28 @@
 # CHANGELOG
 
+## v0.64.0 (2024-06-19)
 
+### Ci
+
+* ci: add job optional dependency check ([`27426ce`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/27426ce7a52b4cbad7f3bef114d6efe6ad73bd7f))
+
+### Documentation
+
+* docs: fix links in developer section ([`9e16f2f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9e16f2faf9c59a5d36ae878512c5a910cca31e69))
+
+* docs: refactor developer section, add widget tutorial ([`2a36d93`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2a36d9364f242bf42e4cda4b50e6f46aa3833bbd))
+
+### Feature
+
+* feat: add option to change size of the fonts ([`ea805d1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ea805d1362fc084d3b703b6f81b0180072f0825d))
+
+### Fix
+
+* fix(plot_base): font size is set with setScale which is scaling the whole legend window ([`5d66720`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5d6672069ea1cbceb62104f66c127e4e3c23e4a4))
+
+### Test
+
+* test: add tests ([`140ad83`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/140ad83380808928edf7953e23c762ab72a0a1e9))
 
 ## v0.63.2 (2024-06-14)
 
@@ -16,7 +38,6 @@ Like with QtWebEngine ([`6f96498`](https://gitlab.psi.ch/bec/bec_widgets/-/commi
 
 This reverts commit fe04dd80e59a0e74f7fdea603e0642707ecc7c2a. ([`836b6e6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/836b6e64f694916d6b6f909dedf11a4a6d2c86a4))
 
-
 ## v0.63.1 (2024-06-13)
 
 ### Fix
@@ -26,7 +47,6 @@ This reverts commit fe04dd80e59a0e74f7fdea603e0642707ecc7c2a. ([`836b6e6`](https
 The proper finalization sequence will be executed by the remote process
 on SIGTERM ([`9263f8e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9263f8ef5c17ae7a007a1a564baf787b39061756))
 
-
 ## v0.63.0 (2024-06-13)
 
 ### Documentation
@@ -51,7 +71,6 @@ on SIGTERM ([`9263f8e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9263f8ef5
 
 This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fe04dd80e59a0e74f7fdea603e0642707ecc7c2a))
 
-
 ## v0.62.0 (2024-06-12)
 
 ### Feature
@@ -62,7 +81,6 @@ This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https:
 
 * doc: add documentation about creating custom GUI applications embedding BEC Widgets ([`17a0068`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/17a00687579f5efab1990cd83862ec0e78198633))
 
-
 ## v0.61.0 (2024-06-12)
 
 ### Feature
@@ -73,7 +91,6 @@ This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https:
 
 * refactor: improve labe of auto_update script ([`40b5688`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/40b568815893cd41af3531bb2e647ca1e2e315f4))
 
-
 ## v0.60.0 (2024-06-08)
 
 ### Ci
@@ -116,14 +133,12 @@ This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https:
 
 * test: added missing pylint statement to header ([`f662985`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f6629852ebc2b4ee239fa560cc310a5ae2627cf7))
 
-
 ## v0.59.1 (2024-06-07)
 
 ### Fix
 
 * fix(curve): set_color_map_z typo fixed in user access ([`e7838b0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e7838b0f2fc23b0a232ed7d68fbd7f3493a91b9e))
 
-
 ## v0.59.0 (2024-06-07)
 
 ### Build
@@ -144,33 +159,10 @@ This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https:
 
 * feat(widget): added simple website widget with rpc ([`64abd67`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/64abd67b9b416bff9c89880b248d6e8639aa1e70))
 
-
 ## v0.58.1 (2024-06-07)
 
 ### Fix
 
 * fix(dock): new dock can be detached upon creation ([`02a2608`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/02a26086c4540127a11c235cba30afc4fd712007))
 
-
 ## v0.58.0 (2024-06-07)
-
-### Feature
-
-* feat(utils.colors): general color validators ([`3094632`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/30946321348abc349fb4003dc39d0232dc19606c))
-
-### Fix
-
-* fix: bar colormap dynamic setting ([`67fd5e8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/67fd5e8581f60fe64027ac57f1f12cefa4d28343))
-
-* fix: formatting isort ([`bf699ec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/bf699ec1fbe2aacd31854e84fb0438c336840fcf))
-
-* fix(curve): 2D scatter updated if color_map_z is changed ([`6985ff0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6985ff0fcef9791b53198206ec8cbccd1d65ef99))
-
-* fix(curve): color_map_z setting works ([`33f7be4`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/33f7be42c512402dab3fdd9781a8234e3ec5f4ba))
-
-### Test
-
-* test(color): validation tests added ([`c0ddece`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c0ddeceeeabacbf33019a8f24b18821926dc17ac))
-
-
-## v0.57.7 (2024-06-07)

bec_widgets/cli/client.py

@@ -1044,33 +1044,37 @@ class BECImageShow(RPCBase):
             - y_scale: Literal["linear", "log"]
             - x_lim: tuple
             - y_lim: tuple
+            - legend_label_size: int
         """
 
     @rpc_call
-    def set_title(self, title: "str"):
+    def set_title(self, title: "str", size: "int" = None):
         """
         Set the title of the plot widget.
 
         Args:
             title(str): Title of the plot widget.
+            size(int): Font size of the title.
         """
 
     @rpc_call
-    def set_x_label(self, label: "str"):
+    def set_x_label(self, label: "str", size: "int" = None):
         """
         Set the label of the x-axis.
 
         Args:
             label(str): Label of the x-axis.
+            size(int): Font size of the label.
         """
 
     @rpc_call
-    def set_y_label(self, label: "str"):
+    def set_y_label(self, label: "str", size: "int" = None):
         """
         Set the label of the y-axis.
 
         Args:
             label(str): Label of the y-axis.
+            size(int): Font size of the label.
         """
 
     @rpc_call
@@ -1268,33 +1272,37 @@ class BECPlotBase(RPCBase):
             - y_scale: Literal["linear", "log"]
             - x_lim: tuple
             - y_lim: tuple
+            - legend_label_size: int
         """
 
     @rpc_call
-    def set_title(self, title: "str"):
+    def set_title(self, title: "str", size: "int" = None):
         """
         Set the title of the plot widget.
 
         Args:
             title(str): Title of the plot widget.
+            size(int): Font size of the title.
         """
 
     @rpc_call
-    def set_x_label(self, label: "str"):
+    def set_x_label(self, label: "str", size: "int" = None):
         """
         Set the label of the x-axis.
 
         Args:
             label(str): Label of the x-axis.
+            size(int): Font size of the label.
         """
 
     @rpc_call
-    def set_y_label(self, label: "str"):
+    def set_y_label(self, label: "str", size: "int" = None):
         """
         Set the label of the y-axis.
 
         Args:
             label(str): Label of the y-axis.
+            size(int): Font size of the label.
         """
 
     @rpc_call
@@ -1370,6 +1378,15 @@ class BECPlotBase(RPCBase):
         Remove the plot widget from the figure.
         """
 
+    @rpc_call
+    def set_legend_label_size(self, size: "int" = None):
+        """
+        Set the font size of the legend.
+
+        Args:
+            size(int): Font size of the legend.
+        """
+
 
 class BECWaveform(RPCBase):
     @property
@@ -1516,33 +1533,37 @@ class BECWaveform(RPCBase):
             - y_scale: Literal["linear", "log"]
             - x_lim: tuple
             - y_lim: tuple
+            - legend_label_size: int
         """
 
     @rpc_call
-    def set_title(self, title: "str"):
+    def set_title(self, title: "str", size: "int" = None):
         """
         Set the title of the plot widget.
 
         Args:
             title(str): Title of the plot widget.
+            size(int): Font size of the title.
         """
 
     @rpc_call
-    def set_x_label(self, label: "str"):
+    def set_x_label(self, label: "str", size: "int" = None):
         """
         Set the label of the x-axis.
 
         Args:
             label(str): Label of the x-axis.
+            size(int): Font size of the label.
         """
 
     @rpc_call
-    def set_y_label(self, label: "str"):
+    def set_y_label(self, label: "str", size: "int" = None):
         """
         Set the label of the y-axis.
 
         Args:
             label(str): Label of the y-axis.
+            size(int): Font size of the label.
         """
 
     @rpc_call
@@ -1618,6 +1639,15 @@ class BECWaveform(RPCBase):
         Remove the plot widget from the figure.
         """
 
+    @rpc_call
+    def set_legend_label_size(self, size: "int" = None):
+        """
+        Set the font size of the legend.
+
+        Args:
+            size(int): Font size of the legend.
+        """
+
 
 class Ring(RPCBase):
     @rpc_call

bec_widgets/widgets/figure/figure.py

@@ -711,6 +711,12 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         qdarktheme.setup_theme(theme)
         self.setBackground("k" if theme == "dark" else "w")
         self.config.theme = theme
+        for plot in self.widget_list:
+            plot.set_x_label(plot.plot_item.getAxis("bottom").label.toPlainText())
+            plot.set_y_label(plot.plot_item.getAxis("left").label.toPlainText())
+            if plot.plot_item.titleLabel.text:
+                plot.set_title(plot.plot_item.titleLabel.text)
+            plot.set_legend_label_size()
 
     def _remove_by_coordinates(self, row: int, col: int) -> None:
         """

bec_widgets/widgets/figure/plots/plot_base.py

@@ -5,6 +5,8 @@ from typing import Literal, Optional
 import numpy as np
 import pyqtgraph as pg
 from pydantic import BaseModel, Field
+from qtpy import QT_VERSION
+from qtpy.QtGui import QFont, QFontDatabase, QFontInfo
 from qtpy.QtWidgets import QWidget
 
 from bec_widgets.utils import BECConnector, ConnectionConfig
@@ -12,8 +14,14 @@ from bec_widgets.utils import BECConnector, ConnectionConfig
 
 class AxisConfig(BaseModel):
     title: Optional[str] = Field(None, description="The title of the axes.")
+    title_size: Optional[int] = Field(None, description="The font size of the title.")
     x_label: Optional[str] = Field(None, description="The label for the x-axis.")
+    x_label_size: Optional[int] = Field(None, description="The font size of the x-axis label.")
     y_label: Optional[str] = Field(None, description="The label for the y-axis.")
+    y_label_size: Optional[int] = Field(None, description="The font size of the y-axis label.")
+    legend_label_size: Optional[int] = Field(
+        None, description="The font size of the legend labels."
+    )
     x_scale: Literal["linear", "log"] = Field("linear", description="The scale of the x-axis.")
     y_scale: Literal["linear", "log"] = Field("linear", description="The scale of the y-axis.")
     x_lim: Optional[tuple] = Field(None, description="The limits of the x-axis.")
@@ -50,6 +58,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
         "set_grid",
         "lock_aspect_ratio",
         "remove",
+        "set_legend_label_size",
     ]
 
     def __init__(
@@ -85,6 +94,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
             - y_scale: Literal["linear", "log"]
             - x_lim: tuple
             - y_lim: tuple
+            - legend_label_size: int
         """
         # Mapping of keywords to setter methods
         method_map = {
@@ -95,6 +105,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
             "y_scale": self.set_y_scale,
             "x_lim": self.set_x_lim,
             "y_lim": self.set_y_lim,
+            "legend_label_size": self.set_legend_label_size,
         }
         for key, value in kwargs.items():
             if key in method_map:
@@ -116,34 +127,79 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
 
         self.set(**{k: v for k, v in config_mappings.items() if v is not None})
 
-    def set_title(self, title: str):
+    def set_legend_label_size(self, size: int = None):
+        """
+        Set the font size of the legend.
+
+        Args:
+            size(int): Font size of the legend.
+        """
+        if not self.plot_item.legend:
+            return
+        if self.config.axis.legend_label_size or size:
+            if size:
+                self.config.axis.legend_label_size = size
+                scale = (
+                    size / 9
+                )  # 9 is the default font size of the legend, so we always scale it against 9
+                self.plot_item.legend.setScale(scale)
+
+    def get_text_color(self):
+        return "#FFF" if self.figure.config.theme == "dark" else "#000"
+
+    def set_title(self, title: str, size: int = None):
         """
         Set the title of the plot widget.
 
         Args:
             title(str): Title of the plot widget.
+            size(int): Font size of the title.
         """
-        self.plot_item.setTitle(title)
+        if self.config.axis.title_size or size:
+            if size:
+                self.config.axis.title_size = size
+            style = {"color": self.get_text_color(), "size": f"{self.config.axis.title_size}pt"}
+        else:
+            style = {}
+        self.plot_item.setTitle(title, **style)
         self.config.axis.title = title
 
-    def set_x_label(self, label: str):
+    def set_x_label(self, label: str, size: int = None):
         """
         Set the label of the x-axis.
 
         Args:
             label(str): Label of the x-axis.
+            size(int): Font size of the label.
         """
-        self.plot_item.setLabel("bottom", label)
+        if self.config.axis.x_label_size or size:
+            if size:
+                self.config.axis.x_label_size = size
+            style = {
+                "color": self.get_text_color(),
+                "font-size": f"{self.config.axis.x_label_size}pt",
+            }
+        else:
+            style = {}
+        self.plot_item.setLabel("bottom", label, **style)
         self.config.axis.x_label = label
 
-    def set_y_label(self, label: str):
+    def set_y_label(self, label: str, size: int = None):
         """
         Set the label of the y-axis.
 
         Args:
             label(str): Label of the y-axis.
+            size(int): Font size of the label.
         """
-        self.plot_item.setLabel("left", label)
+        if self.config.axis.y_label_size or size:
+            if size:
+                self.config.axis.y_label_size = size
+            color = self.get_text_color()
+            style = {"color": color, "font-size": f"{self.config.axis.y_label_size}pt"}
+        else:
+            style = {}
+        self.plot_item.setLabel("left", label, **style)
         self.config.axis.y_label = label
 
     def set_x_scale(self, scale: Literal["linear", "log"] = "linear"):

bec_widgets/widgets/figure/plots/waveform/waveform.py

@@ -54,6 +54,7 @@ class BECWaveform(BECPlotBase):
         "set_grid",
         "lock_aspect_ratio",
         "remove",
+        "set_legend_label_size",
     ]
     scan_signal_update = pyqtSignal()
 
@@ -401,6 +402,7 @@ class BECWaveform(BECPlotBase):
         self.config.curves[name] = curve.config
         if data is not None:
             curve.setData(data[0], data[1])
+        self.set_legend_label_size()
         return curve
 
     def _validate_signal_entries(

pyproject.toml

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

tests/unit_tests/test_plot_base.py

@@ -1,5 +1,8 @@
 # pylint: disable=missing-function-docstring, missing-module-docstring, unused-import
+from unittest import mock
+
 import pytest
+from qtpy.QtGui import QFontInfo
 
 from .client_mocks import mocked_client
 from .test_bec_figure import bec_figure
@@ -37,6 +40,30 @@ def test_plot_base_axes_by_separate_methods(bec_figure):
     assert plot_base.plot_item.ctrl.logXCheck.isChecked() == True
     assert plot_base.plot_item.ctrl.logYCheck.isChecked() == True
 
+    # Check the font size by mocking the set functions
+    # I struggled retrieving it from the QFont object directly
+    # thus I mocked the set functions to check internally the functionality
+    with (
+        mock.patch.object(plot_base.plot_item, "setLabel") as mock_set_label,
+        mock.patch.object(plot_base.plot_item, "setTitle") as mock_set_title,
+    ):
+        plot_base.set_x_label("Test x Label", 20)
+        plot_base.set_y_label("Test y Label", 16)
+        assert mock_set_label.call_count == 2
+        assert plot_base.config.axis.x_label_size == 20
+        assert plot_base.config.axis.y_label_size == 16
+        col = plot_base.get_text_color()
+        calls = []
+        style = {"color": col, "font-size": "20pt"}
+        calls.append(mock.call("bottom", "Test x Label", **style))
+        style = {"color": col, "font-size": "16pt"}
+        calls.append(mock.call("left", "Test y Label", **style))
+        assert mock_set_label.call_args_list == calls
+        plot_base.set_title("Test Title", 16)
+        style = {"color": col, "size": "16pt"}
+        call = mock.call("Test Title", **style)
+        assert mock_set_title.call_args == call
+
 
 def test_plot_base_axes_added_by_kwargs(bec_figure):
     plot_base = bec_figure.add_widget(widget_type="PlotBase", widget_id="test_plot")

tests/unit_tests/test_waveform1d.py

@@ -1,5 +1,5 @@
 # pylint: disable=missing-function-docstring, missing-module-docstring, unused-import
-from unittest.mock import MagicMock
+from unittest import mock
 
 import numpy as np
 import pytest
@@ -56,8 +56,12 @@ def test_create_waveform1D_by_config(bec_figure):
         "col": 0,
         "axis": {
             "title": "Widget 1",
+            "title_size": None,
             "x_label": None,
+            "x_label_size": None,
             "y_label": None,
+            "y_label_size": None,
+            "legend_label_size": None,
             "x_scale": "linear",
             "y_scale": "linear",
             "x_lim": (1, 10),
@@ -193,6 +197,18 @@ def test_add_curve(bec_figure):
     assert c1.config.source == "scan_segment"
 
 
+def test_change_legend_font_size(bec_figure):
+    plot = bec_figure.add_plot()
+
+    w1 = plot.add_curve_scan(x_name="samx", y_name="bpm4i")
+    my_func = plot.plot_item.legend
+    with mock.patch.object(my_func, "setScale") as mock_set_scale:
+        plot.set_legend_label_size(18)
+        assert plot.config.axis.legend_label_size == 18
+        assert mock_set_scale.call_count == 1
+        assert mock_set_scale.call_args == mock.call(2)
+
+
 def test_remove_curve(bec_figure):
     w1 = bec_figure.add_plot()
 
@@ -406,10 +422,10 @@ def test_scan_update(bec_figure, qtbot):
         "scan_id": 1,
     }
     # Mock scan_storage.find_scan_by_ID
-    mock_scan_data_waveform = MagicMock()
+    mock_scan_data_waveform = mock.MagicMock()
     mock_scan_data_waveform.data = {
         device_name: {
-            entry: MagicMock(val=[msg_waveform["data"][device_name][entry]["value"]])
+            entry: mock.MagicMock(val=[msg_waveform["data"][device_name][entry]["value"]])
             for entry in msg_waveform["data"][device_name]
         }
         for device_name in msg_waveform["data"]
@@ -430,12 +446,12 @@ def test_scan_history_with_val_access(bec_figure, qtbot):
     c1 = w1.add_curve_scan(x_name="samx", y_name="bpm4i")
 
     mock_scan_data = {
-        "samx": {"samx": MagicMock(val=np.array([1, 2, 3]))},  # Use MagicMock for .val
-        "bpm4i": {"bpm4i": MagicMock(val=np.array([4, 5, 6]))},  # Use MagicMock for .val
+        "samx": {"samx": mock.MagicMock(val=np.array([1, 2, 3]))},  # Use mock.MagicMock for .val
+        "bpm4i": {"bpm4i": mock.MagicMock(val=np.array([4, 5, 6]))},  # Use mock.MagicMock for .val
     }
 
-    mock_scan_storage = MagicMock()
-    mock_scan_storage.find_scan_by_ID.return_value = MagicMock(data=mock_scan_data)
+    mock_scan_storage = mock.MagicMock()
+    mock_scan_storage.find_scan_by_ID.return_value = mock.MagicMock(data=mock_scan_data)
     w1.queue.scan_storage = mock_scan_storage
 
     fake_scan_id = "fake_scan_id"
@@ -464,10 +480,10 @@ def test_scatter_2d_update(bec_figure, qtbot):
     }
     msg_metadata = {"scan_name": "line_scan"}
 
-    mock_scan_data = MagicMock()
+    mock_scan_data = mock.MagicMock()
     mock_scan_data.data = {
         device_name: {
-            entry: MagicMock(val=msg["data"][device_name][entry]["value"])
+            entry: mock.MagicMock(val=msg["data"][device_name][entry]["value"])
             for entry in msg["data"][device_name]
         }
         for device_name in msg["data"]