Merge pull request #341 from dandi/serialize-any

Serialize anys values in `DandiBaseModel`

Author: yarikoptic

dandischema/models.py

@@ -26,9 +26,11 @@
     EmailStr,
     Field,
     GetJsonSchemaHandler,
+    SerializerFunctionWrapHandler,
     StringConstraints,
     TypeAdapter,
     ValidationInfo,
+    field_serializer,
     field_validator,
     model_validator,
 )
@@ -41,6 +43,13 @@
 from .types import ByteSizeJsonSchema
 from .utils import name2title
 
+try:
+    from anys import AnyBase
+except ImportError:
+    _has_anys = False
+else:
+    _has_anys = True
+
 # Use DJANGO_DANDI_WEB_APP_URL to point to a specific deployment.
 DANDI_INSTANCE_URL: Optional[str]
 try:
@@ -508,6 +517,14 @@ def json_dict(self) -> dict:
         )
         return self.model_dump(mode="json", exclude_none=True)
 
+    if _has_anys:
+
+        @field_serializer("*", mode="wrap")
+        def preserve_anys_values(
+            self, value: Any, handler: SerializerFunctionWrapHandler
+        ) -> Any:
+            return value if isinstance(value, AnyBase) else handler(value)
+
     @field_validator("schemaKey")
     @classmethod
     def ensure_schemakey(cls, val: str) -> str:

dandischema/tests/test_models.py

@@ -3,6 +3,7 @@
 from inspect import isclass
 from typing import Any, Dict, List, Literal, Optional, Tuple, Type, Union, cast
 
+import anys
 import pydantic
 from pydantic import Field, ValidationError
 import pytest
@@ -36,6 +37,39 @@
 from ..utils import TransitionalGenerateJsonSchema
 
 
+@pytest.mark.parametrize(
+    ("y_type", "anys_value"),
+    [
+        (int, anys.ANY_INT),
+        (str, anys.ANY_STR),
+        (list, anys.ANY_LIST),
+        (dict, anys.ANY_DICT),
+    ],
+)
+def test_serialize_anys_values(y_type: type, anys_value: anys.AnyBase) -> None:
+    """
+    Test the serialization of invalid model instances constructed with the
+    `model_construct` method containing `anys` values.
+    """
+
+    class NewModel(DandiBaseModel):
+        x: int
+        y: y_type  # type: ignore[valid-type]
+
+    m = NewModel.model_construct(x=42, y=anys_value)
+
+    m_serialized = m.model_dump()
+    x = m_serialized["x"]
+    y = m_serialized["y"]
+
+    # Verify that `x` serialized as expected, as an int of value 42
+    assert type(x) is int
+    assert x == 42
+
+    # Verify that `y` serialized as itself
+    assert y is anys_value
+
+
 def test_dandiset() -> None:
     assert Dandiset.model_construct()  # type: ignore[call-arg]
 

setup.cfg

@@ -52,6 +52,7 @@ style =
     flake8
     pre-commit
 test =
+    anys
     mypy
     pytest
     pytest-cov