Django: Serializers filtering out undeclared fields - django

Question

Here is my MSV:
models.py
import mongoengine
class PersonAddressModel(mongoengine.DynamicEmbeddedDocument):
country = mongoengine.fields.StringField()
town = mongoengine.fields.StringField()
class PersonModel(mongoengine.DynamicDocument):
name = mongoengine.fields.StringField()
age = mongoengine.IntField()
is_married = mongoengine.fields.BooleanField()
address = EmbeddedDocumentListField(PersonAddressModel)
serializers.py
from rest_framework_mongoengine import serializers
from .models import PersonInfoModel, PersonAddressModel
import mongoengine
class PersonAddressSerializer(serializers.EmbeddedDocumentSerializer):
class Meta:
model = PersonAddressModel
fields = '__all__'
class PersonSerializer(serializers.DynamicDocumentSerializer):
class Meta:
model = PersonModel
fields = '__all__'
views.py
from rest_framework_mongoengine import viewsets
from .serializers import PersonSerializer, PersonAddressSerializer
from rest_framework.response import Response
from rest_framework import status
import djongo
from .models import PersonModel
class PersonView(viewsets.ModelViewSet):
lookup_field = 'id'
serializer_class = PersonSerializer
def create(self, request):
serializer = self.serializer_class(data=request.data)
try:
serializer.is_valid()
serializer.save()
except djongo.sql2mongo.SQLDecodeError:
return Response(
status=status.HTTP_503_SERVICE_UNAVAILABLE
)
return Response(
status=status.HTTP_201_CREATED
)
I'm sending the following json object:
{
"name": "Helmut",
"age": 21,
"is_married": true,
"address": [{"country": "Germany", "town": "Berlin", "street": "Wolfstraße 1"}]
}
However when I check the database I see the following object:
{
"_id" : ObjectId("5b5e201c540d1c3b7a4491e8"),
"name" : "Helmut",
"age" : 21,
"is_married" : true,
"address" : [
{
"country" : "Germany",
"town" : "Berlin"
}
]
}
That's to say, Helmut's street is missing. I wonder why! My bet is that it has something to do with the serializers but I can't figure out what it is exactly.
EDIT
I want both my documents to be dynamic because some jsons may contain fields with unpredictable names and values and I have to save them as well, so I make my both model classes dynamic. However I can expand the PersonInfoModel but can't do the same with the PersonAddressModel. The street field won't show up in the DB (MongoDB).
On the other hand, I want some of the fields present in the address list to be required.

Answer 1

In your PersonAddressModel you defined only two fields, which are country and town. Which means, in DB, you defined the schema with those two fields, street is not included.
So, change your models to add extra field, as
class PersonAddressModel(mongoengine.DynamicEmbeddedDocument):
country = mongoengine.fields.StringField()
town = mongoengine.fields.StringField()
street = mongoengine.fields.StringField()
UPDATE
If your address field is dynamic and it's a dict like field, then use mongoengine.fields.DictField() as,
import mongoengine
class PersonModel(mongoengine.DynamicDocument):
name = mongoengine.fields.StringField()
age = mongoengine.IntField()
is_married = mongoengine.fields.BooleanField()
address = mongoengine.fields.DictField()
Update-2
You can do a field level validation in PersonSerializer as,
from rest_framework_mongoengine import serializers
from rest_framework import serializers as drf_serializer
class PersonSerializer(serializers.DynamicDocumentSerializer):
def validate_address(self, address):
required_fields = ['street', 'country']
if not all([True for field in required_fields if field in address]):
raise drf_serializer.ValidationError('some required fields are missing')
return address
class Meta:
model = PersonModel
fields = '__all__'
Since rest_framework_mongoengine doesnt have a ValidationError class, we using DRF's ValidationError class
UPDATE-3
Inorder to raise validation error, you have to pass True to .is_valid() (reff doc - Raising an exception on invalid data)method, as
class PersonView(viewsets.ModelViewSet):
lookup_field = 'id'
serializer_class = PersonSerializer
def create(self, request):
serializer = self.serializer_class(data=request.data)
try:
serializer.is_valid(True) # Change is here <<<<
serializer.save()
except djongo.sql2mongo.SQLDecodeError:
return Response(
status=status.HTTP_503_SERVICE_UNAVAILABLE
)
return Response(
status=status.HTTP_201_CREATED
)