Подтвердить что ты не робот

Записываемый вложенный сериализатор с существующими объектами с использованием Django Rest Framework 3.2.2

Рассмотрим модель листинга с соответствующей категорией. Я хочу создать новый список для существующей категории, выполнив POST с данными: {"title": "myapp", "category": {"name": "Business"}}, где title - это заголовок листинга, который должен быть создан, а Business - это имя существующей категории, используемой для этого нового списка.

Когда я пытаюсь сделать такой запрос и создаю экземпляр ListingSerializer для этого, я получаю сообщение об ошибке, указывающее, что имя категории должно быть уникальным - я не хочу создавать новую категорию, но вместо нее использовать существующую, Я попытался установить валидаторы в поле категории на [], но это не изменило поведение.

Я могу использовать SlugRelatedField, но это заставляет мои данные запроса больше напоминать {"title": "myapp", "category": "Business"}, чего я не хочу. Я попытался использовать аргумент source для SlugRelatedField для указания вложенных отношений, но это тоже не сработало:

category = serializers.SlugRelatedField(
        slug_field='category.name',
        queryset=models.Category.objects.all()
    )

дает:

  "category": [
    "Object with name={'name': 'Business'} does not exist."
  ]

models.py:

import django.contrib.auth
from django.db import models
from django.conf import settings

class Profile(models.Model):
    display_name = models.CharField(max_length=255)
    user = models.OneToOneField(settings.AUTH_USER_MODEL)

class Category(models.Model):
    name = models.CharField(max_length=50, unique=True)
    description = models.CharField(max_length=200)

class Listing(models.Model):
    title = models.CharField(max_length=50, unique=True)
    category = models.ForeignKey(Category, related_name='listings', null=True)
    owners = models.ManyToManyField(
        Profile,
        related_name='owned_listings',
        db_table='profile_listing',
        blank=True
    )

serializers.py:

import logging
import django.contrib.auth
from rest_framework import serializers
import myapp.models as models

logger = logging.getLogger('mylogger')

class ShortUserSerializer(serializers.ModelSerializer):
    class Meta:
        model = django.contrib.auth.models.User
        fields = ('username', 'email')

class ProfileSerializer(serializers.ModelSerializer):
    user = ShortUserSerializer()
    class Meta:
        model = models.Profile
        fields = ('user', 'display_name')
        read_only = ('display_name',)

class CategorySerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Category
        fields = ('name', 'description')
        read_only = ('description',)


class ListingSerializer(serializers.ModelSerializer):
    owners = ProfileSerializer(required=False, many=True)
    # TODO: how to indicate that this should look for an existing category?
    category = CategorySerializer(required=False, validators=[])

    class Meta:
        model = models.Listing
        depth = 2

    def validate(self, data):
        logger.info('inside ListingSerializer validate')
        return data

    def create(self, validated_data):
        logger.info('inside ListingSerializer.create')
        # not even getting this far...

views.py:

import logging

from django.http import HttpResponse
from django.shortcuts import get_object_or_404

import django.contrib.auth

from rest_framework import viewsets
from rest_framework.response import Response

import myapp.serializers as serializers
import myapp.models as models


# Get an instance of a logger
logger = logging.getLogger('mylogger')

class CategoryViewSet(viewsets.ModelViewSet):
    queryset = models.Category.objects.all()
    serializer_class = serializers.CategorySerializer

class UserViewSet(viewsets.ModelViewSet):
    queryset = django.contrib.auth.models.User.objects.all()
    serializer_class = serializers.ShortUserSerializer

class ProfileViewSet(viewsets.ModelViewSet):
    queryset = models.Profile.objects.all()
    serializer_class = serializers.ProfileSerializer

class ListingViewSet(viewsets.ModelViewSet):
    logger.info('inside ListingSerializerViewSet')
    queryset = models.Listing.objects.all()
    serializer_class = serializers.ListingSerializer

Полный пример: https://github.com/arw180/drf-example

4b9b3361

Ответ 1

Это не идеально, но я нашел решение, которое разрешило мою проблему (я жду, чтобы принять его как ответ, надеясь, что кто-то другой сможет сделать лучше). Есть две части:

Во-первых, используйте аргумент partial=True при инициализации ListingSerializer (http://www.django-rest-framework.org/api-guide/serializers/#partial-updates). Затем используйте метод serializer validate, чтобы получить фактический экземпляр модели, соответствующий входным данным.

Во-вторых, явно удалите валидаторы для поля name в CategorySerializer. Это особенно паршиво, потому что это влияет не только на ListingSerializer.

Оставляя какую-либо деталь, будут возникать ошибки проверки, возникающие при создании экземпляра сериализатора.

модификации views.py:

class ListingViewSet(viewsets.ModelViewSet):
    queryset = models.Listing.objects.all()
    serializer_class = serializers.ListingSerializer

    def create(self, request):
        serializer = serializers.ListingSerializer(data=request.data,
            context={'request': request}, partial=True)
        if not serializer.is_valid():
            logger.error('%s' % serializer.errors)
            return Response(serializer.errors,
                  status=status.HTTP_400_BAD_REQUEST)

        serializer.save()
        return Response(serializer.data, status=status.HTTP_201_CREATED)

модификации serializers.py:

class CategorySerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Category
        fields = ('name', 'description')
        read_only = ('description',)
        # also need to explicitly remove validators for `name` field
        extra_kwargs = {
            'name': {
                'validators': []
            }
        }

class ListingSerializer(serializers.ModelSerializer):
    owners = ProfileSerializer(required=False, many=True)
    category = CategorySerializer(required=False)
    class Meta:
        model = models.Listing
        depth = 2

    def validate(self, data):
        # manually get the Category instance from the input data
        data['category'] = models.Category.objects.get(name=data['category']['name'])
        return data

    def create(self, validated_data):
        title = validated_data['title']

        listing = models.Listing(title=validated_data['title'],
            category=validated_data['category'])

        listing.save()

        if 'owners' in validated_data:
            logger.debug('owners: %s' % validated_data['owners'])
            for owner in validated_data['owners']:
                print ('adding owner: %s' % owner)
                listing.owners.add(owner)
        return listing

Я подожду немного, чтобы принять это как ответ, если кто-то может придумать лучшее решение (например, как заставить аргумент source работать с SlugRelatedField) - у меня есть рабочий пример с использованием решение выше в https://github.com/arw180/drf-example, если вы хотите поэкспериментировать. Я также хотел бы услышать комментарии относительно того, почему материал extra_kwargs необходим в CategorySerializer - почему он не создает его так: category = CategorySerializer(required=False, validators=[]) достаточно (в ListingSerializer)? ОБНОВЛЕНИЕ: Я считаю, что это не работает, потому что уникальный валидатор добавляется автоматически из ограничений БД и выполняется независимо от каких-либо явных валидаторов, установленных здесь, как объяснено в этом ответе: http://iswwwup.com/t/3bf20dfabe1f/python-order-of-serializer-validation-in-django-rest-framework.html

Ответ 2

Поверните CategorySerializer.create в метод update_or_create на name

class CategorySerializer(serializers.ModelSerializer):

    ...

    # update_or_create on `name`
    def create(self, validated_data):
        try:
            self.instance = Category.objects.get(name=validated_data['name'])
            self.instance = self.update(self.instance, validated_data)
            assert self.instance is not None, (
                '`update()` did not return an object instance.'
            )
            return self.instance
        except Category.DoesNotExist:
            return super(CategorySerializer, self).create(validated_data)

    ...

Я рекомендую посмотреть DRF source, когда вам нужно создать пользовательские функции.

Связанный вопрос, заданный создателем DRF: django-rest-framework 3.0 создает или обновляет в вложенном сериализаторе

Изменить

Итак, я все еще был в мышлении DRF 2, где автоматически обрабатываются вложенные записываемые поля. Вы можете прочитать эту тему здесь: http://www.django-rest-framework.org/topics/3.0-announcement/

Я тестировал следующий код, и он работает:

class CategorySerializer(serializers.ModelSerializer):
    class Meta:
        ...
        extra_kwargs = {
            'name': {'validators': []},
            'description': {'required': False},
        }


class ListingSerializer(serializers.ModelSerializer):

    ...

    def update_or_create_category(self, validated_data):
        data = validated_data.pop('category', None)
        if not data:
            return None

        category, created = models.Category.objects.update_or_create(
            name=data.pop('name'), defaults=data)

        validated_data['category'] = category

    def create(self, validated_data):
        self.update_or_create_category(validated_data)
        return super(ListingSerializer, self).create(validated_data)

    def update(self, instance, validated_data):
        self.update_or_create_category(validated_data)
        return super(ListingSerializer, self).update(instance, validated_data)

Изменить

Правильный способ использования SlugRelatedField выглядит так: на случай, если вам интересно:

class ListingSerializer(serializers.ModelSerializer):

    ...

    # slug_field should be 'name', i.e. the name of the field on the related model
    category = serializers.SlugRelatedField(slug_field='name',
        queryset=models.Category.objects.all())

    ...

Ответ 3

У меня была аналогичная проблема: мне нужно было проверить, существует ли вложенный сериализатор (CategorySerializer), если да, чтобы использовать его, а если нет - создать его из вложенного сериализатора (ListingSerializer). Решение @demux полностью работало для меня только в том случае, если я не использовал выборочную проверку для поля в вложенном сериализаторе (поле, по которому я бы проверил, если он установлен в сериализаторе гнездования, если этот экземпляр существует). Поэтому я добавил метод create() для вложенного сериализатора и @demux custom update_or_create_category(), create(), update() для ListingSerializer работал отлично.

class CategorySerializer(serializers.ModelSerializer):

    class Meta:
    model = Category
    ...

    def create(self, validated_data):
        if Category.objects.filter(name=self.validated_data['name']).exists():
            raise serializers.ValidationError("This category name already exists")
        return Category.objects.create(**validated_data)