bec-server 2.12.2__tar.gz → 2.12.4__tar.gz

{bec_server-2.12.2 → bec_server-2.12.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec-server
-Version: 2.12.2
+Version: 2.12.4
 Summary: BEC server
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec

{bec_server-2.12.2 → bec_server-2.12.4}/bec_server/scan_server/scan_manager.py

@@ -77,7 +77,6 @@ class ScanManager:
                 "arg_input": scan_cls.arg_input,
                 "required_kwargs": scan_cls.required_kwargs,
                 "arg_bundle_size": scan_cls.arg_bundle_size,
-                "scan_report_hint": scan_cls.scan_report_hint,
                 "doc": scan_cls.__doc__ or scan_cls.__init__.__doc__,
                 "signature": signature_to_dict(scan_cls.__init__),
             }

{bec_server-2.12.2 → bec_server-2.12.4}/bec_server/scan_server/scan_plugins/otf_scan.py

@@ -8,7 +8,6 @@ logger = bec_logger.logger
 
 class OTFScan(SyncFlyScanBase):
     scan_name = "otf_scan"
-    scan_report_hint = "table"
     required_kwargs = ["e1", "e2", "time"]
     arg_input = {}
     arg_bundle_size = {"bundle": len(arg_input), "min": None, "max": None}
@@ -66,7 +65,6 @@ class OTFScan(SyncFlyScanBase):
 
 class HystScan(ScanBase):
     scan_name = "hyst_scan"
-    scan_report_hint = "table"
     required_kwargs = []
     arg_input = {
         "field_motor": ScanArgType.DEVICE,
@@ -124,7 +122,7 @@ class HystScan(ScanBase):
             self._current_scan_motor_index += self._scan_motor_direction
 
     def scan_core(self):
-        # yield from self._move_and_wait(self.positions[0])
+        # yield from self._move_scan_motors_and_wait(self.positions[0])
         status = yield from self.stubs.send_rpc_and_wait(
             "field_x", "ramprate.set", self.default_ramp_rate
         )

{bec_server-2.12.2 → bec_server-2.12.4}/bec_server/scan_server/scan_stubs.py

@@ -1,3 +1,8 @@
+"""
+Scan stubs are commands that can be used to control devices during a scan. They typically yield device messages that are
+consumed by the scan worker and potentially forwarded to the device server.
+"""
+
 from __future__ import annotations
 
 import threading
@@ -20,6 +25,11 @@ logger = bec_logger.logger
 
 
 class ScanStubs:
+    """
+    Scan stubs are commands that can be used to control devices during a scan. They typically yield device messages that are
+    consumed by the scan worker and potentially forwarded to the device server.
+    """
+
     def __init__(
         self,
         connector: ConnectorBase,

{bec_server-2.12.2 → bec_server-2.12.4}/bec_server/scan_server/scan_worker.py

@@ -74,11 +74,11 @@ class ScanWorker(threading.Thread):
 
         self._initialize_scan_info(active_rb, instr, num_points)
 
-        # only append the table_wait if the scan is not using scan_progress
+        # only append the scan_progress if the scan is not using device_progress
         if not self.scan_report_instructions or not self.scan_report_instructions[-1].get(
-            "scan_progress"
+            "device_progress"
         ):
-            self.scan_report_instructions.append({"table_wait": num_points})
+            self.scan_report_instructions.append({"scan_progress": num_points})
         self.current_instruction_queue_item.parent.queue_manager.send_queue_status()
 
         self._send_scan_status("open")
@@ -655,7 +655,6 @@ class ScanWorker(threading.Thread):
                 "settling_time": active_rb.scan.settling_time,
                 "readout_time": active_rb.scan.readout_time,
                 "acquisition_config": active_rb.scan.acquisition_config,
-                "scan_report_hint": active_rb.scan.scan_report_hint,
                 "scan_report_devices": active_rb.scan.scan_report_devices,
                 "monitor_sync": active_rb.scan.monitor_sync,
                 "num_points": num_points,

{bec_server-2.12.2 → bec_server-2.12.4}/bec_server/scan_server/scans.py

@@ -180,7 +180,6 @@ class RequestBase(ABC):
     """
 
     scan_name = ""
-    scan_report_hint = None
     arg_input = {"device": ScanArgType.DEVICE}
     arg_bundle_size = {"bundle": len(arg_input), "min": 1, "max": None}
     required_kwargs = []
@@ -318,7 +317,6 @@ class ScanBase(RequestBase, PathOptimizerMixin):
 
     Attributes:
         scan_name (str): name of the scan
-        scan_report_hint (str): hint for the scan report
         scan_type (str): scan type. Can be "step" or "fly"
         arg_input (list): list of scan argument types
         arg_bundle_size (dict):
@@ -330,7 +328,6 @@ class ScanBase(RequestBase, PathOptimizerMixin):
     """
 
     scan_name = ""
-    scan_report_hint = None
     scan_type = "step"
     arg_input = {"device": ScanArgType.DEVICE}
     arg_bundle_size = {"bundle": len(arg_input), "min": 1, "max": None}
@@ -340,10 +337,6 @@ class ScanBase(RequestBase, PathOptimizerMixin):
     # perform pre-move action before the pre_scan trigger is sent
     pre_move = True
 
-    # # synchronize primary readings with the scan motor readings. Set to False if the master device
-    # # does not provide single readouts or are too fast to be synchronized with primary readings
-    # enforce_sync = True
-
     def __init__(
         self,
         *args,
@@ -471,7 +464,7 @@ class ScanBase(RequestBase, PathOptimizerMixin):
 
     def return_to_start(self):
         """return to the start position"""
-        yield from self._move_and_wait(self.start_pos)
+        yield from self._move_scan_motors_and_wait(self.start_pos)
 
     def finalize(self):
         """finalize the scan"""
@@ -488,7 +481,7 @@ class ScanBase(RequestBase, PathOptimizerMixin):
         yield from self.close_scan()
 
     def _at_each_point(self, ind=None, pos=None):
-        yield from self._move_and_wait(pos)
+        yield from self._move_scan_motors_and_wait(pos)
         if ind > 0:
             yield from self.stubs.wait(
                 wait_type="read", group="primary", wait_group="readout_primary"
@@ -505,7 +498,7 @@ class ScanBase(RequestBase, PathOptimizerMixin):
 
         self.point_id += 1
 
-    def _move_and_wait(self, pos):
+    def _move_scan_motors_and_wait(self, pos):
         if not isinstance(pos, list) and not isinstance(pos, np.ndarray):
             pos = [pos]
         if len(pos) == 0:
@@ -528,7 +521,7 @@ class ScanBase(RequestBase, PathOptimizerMixin):
         perform additional tasks before the scan is started. This
         """
         if self.pre_move and len(self.positions) > 0:
-            yield from self._move_and_wait(self.positions[0])
+            yield from self._move_scan_motors_and_wait(self.positions[0])
         yield from self.stubs.pre_scan()
 
     def run(self):
@@ -633,7 +626,6 @@ class ScanStub(RequestBase):
 
 class OpenScanDef(ScanStub):
     scan_name = "open_scan_def"
-    scan_report_hint = None
     arg_input = {}
     arg_bundle_size = {"bundle": len(arg_input), "min": 0, "max": 0}
 
@@ -643,7 +635,6 @@ class OpenScanDef(ScanStub):
 
 class CloseScanDef(ScanStub):
     scan_name = "close_scan_def"
-    scan_report_hint = "table"
     arg_input = {}
     arg_bundle_size = {"bundle": len(arg_input), "min": 0, "max": 0}
 
@@ -664,7 +655,6 @@ class DeviceRPC(ScanStub):
     scan_name = "device_rpc"
     arg_input = [ScanArgType.DEVICE, ScanArgType.STR, ScanArgType.LIST, ScanArgType.DICT]
     arg_bundle_size = {"bundle": len(arg_input), "min": 1, "max": 1}
-    scan_report_hint = None
 
     def _get_scan_motors(self):
         pass
@@ -678,7 +668,6 @@ class Move(RequestBase):
     scan_name = "mv"
     arg_input = {"device": ScanArgType.DEVICE, "target": ScanArgType.FLOAT}
     arg_bundle_size = {"bundle": len(arg_input), "min": 1, "max": None}
-    scan_report_hint = None
     required_kwargs = ["relative"]
 
     def __init__(self, *args, relative=False, **kwargs):
@@ -728,19 +717,7 @@ class Move(RequestBase):
         self._check_limits()
 
     def scan_report_instructions(self):
-        if not self.scan_report_hint:
-            yield None
-            return
-        yield from self.stubs.scan_report_instruction(
-            {
-                "readback": {
-                    "RID": self.metadata["RID"],
-                    "devices": self.scan_motors,
-                    "start": self.start_pos,
-                    "end": self.positions[0],
-                }
-            }
-        )
+        yield None
 
     def run(self):
         self.initialize()
@@ -764,7 +741,6 @@ class UpdatedMove(Move):
     """
 
     scan_name = "umv"
-    scan_report_hint = "readback"
 
     def _at_each_point(self, pos=None):
         for ii, motor in enumerate(self.scan_motors):
@@ -775,10 +751,21 @@ class UpdatedMove(Move):
         for motor in self.scan_motors:
             yield from self.stubs.wait(wait_type="move", device=motor, wait_group="scan_motor")
 
+    def scan_report_instructions(self):
+        yield from self.stubs.scan_report_instruction(
+            {
+                "readback": {
+                    "RID": self.metadata["RID"],
+                    "devices": self.scan_motors,
+                    "start": self.start_pos,
+                    "end": self.positions[0],
+                }
+            }
+        )
+
 
 class Scan(ScanBase):
     scan_name = "grid_scan"
-    scan_report_hint = "table"
     arg_input = {
         "device": ScanArgType.DEVICE,
         "start": ScanArgType.FLOAT,
@@ -832,7 +819,6 @@ class Scan(ScanBase):
 
 class FermatSpiralScan(ScanBase):
     scan_name = "fermat_scan"
-    scan_report_hint = "table"
     required_kwargs = ["step", "relative"]
     arg_input = {
         "device": ScanArgType.DEVICE,
@@ -898,7 +884,6 @@ class FermatSpiralScan(ScanBase):
 
 class RoundScan(ScanBase):
     scan_name = "round_scan"
-    scan_report_hint = "table"
     required_kwargs = ["relative"]
     arg_input = {
         "motor_1": ScanArgType.DEVICE,
@@ -956,7 +941,6 @@ class RoundScan(ScanBase):
 
 class ContLineScan(ScanBase):
     scan_name = "cont_line_scan"
-    scan_report_hint = "table"
     required_kwargs = ["steps", "relative"]
     arg_input = {
         "device": ScanArgType.DEVICE,
@@ -1014,7 +998,7 @@ class ContLineScan(ScanBase):
         self.point_id += 1
 
     def scan_core(self):
-        yield from self._move_and_wait(self.positions[0] - self.offset)
+        yield from self._move_scan_motors_and_wait(self.positions[0] - self.offset)
         # send the slow motor on its way
         yield from self.stubs.set(
             device=self.scan_motors[0], value=self.positions[-1][0], wait_group="scan_motor"
@@ -1038,7 +1022,6 @@ class ContLineScan(ScanBase):
 
 class RoundScanFlySim(SyncFlyScanBase):
     scan_name = "round_scan_fly"
-    scan_report_hint = "table"
     scan_type = "fly"
     pre_move = False
     required_kwargs = ["relative"]
@@ -1120,7 +1103,6 @@ class RoundScanFlySim(SyncFlyScanBase):
 
 class RoundROIScan(ScanBase):
     scan_name = "round_roi_scan"
-    scan_report_hint = "table"
     required_kwargs = ["dr", "nth", "relative"]
     arg_input = {
         "motor_1": ScanArgType.DEVICE,
@@ -1175,7 +1157,6 @@ class RoundROIScan(ScanBase):
 
 class ListScan(ScanBase):
     scan_name = "list_scan"
-    scan_report_hint = "table"
     required_kwargs = ["relative"]
     arg_input = {"device": ScanArgType.DEVICE, "positions": ScanArgType.LIST}
     arg_bundle_size = {"bundle": len(arg_input), "min": 1, "max": None}
@@ -1208,7 +1189,6 @@ class ListScan(ScanBase):
 
 class TimeScan(ScanBase):
     scan_name = "time_scan"
-    scan_report_hint = "table"
     required_kwargs = ["points", "interval"]
     arg_input = {}
     arg_bundle_size = {"bundle": len(arg_input), "min": None, "max": None}
@@ -1275,7 +1255,6 @@ class TimeScan(ScanBase):
 
 class MonitorScan(ScanBase):
     scan_name = "monitor_scan"
-    scan_report_hint = "table"
     required_kwargs = ["relative"]
     arg_input = {
         "device": ScanArgType.DEVICE,
@@ -1367,7 +1346,6 @@ class MonitorScan(ScanBase):
 
 class Acquire(ScanBase):
     scan_name = "acquire"
-    scan_report_hint = "table"
     required_kwargs = []
     arg_input = {}
     arg_bundle_size = {"bundle": len(arg_input), "min": None, "max": None}
@@ -1429,7 +1407,6 @@ class Acquire(ScanBase):
 
 class LineScan(ScanBase):
     scan_name = "line_scan"
-    scan_report_hint = "table"
     required_kwargs = ["steps", "relative"]
     arg_input = {
         "device": ScanArgType.DEVICE,
@@ -1484,7 +1461,6 @@ class ScanComponent(ScanBase):
 
 class OpenInteractiveScan(ScanComponent):
     scan_name = "open_interactive_scan"
-    scan_report_hint = ""
     required_kwargs = []
     arg_input = {"device": ScanArgType.DEVICE}
     arg_bundle_size = {"bundle": len(arg_input), "min": 1, "max": None}
@@ -1528,7 +1504,6 @@ class OpenInteractiveScan(ScanComponent):
 
 class AddInteractiveScanPoint(ScanComponent):
     scan_name = "interactive_scan_trigger"
-    scan_report_hint = ""
     arg_input = {"device": ScanArgType.DEVICE}
     arg_bundle_size = {"bundle": len(arg_input), "min": 1, "max": None}
 
@@ -1575,7 +1550,6 @@ class AddInteractiveScanPoint(ScanComponent):
 
 class CloseInteractiveScan(ScanComponent):
     scan_name = "close_interactive_scan"
-    scan_report_hint = ""
     arg_input = {}
     arg_bundle_size = {"bundle": len(arg_input), "min": None, "max": None}
 

{bec_server-2.12.2 → bec_server-2.12.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec-server"
-version = "2.12.2"
+version = "2.12.4"
 description = "BEC server"
 requires-python = ">=3.10"
 classifiers = [

{bec_server-2.12.2 → bec_server-2.12.4}/tests/tests_file_writer/test_file_writer.py

@@ -128,7 +128,6 @@ def test_create_device_data_storage(file_writer_manager_mock_with_dm):
                 "scan_number": 88,
                 "dataset_number": 88,
                 "exp_time": 0.1,
-                "scan_report_hint": "table",
                 "scan_report_devices": ["samx"],
                 "scan_msgs": [
                     "ScanQueueMessage(({'scan_type': 'monitor_scan', 'parameter': {'args': {'samx':"

{bec_server-2.12.2 → bec_server-2.12.4}/tests/tests_scan_server/test_scan_worker.py

@@ -1072,7 +1072,7 @@ def test_open_scan(scan_worker_mock, instr, corr_num_points, scan_id):
                             assert worker.scan_motors == ["bpm4i"]
                         init_mock.assert_called_once_with(active_rb, instr, corr_num_points)
                         assert active_rb.scan_report_instructions == [
-                            {"table_wait": corr_num_points}
+                            {"scan_progress": corr_num_points}
                         ]
                         queue_status_mock.assert_called_once()
                         send_mock.assert_called_once_with("open")
@@ -1109,7 +1109,6 @@ def test_initialize_scan_info(scan_worker_mock, msg):
         assert worker.current_scan_info["RID"] == "something"
         assert worker.current_scan_info["scan_number"] == 2
         assert worker.current_scan_info["dataset_number"] == 3
-        assert worker.current_scan_info["scan_report_hint"] == rb.scan.scan_report_hint
         assert worker.current_scan_info["scan_report_devices"] == rb.scan.scan_report_devices
         assert worker.current_scan_info["num_points"] == 100
         assert worker.current_scan_info["scan_msgs"] == []