Support memoryview fields in json schema

jcrist · Jan 5, 2024 · fc75a28 · fc75a28
1 parent 19a37da
commit fc75a28
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 4 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -150,6 +150,7 @@ Inspect
 .. autoclass:: StrType
 .. autoclass:: BytesType
 .. autoclass:: ByteArrayType
+.. autoclass:: MemoryViewType
 .. autoclass:: DateTimeType
 .. autoclass:: TimeType
 .. autoclass:: DateType

diff --git a/msgspec/_json_schema.py b/msgspec/_json_schema.py
@@ -247,7 +247,7 @@ def to_schema(self, t: mi.Type, check_ref: bool = True) -> dict[str, Any]:
                 schema["minLength"] = t.min_length
             if t.pattern is not None:
                 schema["pattern"] = t.pattern
-        elif isinstance(t, (mi.BytesType, mi.ByteArrayType)):
+        elif isinstance(t, (mi.BytesType, mi.ByteArrayType, mi.MemoryViewType)):
             schema["type"] = "string"
             schema["contentEncoding"] = "base64"
             if t.max_length is not None:

diff --git a/msgspec/inspect.py b/msgspec/inspect.py
@@ -53,6 +53,7 @@
     "StrType",
     "BytesType",
     "ByteArrayType",
+    "MemoryViewType",
     "DateTimeType",
     "TimeType",
     "DateType",
@@ -222,6 +223,23 @@ class ByteArrayType(Type):
     max_length: Union[int, None] = None
 
 
+class MemoryViewType(Type):
+    """A type corresponding to `memoryview`.
+
+    Parameters
+    ----------
+    min_length: int, optional
+        If set, an instance of this type must have length greater than or equal
+        to ``min_length``.
+    max_length: int, optional
+        If set, an instance of this type must have length less than or equal
+        to ``max_length``.
+    """
+
+    min_length: Union[int, None] = None
+    max_length: Union[int, None] = None
+
+
 class DateTimeType(Type):
     """A type corresponding to `datetime.datetime`.
 
@@ -803,6 +821,8 @@ def _translate_inner(
             return BytesType(min_length=min_length, max_length=max_length)
         elif t is bytearray:
             return ByteArrayType(min_length=min_length, max_length=max_length)
+        elif t is memoryview:
+            return MemoryViewType(min_length=min_length, max_length=max_length)
         elif t is datetime.datetime:
             return DateTimeType(tz=tz)
         elif t is datetime.time:

diff --git a/tests/test_inspect.py b/tests/test_inspect.py
@@ -131,7 +131,12 @@ def test_string(kw):
     [{}, dict(min_length=0), dict(max_length=3)],
 )
 @pytest.mark.parametrize(
-    "typ, info_type", [(bytes, mi.BytesType), (bytearray, mi.ByteArrayType)]
+    "typ, info_type",
+    [
+        (bytes, mi.BytesType),
+        (bytearray, mi.ByteArrayType),
+        (memoryview, mi.MemoryViewType),
+    ],
 )
 def test_binary(kw, typ, info_type):
     if kw:

diff --git a/tests/test_schema.py b/tests/test_schema.py
@@ -110,7 +110,7 @@ def test_string():
     assert msgspec.json.schema(str) == {"type": "string"}
 
 
-@pytest.mark.parametrize("typ", [bytes, bytearray])
+@pytest.mark.parametrize("typ", [bytes, bytearray, memoryview])
 def test_binary(typ):
     assert msgspec.json.schema(typ) == {
         "type": "string",
@@ -1108,7 +1108,7 @@ def test_dict_key_metadata(field, val, constraint):
     }
 
 
-@pytest.mark.parametrize("typ", [bytes, bytearray])
+@pytest.mark.parametrize("typ", [bytes, bytearray, memoryview])
 @pytest.mark.parametrize(
     "field, n, constraint",
     [("min_length", 2, "minLength"), ("max_length", 7, "maxLength")],