tried to add test

bluesky · Sep 30, 2024 · 5012385 · 5012385
1 parent 6ecc29e
commit 5012385
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 4 deletions.
diff --git a/event_model/documents/event_descriptor.py b/event_model/documents/event_descriptor.py
@@ -23,7 +23,14 @@ class Limits(TypedDict):
     warning: NotRequired[Annotated[LimitsRange, Field(description="Warning limits.")]]
     alarm: NotRequired[Annotated[LimitsRange, Field(description="Alarm limits.")]]
 
-_ConstrainedDtype = Annotated[str, Field(description="A numpy dtype e.g `<U9` `<f16`" ,pattern="[|<>][tbiufcmMOSUV][0-9]+")]
+_ConstrainedDtype = Annotated[
+    str,
+    Field(
+        description="A numpy dtype e.g `<U9`, `<f16`",
+        pattern="[|<>][tbiufcmMOSUV][0-9]+"
+    )
+]
+_ConstrainedDtypeNpStructure = Tuple[str, _ConstrainedDtype]
 class DataKey(TypedDict):
     """Describes the objects in the data property of Event documents"""
 
@@ -48,7 +55,9 @@ class DataKey(TypedDict):
         Annotated[
             Union[
                 _ConstrainedDtype,
-                List[Tuple[str, _ConstrainedDtype]],
+                List[
+                    _ConstrainedDtypeNpStructure
+                ]
             ],
             Field(
                 description="The type of the data in the event, given as a numpy dtype string (or, for structured dtypes, array).",

diff --git a/event_model/schemas/event_descriptor.json b/event_model/schemas/event_descriptor.json
@@ -65,7 +65,7 @@
                     "description": "The type of the data in the event, given as a numpy dtype string (or, for structured dtypes, array).",
                     "anyOf": [
                         {
-                            "description": "A numpy dtype e.g `<U9` `<f16`",
+                            "description": "A numpy dtype e.g `<U9`, `<f16`",
                             "pattern": "[|<>][tbiufcmMOSUV][0-9]+",
                             "type": "string"
                         },
@@ -78,7 +78,7 @@
                                         "type": "string"
                                     },
                                     {
-                                        "description": "A numpy dtype e.g `<U9` `<f16`",
+                                        "description": "A numpy dtype e.g `<U9`, `<f16`",
                                         "pattern": "[|<>][tbiufcmMOSUV][0-9]+",
                                         "type": "string"
                                     }

diff --git a/event_model/tests/test_auth.py b/event_model/tests/test_auth.py
@@ -73,3 +73,29 @@ def test_dots_not_allowed_in_keys():
     doc.update({".b": "c"})
     with pytest.raises(jsonschema.ValidationError):
         schema_validators[DocumentNames.stop].validate(doc)
+
+
+@pytest.mark.parametrize(
+        "dtype_numpy", [
+            "Z",
+            "i",
+            "i4",
+            "4i",
+            "i>4",
+            ">i",
+            [("some_str", "Z")],
+        ]
+)
+def test_bad_numpy_datakeys(dtype_numpy):
+    descriptor = {
+        "time": 0,
+        "uid": new_uid(),
+        "data_keys": {
+            "a": {
+                "source": "", "dtype": "number", "shape": [], "dtype_numpy": dtype_numpy
+            }
+        },
+        "run_start": new_uid(),
+    }
+    with pytest.raises(jsonschema.ValidationError):
+        schema_validators[DocumentNames.descriptor].validate(descriptor)