Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Django serialization support #41

Merged
merged 2 commits into from
Jan 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion django_pydantic_field/v1/fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
from django.db.models.fields.json import JSONField
from django.db.models.query_utils import DeferredAttribute

from django_pydantic_field.compat.django import GenericContainer, GenericTypes
from django_pydantic_field.compat.django import GenericContainer

from . import base, forms, utils

Expand Down Expand Up @@ -125,6 +125,10 @@ def formfield(self, **kwargs):
field_kwargs.update(kwargs)
return super().formfield(**field_kwargs)

def value_to_string(self, obj):
value = self.value_from_object(obj)
return self.get_prep_value(value)

def _resolve_schema(self, schema):
schema = t.cast(t.Type["base.ST"], GenericContainer.unwrap(schema))

Expand Down
10 changes: 10 additions & 0 deletions django_pydantic_field/v2/fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
if ty.TYPE_CHECKING:
import json
import typing_extensions as te
from django.db.models import Model

class _SchemaFieldKwargs(types.ExportKwargs, total=False):
# django.db.models.fields.Field kwargs
Expand Down Expand Up @@ -148,6 +149,11 @@ def validate(self, value: ty.Any, model_instance: ty.Any) -> None:
return super(JSONField, self).validate(value, model_instance)

def to_python(self, value: ty.Any):
try:
value = self.adapter.validate_json(value)
except ValueError:
"""This is an expected error, this step is required to parse serialized values."""

try:
return self.adapter.validate_python(value)
except pydantic.ValidationError as exc:
Expand Down Expand Up @@ -187,6 +193,10 @@ def formfield(self, **kwargs):
field_kwargs.update(kwargs)
return super().formfield(**field_kwargs) # type: ignore

def value_to_string(self, obj: Model):
value = super().value_from_object(obj)
return self.get_prep_value(value)


class SchemaKeyTransformAdapter:
"""An adapter for creating key transforms for schema field lookups."""
Expand Down
27 changes: 27 additions & 0 deletions tests/test_e2e_models.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from datetime import date

import pytest
from django.core import serializers
from django.db.models import F, Q, JSONField, Value

from tests.conftest import InnerSchema
Expand Down Expand Up @@ -46,6 +47,32 @@ def test_model_db_serde(initial_payload, expected_values):
assert instance_values == expected_values


@pytest.mark.parametrize("format", ["python", "json", "yaml", "jsonl"])
@pytest.mark.parametrize(
"payload",
[
{
"sample_field": InnerSchema(stub_str="abc", stub_list=[date(2023, 6, 1)]),
"sample_list": [InnerSchema(stub_str="abc", stub_list=[])],
},
{
"sample_field": {"stub_str": "abc", "stub_list": ["2023-06-01"]},
"sample_list": [{"stub_str": "abc", "stub_list": []}],
},
],
)
def test_model_serialization(payload, format):
instance = SampleModel(**payload)
instance_values = {k: getattr(instance, k) for k in payload.keys()}

serialized_instances = serializers.serialize(format, [instance])
deserialized_instance = next(serializers.deserialize(format, serialized_instances)).object
deserialized_values = {k: getattr(deserialized_instance, k) for k in payload.keys()}

assert instance_values == deserialized_values
assert serialized_instances == serializers.serialize(format, [deserialized_instance])


@pytest.mark.parametrize(
"lookup",
[
Expand Down