removed block_idx from StreamDatum

bluesky · Aug 14, 2023 · 3856a88 · 3856a88
1 parent 0813db2
commit 3856a88
Show file tree

Hide file tree

Showing 4 changed files with 1 addition and 19 deletions.
diff --git a/docs/user/explanations/data-model.rst b/docs/user/explanations/data-model.rst
@@ -526,7 +526,6 @@ Minimal nontrivial valid example:
    {'resource': '272132cf-564f-428f-bf6b-149ee4287024',  # foreign key
     'datum_kwargs': {},  # format-specific parameters
     'datum_id': '272132cf-564f-428f-bf6b-149ee4287024/1',
-    'block_idx': 0,
     'event_count': 1
     }
 
@@ -538,7 +537,6 @@ Typical example:
    {'resource': '3b300e6f-b431-4750-a635-5630d15c81a8',
     'datum_kwargs': {'index': 3},
     'datum_id': '3b300e6f-b431-4750-a635-5630d15c81a8/3',
-    'block_idx': 0,
     'event_count': 5,
     'event_offset': 14}
 

diff --git a/event_model/__init__.py b/event_model/__init__.py
@@ -2010,11 +2010,9 @@ def __call__(
         validate: bool = True,
     ) -> StreamDatum:
         resource_uid = self.stream_resource["uid"]
-        block_idx = next(self.counter)
         doc = StreamDatum(
             stream_resource=resource_uid,
-            uid=f"{resource_uid}/{block_idx}",
-            block_idx=block_idx,
+            uid=f"{resource_uid}/{next(self.counter)}",
             data_keys=data_keys,
             seq_nums=seq_nums,
             indices=indices,

diff --git a/event_model/documents/stream_datum.py b/event_model/documents/stream_datum.py
@@ -29,14 +29,6 @@ class StreamDatum(TypedDict):
         str,
         Field(description="UID of the EventDescriptor to " "which this Datum belongs"),
     ]
-
-    block_idx: Annotated[
-        int,
-        Field(
-            description="The order in the stream of this block of data. This must "
-            "be contiguous for a given stream.",
-        ),
-    ]
     stream_resource: Annotated[
         str,
         Field(

diff --git a/event_model/schemas/stream_datum.json b/event_model/schemas/stream_datum.json
@@ -26,11 +26,6 @@
       }
    },
    "properties": {
-      "block_idx": {
-         "title": "Block Idx",
-         "description": "The order in the stream of this block of data. This must be contiguous for a given stream.",
-         "type": "integer"
-      },
       "data_keys": {
          "title": "Data Keys",
          "description": "A list to show which data_keys of the Descriptor are being streamed",
@@ -74,7 +69,6 @@
       }
    },
    "required": [
-      "block_idx",
       "data_keys",
       "descriptor",
       "indices",