bec-ipython-client 3.141.0__tar.gz → 3.142.0__tar.gz

{bec_ipython_client-3.141.0 → bec_ipython_client-3.142.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_ipython_client
-Version: 3.141.0
+Version: 3.142.0
 Summary: BEC IPython client
 Project-URL: Bug Tracker, https://github.com/bec-project/bec/issues
 Project-URL: Homepage, https://github.com/bec-project/bec

{bec_ipython_client-3.141.0 → bec_ipython_client-3.142.0}/bec_ipython_client/callbacks/device_progress.py

@@ -1,6 +1,7 @@
 import time
 
 from bec_ipython_client.progressbar import ScanProgressBar
+from bec_lib.bec_errors import ScanInterruption, ScanRestart
 from bec_lib.endpoints import MessageEndpoints
 from bec_lib.logger import bec_logger
 
@@ -14,6 +15,34 @@ class LiveUpdatesDeviceProgress(LiveUpdatesTable):
 
     REPORT_TYPE = "device_progress"
 
+    def _check_scan_state(self) -> bool:
+        """Check whether the scan has reached a terminal or exceptional state.
+
+        Returns:
+            bool: True if the scan should stop without error.
+        """
+        if not self.scan_item:
+            return False
+
+        restarted_msg = getattr(self.scan_item, "restarted_msg", None)
+        if restarted_msg:
+            raise ScanRestart(new_scan_msg=restarted_msg)
+
+        if getattr(self.scan_item, "status", None) == "user_completed":
+            print("Scan was set to 'completed' by user.")
+            return True
+
+        status_message = getattr(self.scan_item, "status_message", None)
+        if status_message and getattr(status_message, "reason", None) == "user":
+            scan_number = getattr(self.scan_item, "scan_number", None)
+            if scan_number is None:
+                msg = "Scan was aborted by user."
+            else:
+                msg = f"Scan {scan_number} was aborted by user."
+            raise ScanInterruption(msg)
+
+        return False
+
     def core(self):
         """core function to run the live updates for the table"""
         self._wait_for_report_instructions()
@@ -23,7 +52,7 @@ class LiveUpdatesDeviceProgress(LiveUpdatesTable):
         """Run the update loop for the progress bar.
 
         Args:
-            device_names (list[str]): The name of the device to monitor.
+            device_names (list[str]): The names of the devices to monitor.
         """
         with ScanProgressBar(
             scan_number=self.scan_item.scan_number, clear_on_exit=False
@@ -39,11 +68,13 @@ class LiveUpdatesDeviceProgress(LiveUpdatesTable):
 
         Args:
             progressbar (ScanProgressBar): The progressbar to update.
-            device_names (str): The name of the device to monitor.
+            device_names (list[str]): The names of the devices to monitor.
         Returns:
             bool: True if the scan is finished.
         """
         self.check_alarms()
+        if self._check_scan_state():
+            return True
         status = self.bec.connector.get(MessageEndpoints.device_progress(device_names[0]))
         if not status:
             logger.trace("waiting for new data point")
@@ -68,6 +99,8 @@ class LiveUpdatesDeviceProgress(LiveUpdatesTable):
         # process sync callbacks
         self.bec.callbacks.poll()
         self.scan_item.poll_callbacks()
+        if self._check_scan_state():
+            return True
 
         done = status.content.get("done")
         if point_id == max_value or done:

{bec_ipython_client-3.141.0 → bec_ipython_client-3.142.0}/bec_ipython_client/callbacks/ipython_live_updates.py

@@ -363,7 +363,7 @@ class IPythonLiveUpdates:
             return
 
         status = target_queue_status.status
-        if status == "LOCKED":
+        if status == "LOCKED" and any(queue.scan_ids):
             lock_info = [
                 f"{lock.identifier}: {lock.reason}\n" for lock in target_queue_status.locks
             ]

{bec_ipython_client-3.141.0 → bec_ipython_client-3.142.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_ipython_client"
-version = "3.141.0"
+version = "3.142.0"
 description = "BEC IPython client"
 requires-python = ">=3.11"
 classifiers = [
@@ -100,6 +100,7 @@ Homepage = "https://github.com/bec-project/bec"
 
 
 
+
 
 
 [tool.hatch.build.targets.wheel]

bec_ipython_client-3.142.0/tests/client_tests/test_device_progress.py

@@ -0,0 +1,125 @@
+from unittest import mock
+
+import pytest
+
+from bec_ipython_client.callbacks.device_progress import LiveUpdatesDeviceProgress
+from bec_lib import messages
+from bec_lib.bec_errors import ScanInterruption, ScanRestart
+
+
+def test_update_progressbar_continues_without_device_data():
+    bec = mock.MagicMock()
+    request = mock.MagicMock()
+    live_update = LiveUpdatesDeviceProgress(bec=bec, report_instruction={}, request=request)
+    progressbar = mock.MagicMock()
+
+    bec.connector.get.return_value = None
+    res = live_update._update_progressbar(progressbar, ["async_dev1"])
+    assert res is False
+
+
+def test_update_progressbar_continues_when_scan_id_doesnt_match():
+    bec = mock.MagicMock()
+    request = mock.MagicMock()
+    live_update = LiveUpdatesDeviceProgress(bec=bec, report_instruction={}, request=request)
+    progressbar = mock.MagicMock()
+    live_update.scan_item = mock.MagicMock()
+    live_update.scan_item.scan_id = "scan_id2"
+    live_update.scan_item.restarted_msg = None
+    live_update.scan_item.status = "open"
+    live_update.scan_item.status_message = None
+
+    bec.connector.get.return_value = messages.ProgressMessage(
+        value=1, max_value=10, done=False, metadata={"scan_id": "scan_id"}
+    )
+    res = live_update._update_progressbar(progressbar, ["async_dev1"])
+    assert res is False
+
+
+def test_update_progressbar_updates_max_value():
+    bec = mock.MagicMock()
+    request = mock.MagicMock()
+    live_update = LiveUpdatesDeviceProgress(bec=bec, report_instruction={}, request=request)
+    progressbar = mock.MagicMock()
+    live_update.scan_item = mock.MagicMock()
+    live_update.scan_item.scan_id = "scan_id"
+    live_update.scan_item.restarted_msg = None
+    live_update.scan_item.status = "open"
+    live_update.scan_item.status_message = None
+
+    bec.connector.get.return_value = messages.ProgressMessage(
+        value=10, max_value=20, done=False, metadata={"scan_id": "scan_id"}
+    )
+    res = live_update._update_progressbar(progressbar, ["async_dev1"])
+    assert res is False
+    assert progressbar.max_points == 20
+    progressbar.update.assert_called_once_with(10)
+
+
+def test_update_progressbar_returns_true_when_max_value_is_reached():
+    bec = mock.MagicMock()
+    request = mock.MagicMock()
+    live_update = LiveUpdatesDeviceProgress(bec=bec, report_instruction={}, request=request)
+    progressbar = mock.MagicMock()
+    live_update.scan_item = mock.MagicMock()
+    live_update.scan_item.scan_id = "scan_id"
+    live_update.scan_item.restarted_msg = None
+    live_update.scan_item.status = "open"
+    live_update.scan_item.status_message = None
+
+    bec.connector.get.return_value = messages.ProgressMessage(
+        value=10, max_value=10, done=True, metadata={"scan_id": "scan_id"}
+    )
+    res = live_update._update_progressbar(progressbar, ["async_dev1"])
+    assert res is True
+
+
+def test_update_progressbar_raises_scan_restart_when_scan_restarted():
+    bec = mock.MagicMock()
+    request = mock.MagicMock()
+    live_update = LiveUpdatesDeviceProgress(bec=bec, report_instruction={}, request=request)
+    progressbar = mock.MagicMock()
+    restart_msg = messages.ScanQueueMessage(scan_type="grid_scan", parameter={"args": {}})
+    live_update.scan_item = mock.MagicMock(
+        scan_id="scan_id", restarted_msg=restart_msg, status="open", status_message=None
+    )
+
+    with mock.patch("bec_ipython_client.callbacks.device_progress.print") as mock_print:
+        with pytest.raises(ScanRestart) as exc_info:
+            live_update._update_progressbar(progressbar, ["async_dev1"])
+
+    assert exc_info.value.new_scan_msg == restart_msg
+    mock_print.assert_not_called()
+
+
+def test_update_progressbar_returns_true_when_scan_completed_by_user():
+    bec = mock.MagicMock()
+    request = mock.MagicMock()
+    live_update = LiveUpdatesDeviceProgress(bec=bec, report_instruction={}, request=request)
+    progressbar = mock.MagicMock()
+    live_update.scan_item = mock.MagicMock(
+        scan_id="scan_id", restarted_msg=None, status="user_completed", status_message=None
+    )
+
+    with mock.patch("bec_ipython_client.callbacks.device_progress.print") as mock_print:
+        res = live_update._update_progressbar(progressbar, ["async_dev1"])
+
+    assert res is True
+    mock_print.assert_called_once_with("Scan was set to 'completed' by user.")
+
+
+def test_update_progressbar_raises_scan_interruption_when_aborted_by_user():
+    bec = mock.MagicMock()
+    request = mock.MagicMock()
+    live_update = LiveUpdatesDeviceProgress(bec=bec, report_instruction={}, request=request)
+    progressbar = mock.MagicMock()
+    live_update.scan_item = mock.MagicMock(
+        scan_id="scan_id",
+        scan_number=5,
+        restarted_msg=None,
+        status="open",
+        status_message=mock.MagicMock(reason="user"),
+    )
+
+    with pytest.raises(ScanInterruption, match="Scan 5 was aborted by user."):
+        live_update._update_progressbar(progressbar, ["async_dev1"])

bec_ipython_client-3.141.0/tests/client_tests/test_device_progress.py

@@ -1,62 +0,0 @@
-from unittest import mock
-
-from bec_ipython_client.callbacks.device_progress import LiveUpdatesDeviceProgress
-from bec_lib import messages
-
-
-def test_update_progressbar_continues_without_device_data():
-    bec = mock.MagicMock()
-    request = mock.MagicMock()
-    live_update = LiveUpdatesDeviceProgress(bec=bec, report_instruction={}, request=request)
-    progressbar = mock.MagicMock()
-
-    bec.connector.get.return_value = None
-    res = live_update._update_progressbar(progressbar, "async_dev1")
-    assert res is False
-
-
-def test_update_progressbar_continues_when_scan_id_doesnt_match():
-    bec = mock.MagicMock()
-    request = mock.MagicMock()
-    live_update = LiveUpdatesDeviceProgress(bec=bec, report_instruction={}, request=request)
-    progressbar = mock.MagicMock()
-    live_update.scan_item = mock.MagicMock()
-    live_update.scan_item.scan_id = "scan_id2"
-
-    bec.connector.get.return_value = messages.ProgressMessage(
-        value=1, max_value=10, done=False, metadata={"scan_id": "scan_id"}
-    )
-    res = live_update._update_progressbar(progressbar, "async_dev1")
-    assert res is False
-
-
-def test_update_progressbar_updates_max_value():
-    bec = mock.MagicMock()
-    request = mock.MagicMock()
-    live_update = LiveUpdatesDeviceProgress(bec=bec, report_instruction={}, request=request)
-    progressbar = mock.MagicMock()
-    live_update.scan_item = mock.MagicMock()
-    live_update.scan_item.scan_id = "scan_id"
-
-    bec.connector.get.return_value = messages.ProgressMessage(
-        value=10, max_value=20, done=False, metadata={"scan_id": "scan_id"}
-    )
-    res = live_update._update_progressbar(progressbar, "async_dev1")
-    assert res is False
-    assert progressbar.max_points == 20
-    progressbar.update.assert_called_once_with(10)
-
-
-def test_update_progressbar_returns_true_when_max_value_is_reached():
-    bec = mock.MagicMock()
-    request = mock.MagicMock()
-    live_update = LiveUpdatesDeviceProgress(bec=bec, report_instruction={}, request=request)
-    progressbar = mock.MagicMock()
-    live_update.scan_item = mock.MagicMock()
-    live_update.scan_item.scan_id = "scan_id"
-
-    bec.connector.get.return_value = messages.ProgressMessage(
-        value=10, max_value=10, done=True, metadata={"scan_id": "scan_id"}
-    )
-    res = live_update._update_progressbar(progressbar, "async_dev1")
-    assert res is True