bec-widgets 0.82.1__py3-none-any.whl → 0.82.2__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v0.82.2 (2024-07-08)
+
+### Fix
+
+* fix(rpc_server): pass cli config to server ([`90178e2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/90178e2f61fa9dac7d82c0d0db40a9767bb133e6))
+
 ## v0.82.1 (2024-07-07)
 
 ### Fix
@@ -132,10 +138,6 @@
 
 ## v0.77.0 (2024-07-02)
 
-### Feature
-
-* feat(bec_connector): export config to yaml ([`a391f30`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a391f3018c50fee6a4a06884491b957df80c3cd3))
-
 ### Fix
 
 * fix(waveform): scatter 2D brush error ([`215d59c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/215d59c8bfe7fda9aff8cec8353bef9e1ce2eca1))
@@ -143,5 +145,3 @@
 * fix(figure): API cleanup ([`008a33a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/008a33a9b192473cc58e90cd6d98c5bcb5f7b8c0))
 
 * fix(figure): if/else logic corrected in subplot_factory ([`3e78723`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3e787234c7274b0698423d7bf9a4c54ec46bad5f))
-
-* fix(image): processing of already displayed data; closes #106 ([`1173510`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1173510105d2d70d7e498c2ac1e122cea3a16597))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.82.1
+Version: 0.82.2
 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/cli/client_utils.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import importlib
 import importlib.metadata as imd
+import json
 import os
 import select
 import subprocess
@@ -87,7 +88,7 @@ def _get_output(process, logger) -> None:
         print(f"Error reading process output: {str(e)}")
 
 
-def _start_plot_process(gui_id, gui_class, config, logger=None) -> None:
+def _start_plot_process(gui_id: str, gui_class: type, config: dict | str, logger=None) -> None:
     """
     Start the plot in a new process.
 
@@ -98,6 +99,8 @@ def _start_plot_process(gui_id, gui_class, config, logger=None) -> None:
     # pylint: disable=subprocess-run-check
     command = ["bec-gui-server", "--id", gui_id, "--gui_class", gui_class.__name__]
     if config:
+        if isinstance(config, dict):
+            config = json.dumps(config)
         command.extend(["--config", config])
 
     env_dict = os.environ.copy()
@@ -190,7 +193,7 @@ class BECGuiClientMixin:
         if self._process is None or self._process.poll() is not None:
             self._start_update_script()
             self._process, self._process_output_processing_thread = _start_plot_process(
-                self._gui_id, self.__class__, self._client._service_config.config_path
+                self._gui_id, self.__class__, self._client._service_config.config
             )
         while not self.gui_is_alive():
             print("Waiting for GUI to start...")

bec_widgets/cli/server.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import inspect
+import json
 import signal
 import sys
 from contextlib import redirect_stderr, redirect_stdout
@@ -141,10 +142,30 @@ class SimpleFileLikeFromLogOutputFunc:
         return
 
 
+def _start_server(gui_id: str, gui_class: Union[BECFigure, BECDockArea], config: str | None = None):
+    if config:
+        try:
+            config = json.loads(config)
+            service_config = ServiceConfig(config=config)
+        except (json.JSONDecodeError, TypeError):
+            service_config = ServiceConfig(config_path=config)
+    else:
+        # if no config is provided, use the default config
+        service_config = ServiceConfig()
+
+    bec_logger.configure(
+        service_config.redis,
+        QtRedisConnector,
+        service_name="BECWidgetsCLIServer",
+        service_config=service_config.service_config,
+    )
+    server = BECWidgetsCLIServer(gui_id=gui_id, config=service_config, gui_class=gui_class)
+    return server
+
+
 def main():
     import argparse
     import os
-    import sys
 
     from qtpy.QtCore import QSize
     from qtpy.QtGui import QIcon
@@ -159,7 +180,7 @@ def main():
         type=str,
         help="Name of the gui class to be rendered. Possible values: \n- BECFigure\n- BECDockArea",
     )
-    parser.add_argument("--config", type=str, help="Config file")
+    parser.add_argument("--config", type=str, help="Config file or config string.")
 
     args = parser.parse_args()
 
@@ -188,14 +209,7 @@ def main():
             win = QMainWindow()
             win.setWindowTitle("BEC Widgets")
 
-            service_config = ServiceConfig(args.config)
-            bec_logger.configure(
-                service_config.redis,
-                QtRedisConnector,
-                service_name="BECWidgetsCLIServer",
-                service_config=service_config.service_config,
-            )
-            server = BECWidgetsCLIServer(gui_id=args.id, config=service_config, gui_class=gui_class)
+            server = _start_server(args.id, gui_class, args.config)
 
             gui = server.gui
             win.setCentralWidget(gui)

{bec_widgets-0.82.1.dist-info → bec_widgets-0.82.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.82.1
+Version: 0.82.2
 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.82.1.dist-info → bec_widgets-0.82.2.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=vuDJPAYOK0995_H6fu0N5dIgIrOJgTvKr0HZkNWlxMw,8142
 .pylintrc,sha256=eeY8YwSI74oFfq6IYIbCqnx3Vk8ZncKaatv96n_Y8Rs,18544
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=51OXCmE8Hehc5TNpYDvNRXUi5tTewjqPN-MzOIpdoFY,6575
+CHANGELOG.md,sha256=7VVqe14x1w6butWm_Du8rzXRFtf3RQYV3CsURU1-uT0,6428
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=HDswJisHfyksMUD6G3xvmym8cQlpX85Mf6i16-m6jKM,1309
+PKG-INFO,sha256=9lGCW5x2H2CEYe7DJsHs1LlXB0Pn_hr7efNeRFUGzgo,1309
 README.md,sha256=Od69x-RS85Hph0-WwWACwal4yUd67XkEn4APEfHhHFw,2649
-pyproject.toml,sha256=BzRmQleEbvlRpmEbGMq6GfGWaVHIQMQxoqypM_B_yZ8,2358
+pyproject.toml,sha256=Jsa50E-GnKAaTBdJplPyg-B7sHQsIPL2GS-IHwugDFA,2358
 .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
@@ -18,11 +18,11 @@ bec_widgets/assets/terminal_icon.png,sha256=bJl7Tft4Fi2uxvuXI8o14uMHnI9eAWKSU2uf
 bec_widgets/cli/__init__.py,sha256=d0Q6Fn44e7wFfLabDOBxpcJ1DPKWlFunGYDUBmO-4hA,22
 bec_widgets/cli/auto_updates.py,sha256=DyBV3HnjMSH-cvVkYNcDiYKVf0Xut4Qy2qGQqkW47Bw,4833
 bec_widgets/cli/client.py,sha256=MMDy1edr1j9klgVGZZmD1dzLxi74gp75Jf4FNed9al8,60084
-bec_widgets/cli/client_utils.py,sha256=zq1gPW7t4n9Nsn4MLkdUeKwwl-9nUcf5UjuN8lZr9iY,12281
+bec_widgets/cli/client_utils.py,sha256=cDhabblwaP88a0jlVpbn_RWWKVbsyjhmmGtMh9gesEw,12388
 bec_widgets/cli/generate_cli.py,sha256=Ea5px9KblUlcGg-1JbJBTIU7laGg2n8PM7Efw9WVVzM,5889
 bec_widgets/cli/rpc_register.py,sha256=QxXUZu5XNg00Yf5O3UHWOXg3-f_pzKjjoZYMOa-MOJc,2216
 bec_widgets/cli/rpc_wigdet_handler.py,sha256=6kQng2DyS6rhLJqSJ7xa0kdgSxp-35A2upcf833dJRE,1483
-bec_widgets/cli/server.py,sha256=2EJvkQDzrDTsZjRPs7g2v_iPTspGqxzY34tRAnvjxjY,7281
+bec_widgets/cli/server.py,sha256=FZkqsjUHIkCUFMKUFm7ls_eslXvhIFzLpINEYxeWP5s,7722
 bec_widgets/examples/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/examples/jupyter_console/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/examples/jupyter_console/jupyter_console_window.py,sha256=oOVCTY68bAn9HDFd5W_xNqQhI7Nsm7TaqYYLqLWXo2w,5520
@@ -213,7 +213,7 @@ tests/unit_tests/test_bec_image.py,sha256=mjvcrHgOF_FCj6WbUyxvZH9HL63QGA5C0PNZ5d
 tests/unit_tests/test_bec_motor_map.py,sha256=dSYopbZS8lGD9cB26Kwmqw5zBoKCZs8t7DEEr50ug-g,8532
 tests/unit_tests/test_bec_queue.py,sha256=u-uc-iZeGAS8P90o6Cxy5oz_60zHpirGAu04OgQPDXw,4598
 tests/unit_tests/test_bec_status_box.py,sha256=gZdjyy9DNuUP9UwleTLj2Dp5HUImiqnkHjXWiqL0Q-o,4868
-tests/unit_tests/test_client_utils.py,sha256=eViJ1Tz-HX9TkMvQH6W8cO-c3_1I8bUc4_Yen6LOc0E,830
+tests/unit_tests/test_client_utils.py,sha256=CBdWIVJ_UiyFzTJnX3XJm4PGw2uXhFvRCP_Y9ifckbw,2630
 tests/unit_tests/test_color_validation.py,sha256=xbFbtFDia36XLgaNrX2IwvAX3IDC_Odpj5BGoJSgiIE,2389
 tests/unit_tests/test_crosshair.py,sha256=3OMAJ2ZaISYXMOtkXf1rPdy94vCr8njeLi6uHblBL9Q,5045
 tests/unit_tests/test_device_input_base.py,sha256=r1tI7BFAhpv7V7gf_n5gjusyrBFOfuCqIkdVg7YA7vY,2444
@@ -225,6 +225,7 @@ tests/unit_tests/test_plot_base.py,sha256=vWbt-QO5blSoE5C1392MIFha9A9JnUsx_D_9yT
 tests/unit_tests/test_plugin_utils.py,sha256=ayksWdrFY7kOiA0wVEjKFmFCF3UhH3lG8tzPVOpwysk,528
 tests/unit_tests/test_ring_progress_bar.py,sha256=hDlqkQho7FR7HAfM4Zrr4q1m773a3_rQ8CbM1GqDDSE,12252
 tests/unit_tests/test_rpc_register.py,sha256=hECjZEimd440mwRrO0rg7L3PKN7__3DgjmESN6wx3bo,1179
+tests/unit_tests/test_rpc_server.py,sha256=MvstcvqUsnGAzUxw8Et1xXXikk_VIxFPwDZD0v1QGkg,1500
 tests/unit_tests/test_rpc_widget_handler.py,sha256=ceQ3BPnBIFY2Hy-sDPw0wxxREVTTphILts0gvX9qoUw,234
 tests/unit_tests/test_scan_control.py,sha256=Wr6KcE8av4sEIOx5VgYbzVCem3Jgb4Kzx_oOuvwlmkE,13459
 tests/unit_tests/test_scan_control_group_box.py,sha256=HNqjP10B_NonikspNwKz9upJU-t7xf6hwBerNhbC-uo,5563
@@ -242,8 +243,8 @@ tests/unit_tests/test_configs/config_device_no_entry.yaml,sha256=hdvue9KLc_kfNzG
 tests/unit_tests/test_configs/config_scan.yaml,sha256=vo484BbWOjA_e-h6bTjSV9k7QaQHrlAvx-z8wtY-P4E,1915
 tests/unit_tests/test_msgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit_tests/test_msgs/available_scans_message.py,sha256=m_z97hIrjHXXMa2Ex-UvsPmTxOYXfjxyJaGkIY6StTY,46532
-bec_widgets-0.82.1.dist-info/METADATA,sha256=HDswJisHfyksMUD6G3xvmym8cQlpX85Mf6i16-m6jKM,1309
-bec_widgets-0.82.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-bec_widgets-0.82.1.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
-bec_widgets-0.82.1.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.82.1.dist-info/RECORD,,
+bec_widgets-0.82.2.dist-info/METADATA,sha256=9lGCW5x2H2CEYe7DJsHs1LlXB0Pn_hr7efNeRFUGzgo,1309
+bec_widgets-0.82.2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+bec_widgets-0.82.2.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
+bec_widgets-0.82.2.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.82.2.dist-info/RECORD,,

pyproject.toml

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

tests/unit_tests/test_client_utils.py

@@ -3,6 +3,7 @@ from unittest import mock
 import pytest
 
 from bec_widgets.cli.client import BECFigure
+from bec_widgets.cli.client_utils import BECGuiClientMixin, _start_plot_process
 
 from .client_mocks import FakeDevice
 
@@ -27,3 +28,49 @@ def test_rpc_call_accepts_device_as_input(cli_figure):
     fig, mock_rpc_call = cli_figure
     fig.plot(x_name=dev1, y_name=dev2)
     mock_rpc_call.assert_called_with("plot", x_name="samx", y_name="bpm4i")
+
+
+@pytest.mark.parametrize(
+    "config, call_config",
+    [
+        (None, None),
+        ("/path/to/config.yml", "/path/to/config.yml"),
+        ({"key": "value"}, '{"key": "value"}'),
+    ],
+)
+def test_client_utils_start_plot_process(config, call_config):
+    with mock.patch("bec_widgets.cli.client_utils.subprocess.Popen") as mock_popen:
+        _start_plot_process("gui_id", BECFigure, config)
+        command = ["bec-gui-server", "--id", "gui_id", "--gui_class", "BECFigure"]
+        if call_config:
+            command.extend(["--config", call_config])
+        mock_popen.assert_called_once_with(
+            command,
+            text=True,
+            start_new_session=True,
+            stdout=mock.ANY,
+            stderr=mock.ANY,
+            env=mock.ANY,
+        )
+
+
+def test_client_utils_passes_client_config_to_server(bec_dispatcher):
+    """
+    Test that the client config is passed to the server. This ensures that
+    changes to the client config (either through config files or plugins) are
+    reflected in the server.
+    """
+    mixin = BECGuiClientMixin()
+    mixin._client = bec_dispatcher.client
+    mixin._gui_id = "gui_id"
+    mixin.gui_is_alive = mock.MagicMock()
+    mixin.gui_is_alive.side_effect = [True]
+
+    with mock.patch("bec_widgets.cli.client_utils._start_plot_process") as mock_start_plot:
+        with mock.patch.object(mixin, "_start_update_script") as mock_start_update:
+            mock_start_plot.return_value = [mock.MagicMock(), mock.MagicMock()]
+            mixin.show()
+            mock_start_plot.assert_called_once_with(
+                "gui_id", BECGuiClientMixin, mixin._client._service_config.config
+            )
+            mock_start_update.assert_called_once()

tests/unit_tests/test_rpc_server.py

@@ -0,0 +1,42 @@
+from unittest import mock
+
+import pytest
+from bec_lib.service_config import ServiceConfig
+
+from bec_widgets.cli.server import _start_server
+from bec_widgets.widgets.figure import BECFigure
+
+
+@pytest.fixture
+def mocked_cli_server():
+    with mock.patch("bec_widgets.cli.server.BECWidgetsCLIServer") as mock_server:
+        with mock.patch("bec_widgets.cli.server.ServiceConfig") as mock_config:
+            with mock.patch("bec_lib.logger.bec_logger.configure") as mock_logger:
+                yield mock_server, mock_config, mock_logger
+
+
+def test_rpc_server_start_server_without_service_config(mocked_cli_server):
+    """
+    Test that the server is started with the correct arguments.
+    """
+    mock_server, mock_config, _ = mocked_cli_server
+
+    _start_server("gui_id", BECFigure, None)
+    mock_server.assert_called_once_with(gui_id="gui_id", config=mock_config(), gui_class=BECFigure)
+
+
+@pytest.mark.parametrize(
+    "config, call_config",
+    [
+        ("/path/to/config.yml", {"config_path": "/path/to/config.yml"}),
+        ({"key": "value"}, {"config": {"key": "value"}}),
+    ],
+)
+def test_rpc_server_start_server_with_service_config(mocked_cli_server, config, call_config):
+    """
+    Test that the server is started with the correct arguments.
+    """
+    mock_server, mock_config, _ = mocked_cli_server
+    config = mock_config(**call_config)
+    _start_server("gui_id", BECFigure, config)
+    mock_server.assert_called_once_with(gui_id="gui_id", config=config, gui_class=BECFigure)