bec-lib 3.146.2__tar.gz → 3.147.0__tar.gz

{bec_lib-3.146.2 → bec_lib-3.147.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_lib
-Version: 3.146.2
+Version: 3.147.0
 Summary: BEC library
 Project-URL: Bug Tracker, https://github.com/bec-project/bec/issues
 Project-URL: Homepage, https://github.com/bec-project/bec

{bec_lib-3.146.2 → bec_lib-3.147.0}/bec_lib/endpoints.py

@@ -424,6 +424,31 @@ class MessageEndpoints:
             endpoint=endpoint, message_type=messages.DeviceMessage, message_op=MessageOp.STREAM
         )
 
+    @staticmethod
+    def device_async_signal_index(scan_id: str, device: str, signal: str):
+        """
+        Endpoint for async device signal index updates.
+        This endpoint is used by the device server to publish per-message index
+        information for async signals using a messages.DeviceAsyncSignalIndexMessage
+        message. Index data is scoped to the async signal stream.
+
+        Args:
+            scan_id (str): unique scan identifier
+            device (str): Device name, e.g. "mcs".
+            signal (str): Signal name, e.g. "image".
+
+        Returns:
+            EndpointInfo: Endpoint for device async signal index updates.
+        """
+        endpoint = (
+            f"{EndpointType.INFO.value}/devices/async_signal_index/{scan_id}/{device}/{signal}"
+        )
+        return EndpointInfo(
+            endpoint=endpoint,
+            message_type=messages.DeviceAsyncSignalIndexMessage,
+            message_op=MessageOp.LIST,
+        )
+
     @staticmethod
     def device_monitor_2d(device: str):
         """

{bec_lib-3.146.2 → bec_lib-3.147.0}/bec_lib/messages.py

@@ -689,6 +689,36 @@ class DeviceMessage(BECMessage):
         return v
 
 
+class DeviceAsyncSignalIndexMessage(BECMessage):
+    """Message type for sending device async signal index information from the device server
+
+    This message is used to send index information for async signals emitted by the device server. It is published to a
+    separate Redis list and is meant as a companion message to the DeviceMessage that contains the async signal data.
+    The DeviceAsyncSignalIndexMessage contains information about the shapes of the async signals
+    that are being emitted and can be used to keep track of offsets, even after the raw data stream has already been
+    evicted from Redis. The indices are managed on the device server side and are incremented for each new async signal emitted.
+
+    Args:
+        scan_id (str): Unique scan ID
+        device (str): Name of the device emitting the async signals
+        signal (str): Name of the async signal being emitted
+        shapes (dict[str, list[int]]): Dictionary containing the shapes of the async signals being emitted, keyed by signal name
+        indices (dict[str, int]): Dictionary containing the current indices of the async signals being emitted, keyed by signal name.
+                                    The index starts at 0 and is incremented for each new async signal emitted and can be used to
+                                    keep track of offsets in the raw data stream.
+        async_update (DeviceAsyncUpdate): Metadata controlling how data is aggregated into datasets during a scan. See DeviceAsyncUpdate for details.
+    """
+
+    msg_type: ClassVar[str] = "device_async_signal_index"
+
+    scan_id: str
+    device: str
+    signal: str
+    shapes: dict[str, list[int]]
+    indices: dict[str, int]
+    async_update: DeviceAsyncUpdate
+
+
 class DeviceAsyncUpdate(BaseModel):
     """Model for validating async update metadata sent with device data.
 

{bec_lib-3.146.2 → bec_lib-3.147.0}/bec_lib/tests/utils.py

@@ -583,9 +583,9 @@ class ConnectorMock(RedisConnector):  # pragma: no cover
             pipe._pipe_buffer.append(("lpush", (topic, msg), {}))
             return
 
-    def rpush(self, topic, msg, pipe=None):
+    def rpush(self, topic, msg, pipe=None, expire: int = None):
         if pipe:
-            pipe._pipe_buffer.append(("rpush", (topic, msg), {}))
+            pipe._pipe_buffer.append(("rpush", (topic, msg), {"expire": expire}))
             return
         pass
 

{bec_lib-3.146.2 → bec_lib-3.147.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_lib"
-version = "3.146.2"
+version = "3.147.0"
 description = "BEC library"
 requires-python = ">=3.11"
 classifiers = [
@@ -94,6 +94,7 @@ Homepage = "https://github.com/bec-project/bec"
 
 
 
+
 
 
 [tool.hatch.build.targets.wheel]

{bec_lib-3.146.2 → bec_lib-3.147.0}/tests/test_bec_messages.py

@@ -62,6 +62,21 @@ def test_device_message_with_invalid_async_update():
         )
 
 
+def test_device_async_signal_index_message():
+    msg = messages.DeviceAsyncSignalIndexMessage(
+        scan_id="scan-1",
+        device="waveform",
+        signal="waveform_data",
+        shapes={"waveform_a": [2], "waveform_b": []},
+        indices={"waveform_a": 0, "waveform_b": 3},
+        async_update=messages.DeviceAsyncUpdate(type="add", max_shape=[None]),
+    )
+    res = MsgpackSerialization.dumps(msg)
+    res_loaded = MsgpackSerialization.loads(res)
+
+    assert res_loaded == msg
+
+
 def test_bundled_message():
     sub_msg = messages.DeviceMessage(signals={"samx": {"value": 5.2}}, metadata={"RID": "1234"})
     msg = messages.BundleMessage()