diff --git a/rest_framework/serializers.py b/rest_framework/serializers.py index ba9e9e9cf..f3e89abab 100644 --- a/rest_framework/serializers.py +++ b/rest_framework/serializers.py @@ -99,7 +99,7 @@ class SerializerOptions(object): self.exclude = getattr(meta, 'exclude', ()) -class BaseSerializer(Field): +class BaseSerializer(WritableField): """ This is the Serializer implementation. We need to implement it as `BaseSerializer` due to metaclass magicks. @@ -111,24 +111,27 @@ class BaseSerializer(Field): _dict_class = SortedDictWithMetadata def __init__(self, instance=None, data=None, files=None, - context=None, partial=False, many=None, source=None): + context=None, partial=False, many=None, source=None, required=True): super(BaseSerializer, self).__init__(source=source) self.opts = self._options_class(self.Meta) self.parent = None self.root = None self.partial = partial self.many = many + self.required = required self.context = context or {} self.init_data = data self.init_files = files self.object = instance + self.unused_objects = instance self.fields = self.get_fields() self._data = None self._files = None self._errors = None + self._delete = False ##### # Methods to determine which fields to use when (de)serializing objects. @@ -215,7 +218,10 @@ class BaseSerializer(Field): try: field.field_from_native(data, files, field_name, reverted_data) except ValidationError as err: - self._errors[field_name] = list(err.messages) + if hasattr(err, 'message_dict'): + self._errors[field_name] = [err.message_dict] + else: + self._errors[field_name] = list(err.messages) return reverted_data @@ -281,13 +287,50 @@ class BaseSerializer(Field): ret.fields[key] = field return ret - def from_native(self, data, files): + def _get_object_from_data(self, data): + """ + Get the corresponding object to deserialize the data into. + """ + if self.unused_objects is None: return None + + # Just get the first object in the list. + if self.unused_objects: + obj = self.unused_objects[0] + obj = obj[0] + self.unused_objects.remove(obj) + else: + obj = None + + return obj + + def from_native(self, data, files, many=False): """ Deserialize primitives -> objects. """ - if hasattr(data, '__iter__') and not isinstance(data, (dict, six.text_type)): - # TODO: error data when deserializing lists - return [self.from_native(item, None) for item in data] + if many: + # Both our object and data must be in list form + if ((data is not None and not (hasattr(data, '__iter__') and not isinstance(data, (Page, dict)))) or + (self.object is not None and not (hasattr(self.object, '__iter__') and not isinstance(self.object, (Page, dict))))): + self._errors = {'non_field_errors': ['Invalid data']} + return None + + self._siblings = [] + self._errors = [] + for item in data: + obj = self._get_object_from_data(item) + # Deserializng a list of objects requires a separate + # serializer for each object (otherwise nested objects + # would share the nested serializers) + sibling = self.__class__(obj, data=item, many=False) + self._siblings.append(sibling) + sibling.object = sibling.from_native(item, None) + self._errors.append(sibling._errors) + for obj in self.unused_objects or []: + # Unused objects will be deleted. + sibling = self.__class__(obj) + sibling._delete = True + self._siblings.append(sibling) + return [sibling.object for sibling in self._siblings] self._errors = {} if data is not None or files is not None: @@ -354,10 +397,7 @@ class BaseSerializer(Field): 'Use the `many=True` flag when instantiating the serializer.', PendingDeprecationWarning, stacklevel=3) - # TODO: error data when deserializing lists - if many: - ret = [self.from_native(item, None) for item in data] - ret = self.from_native(data, files) + ret = self.from_native(data, files, many) if not self._errors: self.object = ret @@ -418,6 +458,59 @@ class ModelSerializer(Serializer): """ _options_class = ModelSerializerOptions + def _get_object_from_data(self, data): + """ + Get the corresponding object to deserialize the data into. + """ + if self.unused_objects is None: return None + + # Get the object based on pk + pk_field_name = self.opts.model._meta.pk.name + pk = data.get(pk_field_name, None) + if pk: + # Loop through objects and find one with pk or return None + obj = [o for o in self.unused_objects if o.pk == pk] + if obj: + obj = obj[0] + self.unused_objects.remove(obj) + else: + obj = None + return obj + else: + return None + + def field_from_native(self, data, files, field_name, into): + if self.read_only: + return + + try: + value = data[field_name] + except KeyError: + if self.required: + raise ValidationError(self.error_messages['required']) + return + + if self.parent.object: + # Set the serializer object if it exists + obj = getattr(self.parent.object, field_name) + if is_simple_callable(getattr(obj, 'all', None)): + # If this is a relational manager we just want the objects + obj = list(obj.all()) + self.object = obj + self.unused_objects = obj + + if value in (None, ''): + self._delete = True + into[(self.source or field_name)] = self + else: + obj = self.from_native(value, files, self.many) + if not any(self._errors): + self.object = obj + into[self.source or field_name] = self + else: + # Propagate errors up to our parent + raise ValidationError(self._errors) + field_mapping = { models.AutoField: IntegerField, models.FloatField: FloatField, @@ -603,18 +696,32 @@ class ModelSerializer(Serializer): return instance - def from_native(self, data, files): + def from_native(self, data, files, many=False): """ Override the default method to also include model field validation. """ - instance = super(ModelSerializer, self).from_native(data, files) - if instance: - return self.full_clean(instance) + instance = super(ModelSerializer, self).from_native(data, files, many) + if self.many and hasattr(self, '_siblings'): + objects = [s.full_clean(s.object) if s.object else None for s in self._siblings] + self._errors = [s._errors for s in self._siblings] + return objects + else: + if instance: + return self.full_clean(instance) + + def _save(self, parent=None, fk_field=None): + if self.many: + for s in self._siblings: + s._save(parent, fk_field) + return + + if self._delete: + self.object.delete() + return + + if parent and fk_field: + setattr(self.object, fk_field, parent) - def save(self): - """ - Save the deserialized object and return it. - """ self.object.save() if getattr(self, 'm2m_data', None): @@ -624,9 +731,18 @@ class ModelSerializer(Serializer): if getattr(self, 'related_data', None): for accessor_name, object_list in self.related_data.items(): - setattr(self.object, accessor_name, object_list) + if isinstance(object_list, ModelSerializer): + fk_field = self.object._meta.get_field_by_name(accessor_name)[0].field.name + object_list._save(parent=self.object, fk_field=fk_field) + else: + setattr(self.object, accessor_name, object_list) self.related_data = {} - + + def save(self): + """ + Save the deserialized object and return it. + """ + self._save() return self.object diff --git a/rest_framework/tests/nesting.py b/rest_framework/tests/nesting.py new file mode 100644 index 000000000..a55ac9744 --- /dev/null +++ b/rest_framework/tests/nesting.py @@ -0,0 +1,241 @@ +from __future__ import unicode_literals +from django.db import models +from django.test import TestCase +from rest_framework import serializers + + +class OneToManyTarget(models.Model): + name = models.CharField(max_length=100) + + +class OneToManyTargetSource(models.Model): + name = models.CharField(max_length=100) + target = models.ForeignKey(OneToManyTarget, + related_name='target_sources') + + +class OneToManySource(models.Model): + name = models.CharField(max_length=100) + target_source = models.ForeignKey(OneToManyTargetSource, + related_name='sources') + + +class OneToManySource(models.Model): + name = models.CharField(max_length=100) + target = models.ForeignKey(OneToManyTarget, + related_name='sources') + + +class OneToOneTarget(models.Model): + name = models.CharField(max_length=100) + + +class OneToOneTargetSource(models.Model): + name = models.CharField(max_length=100) + target = models.OneToOneField(OneToOneTarget, null=True, blank=True, + related_name='target_source') + + +class OneToOneSource(models.Model): + name = models.CharField(max_length=100) + target_source = models.OneToOneField(OneToOneTargetSource, related_name='source') + + +class OneToOneSourceSerializer(serializers.ModelSerializer): + class Meta: + model = OneToOneSource + exclude = ('target_source', ) + + +class OneToOneTargetSourceSerializer(serializers.ModelSerializer): + source = OneToOneSourceSerializer() + + class Meta: + model = OneToOneTargetSource + exclude = ('target', ) + +class OneToOneTargetSerializer(serializers.ModelSerializer): + target_source = OneToOneTargetSourceSerializer() + + class Meta: + model = OneToOneTarget + + +class OneToManySourceSerializer(serializers.ModelSerializer): + class Meta: + model = OneToManySource + exclude = ('target_source', ) + + +class OneToManyTargetSourceSerializer(serializers.ModelSerializer): + sources = OneToManySourceSerializer(many=True, required=False) + + class Meta: + model = OneToManyTargetSource + exclude = ('target', ) + + +class OneToManyTargetSerializer(serializers.ModelSerializer): + target_sources = OneToManyTargetSourceSerializer(many=True) + + class Meta: + model = OneToManyTarget + + +class NestedOneToManyTests(TestCase): + def setUp(self): + target = OneToManyTarget(name='target-1') + target.save() + target_source = OneToManyTargetSource(name='target-source-1', target=target) + target_source.save() + for idx in range(1, 4): + source = OneToManySource(name='source-%d' % idx, target_source=target_source) + source.save() + + def test_one_to_many_retrieve(self): + queryset = OneToManyTarget.objects.all() + serializer = OneToManyTargetSerializer(queryset) + expected = [ + {'id': 1, 'name': 'target-1', 'target_sources': [{'id': 1, 'name': 'target-source-1', 'sources': [{'id': 1, 'name': 'source-1'}, {'id': 2, 'name': 'source-2'}, {'id': 3, 'name': 'source-3'}]}]} + ] + self.assertEquals(serializer.data, expected) + + def test_one_to_many_create(self): + # Note the nonsensical source id given + data = {'id': 2, 'name': 'target-2', 'target_sources': [{'id': 2, 'name': 'target-source-2', 'sources': [{'id': 2, 'name': 'source-4'}]}]} + expected = {'id': 2, 'name': 'target-2', 'target_sources': [{'id': 2, 'name': 'target-source-2', 'sources': [{'id': 4, 'name': 'source-4'}]}]} + serializer = OneToManyTargetSerializer(data=data) + self.assertTrue(serializer.is_valid()) + obj = serializer.save() + self.assertEquals(serializer.data, expected) + self.assertEqual(obj.name, 'target-2') + + # Ensure (target 4, target_source 4, source 4) are added, and + # everything else is as expected. + queryset = OneToManyTarget.objects.all() + serializer = OneToManyTargetSerializer(queryset) + expected = [ + {'id': 1, 'name': 'target-1', 'target_sources': [{'id': 1, 'name': 'target-source-1', 'sources': [{'id': 1, 'name': 'source-1'}, {'id': 2, 'name': 'source-2'}, {'id': 3, 'name': 'source-3'}]}]}, + {'id': 2, 'name': 'target-2', 'target_sources': [{'id': 2, 'name': 'target-source-2', 'sources': [{'id': 4, 'name': 'source-4'}]}]} + ] + self.assertEquals(serializer.data, expected) + + def test_one_to_many_update(self): + data = {'id': 1, 'name': 'target-1-updated', 'target_sources': [{'id': 1, 'name': 'target-source-1-updated', 'sources': [{'id': 1, 'name': 'source-1-updated'}, {'id': 2, 'name': 'source-2'}, {'id': 3, 'name': 'source-3'}]}]} + expected = {'id': 1, 'name': 'target-1-updated', 'target_sources': [{'id': 1, 'name': 'target-source-1-updated', 'sources': [{'id': 1, 'name': 'source-1-updated'}, {'id': 2, 'name': 'source-2'}, {'id': 3, 'name': 'source-3'}]}]} + instance = OneToManyTarget.objects.get(pk=1) + serializer = OneToManyTargetSerializer(instance, data=data) + self.assertTrue(serializer.is_valid()) + obj = serializer.save() + self.assertEquals(serializer.data, expected) + self.assertEqual(obj.name, 'target-1-updated') + + # Ensure (target 1, target_source 1, source 1) are updated, + # and everything else is as expected. + queryset = OneToManyTarget.objects.all() + serializer = OneToManyTargetSerializer(queryset) + expected = [ + {'id': 1, 'name': 'target-1-updated', 'target_sources': [{'id': 1, 'name': 'target-source-1-updated', 'sources': [{'id': 1, 'name': 'source-1-updated'}, {'id': 2, 'name': 'source-2'}, {'id': 3, 'name': 'source-3'}]}]} + ] + self.assertEquals(serializer.data, expected) + + def test_one_to_many_delete(self): + data = {'id': 1, 'name': 'target-1', 'target_sources': [{'id': 1, 'name': 'target-source-1', 'sources': [{'id': 2, 'name': 'source-2'}]}]} + instance = OneToManyTarget.objects.get(pk=1) + serializer = OneToManyTargetSerializer(instance, data=data) + self.assertTrue(serializer.is_valid()) + obj = serializer.save() + + # Ensure target_source 1 is deleted, and everything else is as + # expected. + queryset = OneToManyTarget.objects.all() + serializer = OneToManyTargetSerializer(queryset) + expected = [ + {'id': 1, 'name': 'target-1', 'target_sources': [{'id': 1, 'name': 'target-source-1', 'sources': [{'id': 2, 'name': 'source-2'}]}]} + ] + self.assertEquals(serializer.data, expected) + + +class NestedOneToOneTests(TestCase): + def setUp(self): + for idx in range(1, 4): + target = OneToOneTarget(name='target-%d' % idx) + target.save() + target_source = OneToOneTargetSource(name='target-source-%d' % idx, target=target) + target_source.save() + source = OneToOneSource(name='source-%d' % idx, target_source=target_source) + source.save() + + def test_one_to_one_retrieve(self): + queryset = OneToOneTarget.objects.all() + serializer = OneToOneTargetSerializer(queryset) + expected = [ + {'id': 1, 'name': 'target-1', 'target_source': {'id': 1, 'name': 'target-source-1', 'source': {'id': 1, 'name': 'source-1'}}}, + {'id': 2, 'name': 'target-2', 'target_source': {'id': 2, 'name': 'target-source-2', 'source': {'id': 2, 'name': 'source-2'}}}, + {'id': 3, 'name': 'target-3', 'target_source': {'id': 3, 'name': 'target-source-3', 'source': {'id': 3, 'name': 'source-3'}}} + ] + self.assertEquals(serializer.data, expected) + + def test_one_to_one_create(self): + data = {'id': 4, 'name': 'target-4', 'target_source': {'id': 4, 'name': 'target-source-4', 'source': {'id': 4, 'name': 'source-4'}}} + serializer = OneToOneTargetSerializer(data=data) + self.assertTrue(serializer.is_valid()) + obj = serializer.save() + self.assertEquals(serializer.data, data) + self.assertEqual(obj.name, 'target-4') + + # Ensure (target 4, target_source 4, source 4) are added, and + # everything else is as expected. + queryset = OneToOneTarget.objects.all() + serializer = OneToOneTargetSerializer(queryset) + expected = [ + {'id': 1, 'name': 'target-1', 'target_source': {'id': 1, 'name': 'target-source-1', 'source': {'id': 1, 'name': 'source-1'}}}, + {'id': 2, 'name': 'target-2', 'target_source': {'id': 2, 'name': 'target-source-2', 'source': {'id': 2, 'name': 'source-2'}}}, + {'id': 3, 'name': 'target-3', 'target_source': {'id': 3, 'name': 'target-source-3', 'source': {'id': 3, 'name': 'source-3'}}}, + {'id': 4, 'name': 'target-4', 'target_source': {'id': 4, 'name': 'target-source-4', 'source': {'id': 4, 'name': 'source-4'}}} + ] + self.assertEquals(serializer.data, expected) + + def test_one_to_one_create_with_invalid_data(self): + data = {'id': 4, 'name': 'target-4', 'target_source': {'id': 4, 'name': 'target-source-4', 'source': {'id': 4}}} + serializer = OneToOneTargetSerializer(data=data) + self.assertFalse(serializer.is_valid()) + self.assertEquals(serializer.errors, {'target_source': [{'source': [{'name': ['This field is required.']}]}]}) + + def test_one_to_one_update(self): + data = {'id': 3, 'name': 'target-3-updated', 'target_source': {'id': 3, 'name': 'target-source-3-updated', 'source': {'id': 3, 'name': 'source-3-updated'}}} + instance = OneToOneTarget.objects.get(pk=3) + serializer = OneToOneTargetSerializer(instance, data=data) + self.assertTrue(serializer.is_valid()) + obj = serializer.save() + self.assertEquals(serializer.data, data) + self.assertEqual(obj.name, 'target-3-updated') + + # Ensure (target 3, target_source 3, source 3) are updated, + # and everything else is as expected. + queryset = OneToOneTarget.objects.all() + serializer = OneToOneTargetSerializer(queryset) + expected = [ + {'id': 1, 'name': 'target-1', 'target_source': {'id': 1, 'name': 'target-source-1', 'source': {'id': 1, 'name': 'source-1'}}}, + {'id': 2, 'name': 'target-2', 'target_source': {'id': 2, 'name': 'target-source-2', 'source': {'id': 2, 'name': 'source-2'}}}, + {'id': 3, 'name': 'target-3-updated', 'target_source': {'id': 3, 'name': 'target-source-3-updated', 'source': {'id': 3, 'name': 'source-3-updated'}}} + ] + self.assertEquals(serializer.data, expected) + + def test_one_to_one_delete(self): + data = {'id': 3, 'name': 'target-3', 'target_source': None} + instance = OneToOneTarget.objects.get(pk=3) + serializer = OneToOneTargetSerializer(instance, data=data) + self.assertTrue(serializer.is_valid()) + obj = serializer.save() + + # Ensure (target_source 3, source 3) are deleted, + # and everything else is as expected. + queryset = OneToOneTarget.objects.all() + serializer = OneToOneTargetSerializer(queryset) + expected = [ + {'id': 1, 'name': 'target-1', 'target_source': {'id': 1, 'name': 'target-source-1', 'source': {'id': 1, 'name': 'source-1'}}}, + {'id': 2, 'name': 'target-2', 'target_source': {'id': 2, 'name': 'target-source-2', 'source': {'id': 2, 'name': 'source-2'}}}, + {'id': 3, 'name': 'target-3', 'target_source': None} + ] + self.assertEquals(serializer.data, expected)