bec-lib 4.0.0__tar.gz → 4.0.2__tar.gz

{bec_lib-4.0.0 → bec_lib-4.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: bec_lib
-Version: 4.0.0
+Version: 4.0.2
 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-4.0.0 → bec_lib-4.0.2}/bec_lib/messages.py

@@ -731,8 +731,8 @@ class DeviceAsyncUpdate(BaseModel):
     """Model for validating async update metadata sent with device data.
 
     The async update metadata controls how data is aggregated into datasets during a scan:
-    - add: Appends data to the existing dataset along the first axis
-    - add_slice: Appends a slice of data at a specific index (max 2D datasets)
+    - add: Appends data to the existing dataset along the first axis; ignores index
+    - add_slice: Extends the contents of the row selected by a nonnegative index (2D datasets only)
     - replace: Replaces the existing dataset (written after scan completion)
 
     Args:
@@ -741,8 +741,10 @@ class DeviceAsyncUpdate(BaseModel):
                                                  Use None for unlimited dimensions. E.g., [None] for 1D unlimited.
                                                  None values must only appear at the beginning (e.g., [None, 1024] is valid, [1024, None] is not).
                                                  When all dimensions are None, maximum is 2 dimensions (e.g., [None, None] is valid, [None, None, None] is not).
-                                                 For 'add_slice' type, max_shape cannot exceed two dimensions.
-        index (int, optional): Row index for 'add_slice' operations. Required only for 'add_slice' type.
+                                                 For 'add_slice' type, max_shape must have exactly two dimensions.
+        index (int, optional): Required nonnegative row index for 'add_slice' operations.
+                              Must be smaller than max_shape[0] when the first axis is bounded.
+                              Ignored by 'add' and 'replace'. Use 'add' to append new rows.
 
     Examples:
         >>> DeviceAsyncUpdate(type="add", max_shape=[None])
@@ -783,23 +785,31 @@ class DeviceAsyncUpdate(BaseModel):
                     )
 
             # If all dimensions are None, maximum is 2 dimensions
-            if all(dim is None for dim in self.max_shape):
-                if len(self.max_shape) > 2:
-                    raise ValueError(
-                        f"Invalid max_shape {self.max_shape}: when all dimensions are None, "
-                        f"maximum number of dimensions is 2, got {len(self.max_shape)}"
-                    )
+            if all(dim is None for dim in self.max_shape) and len(self.max_shape) > 2:
+                raise ValueError(
+                    f"Invalid max_shape {self.max_shape}: when all dimensions are None, "
+                    f"maximum number of dimensions is 2, got {len(self.max_shape)}"
+                )
 
         if self.type == "add_slice":
+            max_shape = self.max_shape
             if self.index is None:
                 raise ValueError("index is required for async update type 'add_slice'")
-            if not isinstance(self.index, int) or (self.index < -1):
+            if not isinstance(self.index, int) or (self.index < 0):
+                raise ValueError(
+                    f"index must be an integer >= 0 for async update type 'add_slice', got {self.index}"
+                )
+            if max_shape is not None and len(max_shape) != 2:
                 raise ValueError(
-                    f"index must be an integer >= -1 for async update type 'add_slice', got {self.index}"
+                    "max_shape for async update type 'add_slice' must have exactly two dimensions, "
+                    f"got {len(max_shape)} dimensions"
                 )
-            if self.max_shape is not None and len(self.max_shape) > 2:
+            # max_shape is required for add_slice and has been validated above.
+            # pylint: disable-next=unsubscriptable-object
+            if max_shape is not None and max_shape[0] is not None and self.index >= max_shape[0]:
                 raise ValueError(
-                    f"max_shape for async update type 'add_slice' cannot exceed two dimensions, got {len(self.max_shape)} dimensions"
+                    "index must be smaller than max_shape[0] for async update type 'add_slice', "
+                    f"got index {self.index} with max_shape {max_shape}"
                 )
         return self
 

{bec_lib-4.0.0 → bec_lib-4.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_lib"
-version = "4.0.0"
+version = "4.0.2"
 description = "BEC library"
 requires-python = ">=3.11"
 classifiers = [

{bec_lib-4.0.0 → bec_lib-4.0.2}/tests/test_bec_messages.py

@@ -630,12 +630,11 @@ class TestDeviceAsyncUpdate:
         assert update.max_shape == [None, 1024]
         assert update.index == 5
 
-    def test_valid_add_slice_type_with_1d_max_shape(self):
-        """Test add_slice type with 1D max_shape"""
-        update = messages.DeviceAsyncUpdate(type="add_slice", max_shape=[None], index=0)
-        assert update.type == "add_slice"
-        assert update.max_shape == [None]
-        assert update.index == 0
+    @pytest.mark.parametrize("max_shape", [[None], [100]])
+    def test_invalid_add_slice_type_with_1d_max_shape(self, max_shape):
+        """Test that add_slice rejects one-dimensional target datasets."""
+        with pytest.raises(pydantic.ValidationError, match="must have exactly two dimensions"):
+            messages.DeviceAsyncUpdate(type="add_slice", max_shape=max_shape, index=0)
 
     def test_valid_add_slice_type_with_variable_size(self):
         """Test add_slice type with variable size in second dimension"""
@@ -673,7 +672,7 @@ class TestDeviceAsyncUpdate:
         """Test that add_slice type cannot have more than 2D max_shape"""
         with pytest.raises(pydantic.ValidationError) as exc_info:
             messages.DeviceAsyncUpdate(type="add_slice", max_shape=[None, 1024, 1024], index=0)
-        assert "cannot exceed two dimensions" in str(exc_info.value)
+        assert "must have exactly two dimensions" in str(exc_info.value)
 
     def test_invalid_max_shape_none_in_middle(self):
         """Test that None values cannot appear in the middle of max_shape"""
@@ -713,8 +712,7 @@ class TestDeviceAsyncUpdate:
         assert update.max_shape == max_shape
 
     @pytest.mark.parametrize(
-        "max_shape,index",
-        [([None], 0), ([None, 100], 5), ([None, None], 10), ([100], 2), ([100, 200], 15)],
+        "max_shape,index", [([None, 100], 5), ([None, None], 10), ([100, 200], 15)]
     )
     def test_valid_max_shape_patterns_for_add_slice(self, max_shape, index):
         """Test various valid max_shape patterns for add_slice type"""
@@ -768,13 +766,37 @@ class TestDeviceAsyncUpdate:
             messages.DeviceAsyncUpdate(type="add", max_shape=[None, bad_value])
         assert "all non-None dimensions must be positive integers" in str(exc_info.value)
 
-    def test_invalid_add_slice_negative_index(self):
-        """Test that negative index less than -1 is rejected for add_slice"""
+    @pytest.mark.parametrize("index", [-1, -2])
+    @pytest.mark.parametrize("max_shape", [[None, 1024], [None, None], [100, 1024]])
+    def test_invalid_add_slice_negative_index(self, index, max_shape):
+        """Test that all negative row indices are rejected for add_slice"""
         with pytest.raises(pydantic.ValidationError) as exc_info:
-            messages.DeviceAsyncUpdate(type="add_slice", max_shape=[None, 1024], index=-2)
-        assert "index must be an integer >= -1" in str(exc_info.value)
+            messages.DeviceAsyncUpdate(type="add_slice", max_shape=max_shape, index=index)
+        assert "index must be an integer >= 0" in str(exc_info.value)
+
+    @pytest.mark.parametrize("max_shape", [[4, 4], [4, 1024]])
+    @pytest.mark.parametrize("index", [4, 5])
+    def test_invalid_add_slice_index_exceeds_row_limit(self, max_shape, index):
+        """Reject indices at or beyond the finite first-axis limit."""
+        with pytest.raises(
+            pydantic.ValidationError, match=r"index must be smaller than max_shape\[0\]"
+        ):
+            messages.DeviceAsyncUpdate(type="add_slice", max_shape=max_shape, index=index)
+
+    @pytest.mark.parametrize("max_shape", [[4, 4], [4, 1024]])
+    @pytest.mark.parametrize("index", [0, 3])
+    def test_valid_add_slice_index_within_row_limit(self, max_shape, index):
+        """Both the first and last row within the finite limit are valid."""
+        update = messages.DeviceAsyncUpdate(type="add_slice", max_shape=max_shape, index=index)
+        assert update.index == index
+
+    @pytest.mark.parametrize("update_type", ["add", "replace"])
+    def test_other_update_types_ignore_index_row_limit(self, update_type):
+        """The row-index bound applies only to add_slice."""
+        update = messages.DeviceAsyncUpdate(type=update_type, max_shape=[4, 1024], index=4)
+        assert update.index == 4
 
-    @pytest.mark.parametrize("index", [0, 1, 10, 100, -1])
+    @pytest.mark.parametrize("index", [0, 1, 10, 100])
     def test_valid_add_slice_various_indices(self, index):
         """Test various valid index values for add_slice type"""
         update = messages.DeviceAsyncUpdate(type="add_slice", max_shape=[None, 1024], index=index)