bec-widgets 0.99.8__py3-none-any.whl → 0.99.9__py3-none-any.whl

tests/unit_tests/test_bec_figure.py

@@ -1,270 +0,0 @@
-# pylint: disable=missing-function-docstring, missing-module-docstring, unused-import
-
-import numpy as np
-import pytest
-
-from bec_widgets.widgets.figure import BECFigure
-from bec_widgets.widgets.figure.plots.image.image import BECImageShow
-from bec_widgets.widgets.figure.plots.motor_map.motor_map import BECMotorMap
-from bec_widgets.widgets.figure.plots.waveform.waveform import BECWaveform
-
-from .client_mocks import mocked_client
-from .conftest import create_widget
-
-
-def test_bec_figure_init(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    assert bec_figure is not None
-    assert bec_figure.client is not None
-    assert isinstance(bec_figure, BECFigure)
-    assert bec_figure.config.widget_class == "BECFigure"
-
-
-def test_bec_figure_init_with_config(mocked_client):
-    config = {"widget_class": "BECFigure", "gui_id": "test_gui_id", "theme": "dark"}
-    widget = BECFigure(client=mocked_client, config=config)
-    assert widget.config.gui_id == "test_gui_id"
-    assert widget.config.theme == "dark"
-
-
-def test_bec_figure_add_remove_plot(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    initial_count = len(bec_figure._widgets)
-
-    # Adding 3 widgets -  2 WaveformBase and 1 PlotBase
-    w0 = bec_figure.plot(new=True)
-    w1 = bec_figure.plot(new=True)
-    w2 = bec_figure.add_widget(widget_type="BECPlotBase")
-
-    # Check if the widgets were added
-    assert len(bec_figure._widgets) == initial_count + 3
-    assert w0.gui_id in bec_figure._widgets
-    assert w1.gui_id in bec_figure._widgets
-    assert w2.gui_id in bec_figure._widgets
-    assert bec_figure._widgets[w0.gui_id].config.widget_class == "BECWaveform"
-    assert bec_figure._widgets[w1.gui_id].config.widget_class == "BECWaveform"
-    assert bec_figure._widgets[w2.gui_id].config.widget_class == "BECPlotBase"
-
-    # Check accessing positions by the grid in figure
-    assert bec_figure[0, 0] == w0
-    assert bec_figure[1, 0] == w1
-    assert bec_figure[2, 0] == w2
-
-    # Removing 1 widget
-    bec_figure.remove(widget_id=w0.gui_id)
-    assert len(bec_figure._widgets) == initial_count + 2
-    assert w0.gui_id not in bec_figure._widgets
-    assert w2.gui_id in bec_figure._widgets
-    assert bec_figure._widgets[w1.gui_id].config.widget_class == "BECWaveform"
-
-
-def test_add_different_types_of_widgets(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    plt = bec_figure.plot(x_name="samx", y_name="bpm4i")
-    im = bec_figure.image("eiger")
-    motor_map = bec_figure.motor_map("samx", "samy")
-
-    assert plt.__class__ == BECWaveform
-    assert im.__class__ == BECImageShow
-    assert motor_map.__class__ == BECMotorMap
-
-
-def test_access_widgets_access_errors(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    bec_figure.plot(row=0, col=0)
-
-    # access widget by non-existent coordinates
-    with pytest.raises(ValueError) as excinfo:
-        bec_figure[0, 2]
-        assert "No widget at coordinates (0, 2)" in str(excinfo.value)
-
-    # access widget by non-existent widget_id
-    with pytest.raises(KeyError) as excinfo:
-        bec_figure["non_existent_widget"]
-        assert "Widget with id 'non_existent_widget' not found" in str(excinfo.value)
-
-    # access widget by wrong type
-    with pytest.raises(TypeError) as excinfo:
-        bec_figure[1.2]
-        assert (
-            "Key must be a string (widget id) or a tuple of two integers (grid coordinates)"
-            in str(excinfo.value)
-        )
-
-
-def test_add_plot_to_occupied_position(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    bec_figure.plot(row=0, col=0)
-
-    with pytest.raises(ValueError) as excinfo:
-        bec_figure.plot(row=0, col=0, new=True)
-        assert "Position at row 0 and column 0 is already occupied." in str(excinfo.value)
-
-
-def test_remove_plots(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    w1 = bec_figure.plot(row=0, col=0)
-    w2 = bec_figure.plot(row=0, col=1)
-    w3 = bec_figure.plot(row=1, col=0)
-    w4 = bec_figure.plot(row=1, col=1)
-
-    assert bec_figure[0, 0] == w1
-    assert bec_figure[0, 1] == w2
-    assert bec_figure[1, 0] == w3
-    assert bec_figure[1, 1] == w4
-
-    # remove by coordinates
-    bec_figure[0, 0].remove()
-    assert w1.gui_id not in bec_figure._widgets
-
-    # remove by widget_id
-    bec_figure.remove(widget_id=w2.gui_id)
-    assert w2.gui_id not in bec_figure._widgets
-
-    # remove by widget object
-    w3.remove()
-    assert w3.gui_id not in bec_figure._widgets
-
-    # check the remaining widget 4
-    assert bec_figure[0, 0] == w4
-    assert bec_figure[w4.gui_id] == w4
-    assert w4.gui_id in bec_figure._widgets
-    assert len(bec_figure._widgets) == 1
-
-
-def test_remove_plots_by_coordinates_ints(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    w1 = bec_figure.plot(row=0, col=0)
-    w2 = bec_figure.plot(row=0, col=1)
-
-    bec_figure.remove(row=0, col=0)
-    assert w1.gui_id not in bec_figure._widgets
-    assert w2.gui_id in bec_figure._widgets
-    assert bec_figure[0, 0] == w2
-    assert len(bec_figure._widgets) == 1
-
-
-def test_remove_plots_by_coordinates_tuple(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    w1 = bec_figure.plot(row=0, col=0)
-    w2 = bec_figure.plot(row=0, col=1)
-
-    bec_figure.remove(coordinates=(0, 0))
-    assert w1.gui_id not in bec_figure._widgets
-    assert w2.gui_id in bec_figure._widgets
-    assert bec_figure[0, 0] == w2
-    assert len(bec_figure._widgets) == 1
-
-
-def test_remove_plot_by_id_error(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    bec_figure.plot()
-
-    with pytest.raises(ValueError) as excinfo:
-        bec_figure.remove(widget_id="non_existent_widget")
-        assert "Widget with ID 'non_existent_widget' does not exist." in str(excinfo.value)
-
-
-def test_remove_plot_by_coordinates_error(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    bec_figure.plot(row=0, col=0)
-
-    with pytest.raises(ValueError) as excinfo:
-        bec_figure.remove(0, 1)
-        assert "No widget at coordinates (0, 1)" in str(excinfo.value)
-
-
-def test_remove_plot_by_providing_nothing(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    bec_figure.plot(row=0, col=0)
-
-    with pytest.raises(ValueError) as excinfo:
-        bec_figure.remove()
-        assert "Must provide either widget_id or coordinates for removal." in str(excinfo.value)
-
-
-# def test_change_theme(bec_figure): #TODO do no work at python 3.12
-#     bec_figure.change_theme("dark")
-#     assert bec_figure.config.theme == "dark"
-#     assert bec_figure.backgroundBrush().color().name() == "#000000"
-#     bec_figure.change_theme("light")
-#     assert bec_figure.config.theme == "light"
-#     assert bec_figure.backgroundBrush().color().name() == "#ffffff"
-#     bec_figure.change_theme("dark")
-#     assert bec_figure.config.theme == "dark"
-#     assert bec_figure.backgroundBrush().color().name() == "#000000"
-
-
-def test_change_layout(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    w1 = bec_figure.plot(row=0, col=0)
-    w2 = bec_figure.plot(row=0, col=1)
-    w3 = bec_figure.plot(row=1, col=0)
-    w4 = bec_figure.plot(row=1, col=1)
-
-    bec_figure.change_layout(max_columns=1)
-
-    assert np.shape(bec_figure.grid) == (4, 1)
-    assert bec_figure[0, 0] == w1
-    assert bec_figure[1, 0] == w2
-    assert bec_figure[2, 0] == w3
-    assert bec_figure[3, 0] == w4
-
-    bec_figure.change_layout(max_rows=1)
-
-    assert np.shape(bec_figure.grid) == (1, 4)
-    assert bec_figure[0, 0] == w1
-    assert bec_figure[0, 1] == w2
-    assert bec_figure[0, 2] == w3
-    assert bec_figure[0, 3] == w4
-
-
-def test_clear_all(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    bec_figure.plot(row=0, col=0)
-    bec_figure.plot(row=0, col=1)
-    bec_figure.plot(row=1, col=0)
-    bec_figure.plot(row=1, col=1)
-
-    bec_figure.clear_all()
-
-    assert len(bec_figure._widgets) == 0
-    assert np.shape(bec_figure.grid) == (0,)
-
-
-def test_shortcuts(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    plt = bec_figure.plot(x_name="samx", y_name="bpm4i")
-    im = bec_figure.image("eiger")
-    motor_map = bec_figure.motor_map("samx", "samy")
-
-    assert plt.config.widget_class == "BECWaveform"
-    assert plt.__class__ == BECWaveform
-    assert im.config.widget_class == "BECImageShow"
-    assert im.__class__ == BECImageShow
-    assert motor_map.config.widget_class == "BECMotorMap"
-    assert motor_map.__class__ == BECMotorMap
-
-
-def test_plot_access_factory(qtbot, mocked_client):
-    bec_figure = create_widget(qtbot, BECFigure, client=mocked_client)
-    plt_00 = bec_figure.plot(x_name="samx", y_name="bpm4i")
-    plt_01 = bec_figure.plot(x_name="samx", y_name="bpm4i", row=0, col=1)
-    plt_10 = bec_figure.plot(new=True)
-
-    assert bec_figure.widget_list[0] == plt_00
-    assert bec_figure.widget_list[1] == plt_01
-    assert bec_figure.widget_list[2] == plt_10
-    assert bec_figure.axes(row=0, col=0) == plt_00
-    assert bec_figure.axes(row=0, col=1) == plt_01
-    assert bec_figure.axes(row=1, col=0) == plt_10
-
-    assert len(plt_00.curves) == 1
-    assert len(plt_01.curves) == 1
-    assert len(plt_10.curves) == 0
-
-    # update plt_00
-    bec_figure.plot(x_name="samx", y_name="bpm3a")
-    bec_figure.plot(x=[1, 2, 3], y=[1, 2, 3], row=0, col=0)
-
-    assert len(plt_00.curves) == 3

tests/unit_tests/test_bec_image.py

@@ -1,63 +0,0 @@
-# pylint: disable=missing-function-docstring, missing-module-docstring, unused-import
-from unittest import mock
-
-import numpy as np
-import pytest
-from bec_lib import messages
-from qtpy.QtGui import QFontInfo
-
-from bec_widgets.widgets.figure import BECFigure
-
-from .client_mocks import mocked_client
-from .conftest import create_widget
-
-
-@pytest.fixture
-def bec_image_show(bec_figure):
-    yield bec_figure.image("eiger")
-
-
-def test_on_image_update(qtbot, mocked_client):
-    bec_image_show = create_widget(qtbot, BECFigure, client=mocked_client).image("eiger")
-    data = np.random.rand(100, 100)
-    msg = messages.DeviceMonitor2DMessage(device="eiger", data=data, metadata={"scan_id": "12345"})
-    bec_image_show.on_image_update(msg.content, msg.metadata)
-    img = bec_image_show.images[0]
-    assert np.array_equal(img.get_data(), data)
-
-
-def test_autorange_on_image_update(qtbot, mocked_client):
-    bec_image_show = create_widget(qtbot, BECFigure, client=mocked_client).image("eiger")
-    # Check if autorange mode "mean" works, should be default
-    data = np.random.rand(100, 100)
-    msg = messages.DeviceMonitor2DMessage(device="eiger", data=data, metadata={"scan_id": "12345"})
-    bec_image_show.on_image_update(msg.content, msg.metadata)
-    img = bec_image_show.images[0]
-    assert np.array_equal(img.get_data(), data)
-    vmin = max(np.mean(data) - 2 * np.std(data), 0)
-    vmax = np.mean(data) + 2 * np.std(data)
-    assert np.isclose(img.color_bar.getLevels(), (vmin, vmax), rtol=(1e-5, 1e-5)).all()
-    # Test general update with autorange True, mode "max"
-    bec_image_show.set_autorange_mode("max")
-    bec_image_show.on_image_update(msg.content, msg.metadata)
-    img = bec_image_show.images[0]
-    vmin = np.min(data)
-    vmax = np.max(data)
-    assert np.array_equal(img.get_data(), data)
-    assert np.isclose(img.color_bar.getLevels(), (vmin, vmax), rtol=(1e-5, 1e-5)).all()
-    # Change the input data, and switch to autorange False, colormap levels should stay untouched
-    data *= 100
-    msg = messages.DeviceMonitor2DMessage(device="eiger", data=data, metadata={"scan_id": "12345"})
-    bec_image_show.set_autorange(False)
-    bec_image_show.on_image_update(msg.content, msg.metadata)
-    img = bec_image_show.images[0]
-    assert np.array_equal(img.get_data(), data)
-    assert np.isclose(img.color_bar.getLevels(), (vmin, vmax), rtol=(1e-3, 1e-3)).all()
-    # Reactivate autorange, should now scale the new data
-    bec_image_show.set_autorange(True)
-    bec_image_show.set_autorange_mode("mean")
-    bec_image_show.on_image_update(msg.content, msg.metadata)
-    img = bec_image_show.images[0]
-    vmin = max(np.mean(data) - 2 * np.std(data), 0)
-    vmax = np.mean(data) + 2 * np.std(data)
-    assert np.isclose(img.color_bar.getLevels(), (vmin, vmax), rtol=(1e-5, 1e-5)).all()

tests/unit_tests/test_bec_image_widget.py

@@ -1,217 +0,0 @@
-from unittest.mock import MagicMock, patch
-
-import pyqtgraph as pg
-import pytest
-
-from bec_widgets.widgets.image.image_widget import BECImageWidget
-
-from .client_mocks import mocked_client
-
-
-@pytest.fixture
-def image_widget(qtbot, mocked_client):
-    widget = BECImageWidget(client=mocked_client())
-    widget.toolbar.widgets["monitor"].device_combobox.set_device_filter("FakeDevice")
-    qtbot.addWidget(widget)
-    qtbot.waitExposed(widget)
-    yield widget
-
-
-@pytest.fixture
-def mock_image(image_widget):
-    image_mock = MagicMock()
-    image_widget._image = image_mock
-    return image_mock
-
-
-def test_image_widget_init(image_widget):
-    assert image_widget is not None
-    assert image_widget.client is not None
-    assert isinstance(image_widget, BECImageWidget)
-    assert image_widget.config.widget_class == "BECImageWidget"
-    assert image_widget._image is not None
-
-    assert (
-        image_widget.toolbar.widgets["monitor"].device_combobox.config.device_filter == "FakeDevice"
-    )
-    assert image_widget.toolbar.widgets["drag_mode"].action.isChecked() == True
-    assert image_widget.toolbar.widgets["rectangle_mode"].action.isChecked() == False
-    assert image_widget.toolbar.widgets["auto_range"].action.isChecked() == False
-    assert image_widget.toolbar.widgets["auto_range_image"].action.isChecked() == True
-    assert image_widget.toolbar.widgets["FFT"].action.isChecked() == False
-    assert image_widget.toolbar.widgets["transpose"].action.isChecked() == False
-    assert image_widget.toolbar.widgets["log"].action.isChecked() == False
-
-
-###################################
-# Toolbar Actions
-###################################
-def test_toolbar_connect_action(image_widget, mock_image, qtbot):
-    combo = image_widget.toolbar.widgets["monitor"].device_combobox
-    combo.setCurrentText("eiger")
-    qtbot.wait(200)
-    assert combo.currentText() == "eiger"
-    action = image_widget.toolbar.widgets["connect"].action
-    action.trigger()
-    image_widget._image.image.assert_called_once_with(
-        monitor="eiger",
-        color_map="magma",
-        color_bar="full",
-        downsample=True,
-        opacity=1.0,
-        vrange=None,
-    )
-
-
-def test_image_toolbar_drag_mode_action_triggered(image_widget, qtbot):
-    action_drag = image_widget.toolbar.widgets["drag_mode"].action
-    action_rectangle = image_widget.toolbar.widgets["rectangle_mode"].action
-    action_drag.trigger()
-    assert action_drag.isChecked() == True
-    assert action_rectangle.isChecked() == False
-
-
-def test_image_toolbar_rectangle_mode_action_triggered(image_widget, qtbot):
-    action_drag = image_widget.toolbar.widgets["drag_mode"].action
-    action_rectangle = image_widget.toolbar.widgets["rectangle_mode"].action
-    action_rectangle.trigger()
-    assert action_drag.isChecked() == False
-    assert action_rectangle.isChecked() == True
-
-
-def test_image_toolbar_auto_range(image_widget, mock_image):
-    action = image_widget.toolbar.widgets["auto_range"].action
-    action.trigger()
-    image_widget._image.set_auto_range.assert_called_once_with(True, "xy")
-
-
-def test_image_toolbar_enable_mouse_pan_mode(qtbot, image_widget):
-    action_drag = image_widget.toolbar.widgets["drag_mode"].action
-    action_rectangle = image_widget.toolbar.widgets["rectangle_mode"].action
-
-    mock_view_box = MagicMock()
-    image_widget._image.plot_item.getViewBox = MagicMock(return_value=mock_view_box)
-
-    image_widget.enable_mouse_pan_mode()
-
-    assert action_drag.isChecked() == True
-    assert action_rectangle.isChecked() == False
-    mock_view_box.setMouseMode.assert_called_once_with(pg.ViewBox.PanMode)
-
-
-def test_image_toolbar_auto_range_image(image_widget, mock_image):
-    action = image_widget.toolbar.widgets["auto_range_image"].action
-    action.trigger()
-    assert action.isChecked() == False
-    image_widget._image.set_autorange.assert_called_once_with(False)
-
-
-def test_image_toolbar_FFT(image_widget, mock_image):
-    action = image_widget.toolbar.widgets["FFT"].action
-    action.trigger()
-    assert action.isChecked() == True
-    image_widget._image.set_fft.assert_called_once_with(True, None)
-
-
-def test_image_toolbar_log(image_widget, mock_image):
-    action = image_widget.toolbar.widgets["log"].action
-    action.trigger()
-    assert action.isChecked() == True
-    image_widget._image.set_log.assert_called_once_with(True, None)
-
-
-def test_image_toggle_transpose(image_widget, mock_image):
-    action = image_widget.toolbar.widgets["transpose"].action
-    action.trigger()
-    assert action.isChecked() == True
-    image_widget._image.set_transpose.assert_called_once_with(True, None)
-
-
-def test_image_toolbar_rotation(image_widget, mock_image):
-    action_left = image_widget.toolbar.widgets["rotate_left"].action
-    action_right = image_widget.toolbar.widgets["rotate_right"].action
-
-    action_left.trigger()
-    image_widget._image.set_rotation(1, None)
-    action_right.trigger()
-    image_widget._image.set_rotation(2, None)
-
-    action_right.trigger()
-    image_widget._image.set_rotation(1, None)
-
-
-###################################
-# Wrapper methods for ImageShow
-###################################
-
-
-def test_image_set_image(image_widget, mock_image):
-    image_widget.image(monitor="image")
-    image_widget._image.image.assert_called_once_with(
-        monitor="image",
-        color_map="magma",
-        color_bar="full",
-        downsample=True,
-        opacity=1.0,
-        vrange=None,
-    )
-
-
-def test_image_vrange(image_widget, mock_image):
-    image_widget.set_vrange(0, 1)
-    image_widget._image.set_vrange.assert_called_once_with(0, 1, None)
-
-
-def test_image_set_color_map(image_widget, mock_image):
-    image_widget.set_color_map("viridis")
-    image_widget._image.set_color_map.assert_called_once_with("viridis", None)
-
-
-def test_image_widget_set_title(image_widget, mock_image):
-    image_widget.set_title("Title Label")
-    image_widget._image.set_title.assert_called_once_with("Title Label")
-
-
-def test_image_widget_set_x_label(image_widget, mock_image):
-    image_widget.set_x_label("X Label")
-    image_widget._image.set_x_label.assert_called_once_with("X Label")
-
-
-def test_image_widget_set_y_label(image_widget, mock_image):
-    image_widget.set_y_label("Y Label")
-    image_widget._image.set_y_label.assert_called_once_with("Y Label")
-
-
-def test_image_widget_set_x_scale(image_widget, mock_image):
-    image_widget.set_x_scale("linear")
-    image_widget._image.set_x_scale.assert_called_once_with("linear")
-
-
-def test_image_widget_set_y_scale(image_widget, mock_image):
-    image_widget.set_y_scale("log")
-    image_widget._image.set_y_scale.assert_called_once_with("log")
-
-
-def test_image_widget_set_x_lim(image_widget, mock_image):
-    image_widget.set_x_lim((0, 10))
-    image_widget._image.set_x_lim.assert_called_once_with((0, 10))
-
-
-def test_image_widget_set_y_lim(image_widget, mock_image):
-    image_widget.set_y_lim((0, 10))
-    image_widget._image.set_y_lim.assert_called_once_with((0, 10))
-
-
-def test_image_widget_set_grid(image_widget, mock_image):
-    image_widget.set_grid(True, False)
-    image_widget._image.set_grid.assert_called_once_with(True, False)
-
-
-def test_image_widget_lock_aspect_ratio(image_widget, mock_image):
-    image_widget.lock_aspect_ratio(True)
-    image_widget._image.lock_aspect_ratio.assert_called_once_with(True)
-
-
-def test_image_widget_export(image_widget, mock_image):
-    image_widget.export()
-    image_widget._image.export.assert_called_once()