bec-ipython-client 3.70.0__py3-none-any.whl → 3.86.1__py3-none-any.whl

tests/end-2-end/_ensure_requirements_container.py

@@ -8,14 +8,14 @@ image_name = (
 )
 podman = PodmanCliUtils()
 
-for i in range(1, 4):
+for i in range(1, 6):
     try:
         output = podman._run_and_capture_error("podman", "pull", image_name)
         print("successfully pulled requirements image for current version")
         exit(0)
     except ProcedureWorkerError as e:
         print(e)
-        print("retrying in 2 minutes...")
-        sleep(120)
+        print("retrying in 5 minutes...")
+        sleep(5 * 60)
 print(f"No more retries. Check if {image_name} actually exists!")
 exit(1)

tests/end-2-end/test_procedures_e2e.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import time
+from dataclasses import dataclass
 from importlib.metadata import version
 from typing import TYPE_CHECKING, Callable, Generator
 from unittest.mock import MagicMock, patch
@@ -11,7 +12,7 @@ from bec_ipython_client.main import BECIPythonClient
 from bec_lib import messages
 from bec_lib.endpoints import MessageEndpoints
 from bec_lib.logger import bec_logger
-from bec_server.scan_server.procedures.constants import PROCEDURE
+from bec_server.scan_server.procedures.constants import _CONTAINER, _WORKER
 from bec_server.scan_server.procedures.container_utils import get_backend
 from bec_server.scan_server.procedures.container_worker import ContainerProcedureWorker
 from bec_server.scan_server.procedures.manager import ProcedureManager
@@ -28,6 +29,15 @@ logger = bec_logger.logger
 pytestmark = pytest.mark.random_order(disabled=True)
 
 
+@dataclass(frozen=True)
+class PATCHED_CONSTANTS:
+    WORKER = _WORKER()
+    CONTAINER = _CONTAINER()
+    MANAGER_SHUTDOWN_TIMEOUT_S = 2
+    BEC_VERSION = version("bec_lib")
+    REDIS_HOST = "localhost"
+
+
 @pytest.fixture
 def client_logtool_and_manager(
     bec_ipython_client_fixture_with_logtool: tuple[BECIPythonClient, "LogTestTool"],
@@ -52,7 +62,7 @@ def _wait_while(cond: Callable[[], bool], timeout_s):
 def test_building_worker_image():
     podman_utils = get_backend()
     build = podman_utils.build_worker_image()
-    assert len(build._command_output.splitlines()[-1]) == 64
+    assert len(build._command_output.splitlines()[-1]) == 64  # type: ignore
     assert podman_utils.image_exists(f"bec_procedure_worker:v{version('bec_lib')}")
 
 
@@ -62,7 +72,7 @@ def test_procedure_runner_spawns_worker(
     client_logtool_and_manager: tuple[BECIPythonClient, "LogTestTool", ProcedureManager],
 ):
     client, _, manager = client_logtool_and_manager
-    assert manager.active_workers == {}
+    assert manager._active_workers == {}
     endpoint = MessageEndpoints.procedure_request()
     msg = messages.ProcedureRequestMessage(
         identifier="sleep", args_kwargs=((), {"time_s": 2}), queue="test"
@@ -77,21 +87,22 @@ def test_procedure_runner_spawns_worker(
     manager.add_callback("test", cb)
     client.connector.xadd(topic=endpoint, msg_dict=msg.model_dump())
 
-    _wait_while(lambda: manager.active_workers == {}, 5)
-    _wait_while(lambda: manager.active_workers != {}, 20)
+    _wait_while(lambda: manager._active_workers == {}, 5)
+    _wait_while(lambda: manager._active_workers != {}, 20)
 
     assert logs != []
 
 
 @pytest.mark.timeout(100)
 @patch("bec_server.scan_server.procedures.manager.procedure_registry.is_registered", lambda _: True)
+@patch("bec_server.scan_server.procedures.container_worker.PROCEDURE", PATCHED_CONSTANTS())
 def test_happy_path_container_procedure_runner(
     client_logtool_and_manager: tuple[BECIPythonClient, "LogTestTool", ProcedureManager],
 ):
     test_args = (1, 2, 3)
     test_kwargs = {"a": "b", "c": "d"}
     client, logtool, manager = client_logtool_and_manager
-    assert manager.active_workers == {}
+    assert manager._active_workers == {}
     conn = client.connector
     endpoint = MessageEndpoints.procedure_request()
     msg = messages.ProcedureRequestMessage(
@@ -99,12 +110,15 @@ def test_happy_path_container_procedure_runner(
     )
     conn.xadd(topic=endpoint, msg_dict=msg.model_dump())
 
-    _wait_while(lambda: manager.active_workers == {}, 5)
-    _wait_while(lambda: manager.active_workers != {}, 20)
+    _wait_while(lambda: manager._active_workers == {}, 5)
+    _wait_while(lambda: manager._active_workers != {}, 20)
 
     logtool.fetch()
     assert logtool.is_present_in_any_message("procedure accepted: True, message:")
-    assert logtool.is_present_in_any_message("ContainerWorker started container for queue primary")
+    assert logtool.is_present_in_any_message(
+        "ContainerWorker started container for queue primary"
+    ), f"Log content relating to procedures: {manager._logs}"
+
     res, msg = logtool.are_present_in_order(
         [
             "Container worker 'primary' status update: IDLE",
@@ -114,12 +128,7 @@ def test_happy_path_container_procedure_runner(
         ]
     )
     assert res, f"failed on {msg}"
-    res, msg = logtool.are_present_in_order(
-        [
-            "Container worker 'primary' status update: IDLE",
-            f"Builtin procedure log_message_args_kwargs called with args: {test_args} and kwargs: {test_kwargs}",
-            "Container worker 'primary' status update: IDLE",
-            "Container worker 'primary' status update: FINISHED",
-        ]
+
+    assert logtool.is_present_in_any_message(
+        f"Builtin procedure log_message_args_kwargs called with args: {test_args} and kwargs: {test_kwargs}"
     )
-    assert res, f"failed on {msg}"

tests/end-2-end/test_scans_e2e.py

@@ -1,9 +1,12 @@
+from __future__ import annotations
+
 import _thread
 import io
 import os
 import threading
 import time
 from contextlib import redirect_stdout
+from typing import TYPE_CHECKING
 from unittest.mock import PropertyMock
 
 import h5py
@@ -19,6 +22,9 @@ from bec_lib.logger import bec_logger
 
 logger = bec_logger.logger
 
+if TYPE_CHECKING:  # pragma: no cover
+    from bec_ipython_client.main import BECIPythonClient
+
 # pylint: disable=protected-access
 
 
@@ -201,13 +207,13 @@ def test_mv_scan_mv(bec_ipython_client_fixture):
 
 
 @pytest.mark.timeout(100)
-def test_scan_abort(bec_ipython_client_fixture):
+def test_scan_abort(bec_ipython_client_fixture: BECIPythonClient):
     def send_abort(bec):
         while True:
             current_scan_info = bec.queue.scan_storage.current_scan_info
             if not current_scan_info:
                 continue
-            status = current_scan_info.get("status").lower()
+            status = current_scan_info.status.lower()
             if status not in ["running", "deferred_pause"]:
                 continue
             if bec.queue.scan_storage.current_scan is None:
@@ -217,7 +223,7 @@ def test_scan_abort(bec_ipython_client_fixture):
                 break
         while True:
             queue = bec.queue.queue_storage.current_scan_queue
-            if queue["primary"]["info"][0]["status"] == "DEFERRED_PAUSE":
+            if queue["primary"].info[0].status == "DEFERRED_PAUSE":
                 break
             time.sleep(0.5)
         _thread.interrupt_main()
@@ -241,7 +247,7 @@ def test_scan_abort(bec_ipython_client_fixture):
         time.sleep(0.5)
 
     current_queue = bec.queue.queue_storage.current_scan_queue["primary"]
-    while current_queue["info"] or current_queue["status"] != "RUNNING":
+    while current_queue.info or current_queue.status != "RUNNING":
         time.sleep(0.5)
         current_queue = bec.queue.queue_storage.current_scan_queue["primary"]
 
@@ -307,7 +313,7 @@ def test_queued_scan(bec_ipython_client_fixture):
     while len(scan2.scan.live_data) != 50:
         time.sleep(0.5)
     current_queue = bec.queue.queue_storage.current_scan_queue["primary"]
-    while current_queue["info"] or current_queue["status"] != "RUNNING":
+    while current_queue.info or current_queue.status != "RUNNING":
         time.sleep(0.5)
         current_queue = bec.queue.queue_storage.current_scan_queue["primary"]
     scan_number_end = bec.queue.next_scan_number
@@ -356,7 +362,7 @@ def test_scan_restart(bec_ipython_client_fixture):
     scan2.wait()
 
     current_queue = bec.queue.queue_storage.current_scan_queue["primary"]
-    while current_queue["info"] or current_queue["status"] != "RUNNING":
+    while current_queue.info or current_queue.status != "RUNNING":
         time.sleep(0.5)
         current_queue = bec.queue.queue_storage.current_scan_queue["primary"]
     scan_number_end = bec.queue.next_scan_number
@@ -364,7 +370,7 @@ def test_scan_restart(bec_ipython_client_fixture):
 
 
 @pytest.mark.timeout(100)
-def test_scan_observer_repeat_queued(bec_ipython_client_fixture):
+def test_scan_observer_repeat_queued(bec_ipython_client_fixture: BECIPythonClient):
     bec = bec_ipython_client_fixture
     bec.metadata.update({"unit_test": "test_scan_observer_repeat_queued"})
     scans = bec.scans
@@ -396,7 +402,7 @@ def test_scan_observer_repeat_queued(bec_ipython_client_fixture):
     scan2.wait()
 
     current_queue = bec.queue.queue_storage.current_scan_queue["primary"]
-    while current_queue["info"] or current_queue["status"] != "RUNNING":
+    while current_queue.info or current_queue.status != "RUNNING":
         time.sleep(0.5)
         current_queue = bec.queue.queue_storage.current_scan_queue["primary"]
     scan_number_end = bec.queue.next_scan_number
@@ -433,7 +439,7 @@ def test_scan_observer_repeat(bec_ipython_client_fixture):
         scan1.wait()
 
     current_queue = bec.queue.queue_storage.current_scan_queue["primary"]
-    while current_queue["info"] or current_queue["status"] != "RUNNING":
+    while current_queue.info or current_queue.status != "RUNNING":
         time.sleep(0.5)
         current_queue = bec.queue.queue_storage.current_scan_queue["primary"]
     while True:
@@ -737,12 +743,12 @@ def test_update_config(bec_ipython_client_fixture):
     bec = bec_ipython_client_fixture
     bec.metadata.update({"unit_test": "test_update_config"})
     demo_config_path = os.path.join(os.path.dirname(configs.__file__), "demo_config.yaml")
-    config = bec.config._load_config_from_file(demo_config_path)
+    config = bec.device_manager.config_helper._load_config_from_file(demo_config_path)
     config.pop("samx")
-    bec.config.send_config_request(action="set", config=config)
+    bec.device_manager.config_helper.send_config_request(action="set", config=config)
     assert "samx" not in bec.device_manager.devices
-    config = bec.config._load_config_from_file(demo_config_path)
-    bec.config.send_config_request(action="set", config=config)
+    config = bec.device_manager.config_helper._load_config_from_file(demo_config_path)
+    bec.device_manager.config_helper.send_config_request(action="set", config=config)
 
 
 @pytest.mark.timeout(100)

tests/end-2-end/test_scans_lib_e2e.py

@@ -322,7 +322,9 @@ def test_config_reload(
     num_devices = len(bec.device_manager.devices)
     if raises_error:
         with pytest.raises(DeviceConfigError):
-            bec.config.update_session_with_file(runtime_config_file_path)
+            bec.config.update_session_with_file(
+                runtime_config_file_path, force=True, validate=False
+            )
         if deletes_config:
             assert len(bec.device_manager.devices) == 0
         elif disabled_device:
@@ -330,7 +332,7 @@ def test_config_reload(
         else:
             assert len(bec.device_manager.devices) == num_devices
     else:
-        bec.config.update_session_with_file(runtime_config_file_path)
+        bec.config.update_session_with_file(runtime_config_file_path, force=True, validate=False)
         assert len(bec.device_manager.devices) == 2
     for dev in disabled_device:
         assert bec.device_manager.devices[dev].enabled is False
@@ -375,7 +377,7 @@ def test_config_reload_with_describe_failure(bec_test_config_file_path, bec_clie
         f.write(yaml.dump(config))
 
     with pytest.raises(DeviceConfigError):
-        bec.config.update_session_with_file(runtime_config_file_path)
+        bec.config.update_session_with_file(runtime_config_file_path, force=True, validate=False)
 
     assert len(bec.device_manager.devices) == 2
     assert bec.device_manager.devices["eyefoc"].enabled is True
@@ -386,7 +388,7 @@ def test_config_reload_with_describe_failure(bec_test_config_file_path, bec_clie
         f"e2e_test_hexapod_fail", messages.DeviceStatusMessage(device="hexapod", status=0)
     )
 
-    bec.config.update_session_with_file(runtime_config_file_path)
+    bec.config.update_session_with_file(runtime_config_file_path, force=True)
     assert len(bec.device_manager.devices) == 2
     assert bec.device_manager.devices["eyefoc"].enabled is True
     assert bec.device_manager.devices["hexapod"].enabled is True
@@ -412,13 +414,13 @@ def test_config_add_remove_device(bec_client_lib):
             "readOnly": False,
         }
     }
-    bec.config.send_config_request(action="add", config=config)
+    bec.device_manager.config_helper.send_config_request(action="add", config=config)
     with pytest.raises(DeviceConfigError) as config_error:
-        bec.config.send_config_request(action="add", config=config)
+        bec.device_manager.config_helper.send_config_request(action="add", config=config)
     assert config_error.match("Device new_device already exists")
     assert "new_device" in dev
 
-    bec.config.send_config_request(action="remove", config={"new_device": {}})
+    bec.device_manager.config_helper.send_config_request(action="remove", config={"new_device": {}})
     assert "new_device" not in dev
 
     device_config_msg = bec.connector.get(MessageEndpoints.device_config())
@@ -429,7 +431,7 @@ def test_config_add_remove_device(bec_client_lib):
 
     config["new_device"]["deviceClass"] = "ophyd_devices.doesnt_exist"
     with pytest.raises(DeviceConfigError) as config_error:
-        bec.config.send_config_request(action="add", config=config)
+        bec.device_manager.config_helper.send_config_request(action="add", config=config)
     assert config_error.match("module 'ophyd_devices' has no attribute 'doesnt_exist'")
     assert "new_device" not in dev
     assert "samx" in dev
@@ -461,17 +463,21 @@ def test_cached_device_readout(bec_client_lib):
     dev = bec.device_manager.devices
 
     dev.samx.setpoint.put(5)
-    data = dev.samx.setpoint.get()
+    data = dev.samx.setpoint.get(cached=True)
     assert data == 5
 
-    orig_velocity = dev.samx.velocity.get()
+    orig_velocity = dev.samx.velocity.get(cached=True)
     dev.samx.velocity.put(10)
-    data = dev.samx.velocity.get()
+    data = dev.samx.velocity.get(cached=True)
     assert data == 10
 
-    config = dev.samx.read_configuration()
+    config = dev.samx.read_configuration(cached=True)
     assert config["samx_velocity"]["value"] == 10
 
+    dev.samx.velocity.set(20).wait()
+    data = dev.samx.velocity.get(cached=True)
+    assert data == 20
+
     dev.samx.velocity.put(orig_velocity)
 
     data = dev.hexapod.x.readback.read()

bec_ipython_client-3.70.0.dist-info/RECORD

@@ -1,43 +0,0 @@
-.gitignore,sha256=UmJ0gTRAPp4EI1A6tb9Pi-k5uxDIb_NWJU9ye6AW-8Y,3306
-PKG-INFO,sha256=8InaX9sdNJR4GYyFYQ4MxSmsiSYuXiUO8FTYFB5ruBU,1052
-demo.py,sha256=TE-niyXPUEAP-GaL-QRBPgnaxfXqBmTsBiKUxl3F_VQ,7053
-pyproject.toml,sha256=Tnvc9IgRWhxdkfFa6p9UsMPkkpapIOPzmMV6ocwsdnY,1229
-bec_ipython_client/__init__.py,sha256=ihd_V8I7Qo0MWKMo7bcvPf-ZyUQqkcNf8IAWLJKiFJE,79
-bec_ipython_client/beamline_mixin.py,sha256=scMWIFbHJajyECzbwEVKyQUGjpqA9C_KiU2M6FuRH_Q,1067
-bec_ipython_client/bec_magics.py,sha256=Rz2aXkUCeAV_VxdXqLUNHh8T44kSH9ha83OiEtdptzI,2792
-bec_ipython_client/bec_startup.py,sha256=GGlHyxnSCQfYF5n-pYq2ic0pSyW5zvnT2PAlI5kY77w,1930
-bec_ipython_client/main.py,sha256=OQeDX1XxavvKo-0lpM8-Pd8tkMIS09DG7fqeCjsIEHw,11237
-bec_ipython_client/prettytable.py,sha256=TnhGPGuU0XEvnIYJ1UfTEwadcowFW4rqJW8z_Sm0EDw,2534
-bec_ipython_client/progressbar.py,sha256=aDKYjzXmGSwa82ewm59V8WSuqVQz9GiZPx5G65fEwpk,11090
-bec_ipython_client/signals.py,sha256=mbThPo6h3mQ6RFRm9viETDMC_unFa7QxiymCdM_ZK7U,4194
-bec_ipython_client/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_ipython_client/callbacks/device_progress.py,sha256=y3GFSlCD-etOIrLJkX2ozxEyCNRMaRAaTdZmN8xOcjk,2385
-bec_ipython_client/callbacks/ipython_live_updates.py,sha256=tcr3ATyg46NAS3yQHhdOS7KFJnfVxri36PuKpILjyqU,10322
-bec_ipython_client/callbacks/live_table.py,sha256=2FjNSTC5HbNgg-aNJcEfNZRnhIUqJoRRTthU3L1UKD4,13350
-bec_ipython_client/callbacks/move_device.py,sha256=FXCztPGqKNmaSKs9Q13y7syZJs57IZo4mJH6GTOIbOU,5863
-bec_ipython_client/callbacks/utils.py,sha256=AEEzsfD9S2ZMuJA4yAxy9gMa1iPMCxQ3zr7ZDO01bHE,5702
-bec_ipython_client/high_level_interfaces/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_ipython_client/high_level_interfaces/bec_hli.py,sha256=G1eF-lbLEDuN2mr_AYSxhhGb4LT6P72g0a4sU9M9zgk,1221
-bec_ipython_client/high_level_interfaces/spec_hli.py,sha256=z7WtjiC4LtMfKJn12SbguHPCLqbAsZNfUDyiUW0LOiU,5818
-bec_ipython_client/plugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_ipython_client/plugins/SLS/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_ipython_client/plugins/SLS/sls_info.py,sha256=93GU_XNRDsCO0ZvUrCf_SWnUMJ1FlRTJSuXXh_bYJ30,4934
-bec_ipython_client/plugins/XTreme/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_ipython_client/plugins/XTreme/x-treme.py,sha256=ZKI_EEPYyWW-sdrK9DIllb81aeObc1O3fU1eWqipjTQ,3631
-bec_ipython_client/plugins/flomni/flomni_config.yaml,sha256=bCN1VKCzF6tw24HYeUE2b81kXMXzhEd69Ea8_q8Ywfk,6184
-tests/conftest.py,sha256=4yzGYqs8EVOxxY9Bu-yGbzmOpzG9dxs3cwSCzjmRziQ,233
-tests/client_tests/test_beamline_mixins.py,sha256=8Ws0bmzl2gSW0VuOVu80_JbYNb5Y-htchmrrptwjwDo,4611
-tests/client_tests/test_bec_client.py,sha256=pMpjDpgdeynHMJXZkXCMYERm5OEwu4VR50ID28eNFhc,7722
-tests/client_tests/test_device_progress.py,sha256=GEw2g8MQZnv5mxABEZlxBmaMpxVS33wogaYohFolDEs,2353
-tests/client_tests/test_ipython_live_updates.py,sha256=HpA16Mx0WdseqlfP0FojlAd6VfvjnwAUReDkItZVYWs,6081
-tests/client_tests/test_live_table.py,sha256=5ZtCWDYBm_Vxg1lw6Nuj5qpmtY4VPGCYdX-cY00dSf8,18178
-tests/client_tests/test_move_callback.py,sha256=e5c14pa9tUsMPgNhI9m7vrml5TKEAmMAQKLuiZPftDw,7026
-tests/client_tests/test_pretty_table.py,sha256=uQ-KPb3RXoCFE_t1IrpkT6kZAoqW7pFXxbFc445sX0Y,469
-tests/end-2-end/_ensure_requirements_container.py,sha256=iAcTHqudgJMh7yS9kmfN1bqfqUgvj6ZG-LyuJVIfgFE,722
-tests/end-2-end/test_procedures_e2e.py,sha256=3CPzjW3VpsSU8GKVP814SSvLZ0c7bBtPB_VtX725TCY,4737
-tests/end-2-end/test_scans_e2e.py,sha256=CxlXjQrzDJebaoZObt_oYx41wbnHLuJLSjKlno4u2B4,30981
-tests/end-2-end/test_scans_lib_e2e.py,sha256=bUxKX7JRRQYtjgyOX1LktpcxOE8aZbQ6Ut_alKQhGYg,19063
-bec_ipython_client-3.70.0.dist-info/METADATA,sha256=8InaX9sdNJR4GYyFYQ4MxSmsiSYuXiUO8FTYFB5ruBU,1052
-bec_ipython_client-3.70.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-bec_ipython_client-3.70.0.dist-info/entry_points.txt,sha256=oQUXYY0jjD9ZvKPHwaGn2wkUIWpDZM8L4ixDA3RlBWE,53
-bec_ipython_client-3.70.0.dist-info/RECORD,,