Валидация в REST-фреймворке¶

Валидация в сериализаторах фреймворка Django REST обрабатывается немного иначе, чем валидация в классе Django ModelForm.

При ModelForm валидация выполняется частично на форме, частично на экземпляре модели. При использовании REST framework валидация выполняется полностью на классе сериализатора. Это выгодно по следующим причинам:

• Это вводит правильное разделение забот, делая поведение вашего кода более очевидным.

• Легко переключаться между использованием коротких ModelSerializer классов и использованием явных Serializer классов. Любое поведение валидации, используемое для ModelSerializer, легко воспроизвести.

• Печать repr экземпляра сериализатора покажет вам, какие именно правила валидации он применяет. Нет никакого дополнительного скрытого поведения валидации, вызываемого на экземпляре модели.

При использовании ModelSerializer все это обрабатывается автоматически. Если вы хотите перейти к использованию классов Serializer, то вам необходимо определить правила валидации в явном виде.

class CustomerReportRecord(models.Model):
    time_raised = models.DateTimeField(default=timezone.now, editable=False)
    reference = models.CharField(unique=True, max_length=20)
    description = models.TextField()

class CustomerReportSerializer(serializers.ModelSerializer):
    class Meta:
        model = CustomerReportRecord

>>> from project.example.serializers import CustomerReportSerializer
>>> serializer = CustomerReportSerializer()
>>> print(repr(serializer))
CustomerReportSerializer():
    id = IntegerField(label='ID', read_only=True)
    time_raised = DateTimeField(read_only=True)
    reference = CharField(max_length=20, validators=[<UniqueValidator(queryset=CustomerReportRecord.objects.all())>])
    description = CharField(style={'type': 'textarea'})

UniqueValidator¶

Этот валидатор может быть использован для обеспечения ограничения unique=True для полей модели. Он принимает один обязательный аргумент и необязательный аргумент messages:

• queryset required - Это набор запросов, в отношении которого должна быть обеспечена уникальность.

• message - Сообщение об ошибке, которое должно быть использовано при неудачной валидации.

• lookup - Поиск, используемый для нахождения существующего экземпляра с проверяемым значением. По умолчанию 'exact'.

Этот валидатор должен применяться к полям сериализатора* , например, так:

from rest_framework.validators import UniqueValidator

slug = SlugField(
    max_length=100,
    validators=[UniqueValidator(queryset=BlogPost.objects.all())]
)

 UniqueTogetherValidator¶

Этот валидатор можно использовать для наложения ограничений unique_together на экземпляры модели. Он имеет два обязательных аргумента и один необязательный аргумент messages:

• queryset required - Это набор запросов, в отношении которого должна быть обеспечена уникальность.

• fields required - Список или кортеж имен полей, которые должны составлять уникальный набор. Они должны существовать как поля в классе сериализатора.

• message - Сообщение об ошибке, которое должно быть использовано при неудачной валидации.

Валидатор должен быть применен к классам сериализатора* , примерно так:

from rest_framework.validators import UniqueTogetherValidator

class ExampleSerializer(serializers.Serializer):
    # ...
    class Meta:
        # ToDo items belong to a parent list, and have an ordering defined
        # by the 'position' field. No two items in a given list may share
        # the same position.
        validators = [
            UniqueTogetherValidator(
                queryset=ToDoItem.objects.all(),
                fields=['list', 'position']
            )
        ]

Примечание : Класс UniqueTogetherValidator всегда накладывает неявное ограничение на то, что все поля, к которым он применяется, всегда рассматриваются как обязательные. Поля со значениями default являются исключением, так как они всегда предоставляют значение, даже если оно пропущено при вводе пользователем.

UniqueForDateValidator¶

UniqueForMonthValidator¶

UniqueForYearValidator¶

Эти валидаторы могут быть использованы для наложения ограничений unique_for_date , unique_for_month и unique_for_year на экземпляры модели. Они принимают следующие аргументы:

• queryset required - Это набор запросов, в отношении которого должна быть обеспечена уникальность.

• field required - Имя поля, по которому будет проверяться уникальность в заданном диапазоне дат. Оно должно существовать как поле в классе сериализатора.

• date_field required - Имя поля, которое будет использоваться для определения диапазона дат для ограничения уникальности. Оно должно существовать как поле в классе сериализатора.

• message - Сообщение об ошибке, которое должно быть использовано при неудачной валидации.

Валидатор должен быть применен к классам сериализатора* , примерно так:

from rest_framework.validators import UniqueForYearValidator

class ExampleSerializer(serializers.Serializer):
    # ...
    class Meta:
        # Blog posts should have a slug that is unique for the current year.
        validators = [
            UniqueForYearValidator(
                queryset=BlogPostItem.objects.all(),
                field='slug',
                date_field='published'
            )
        ]

Поле даты, которое используется для валидации, всегда должно присутствовать в классе сериализатора. Вы не можете просто положиться на класс модели default=... , потому что значение, используемое по умолчанию, будет создано только после выполнения валидации.

Есть несколько стилей, которые вы можете использовать для этого в зависимости от того, как вы хотите, чтобы вел себя ваш API. Если вы используете ModelSerializer, вы, вероятно, просто будете полагаться на значения по умолчанию, которые REST framework генерирует для вас, но если вы используете Serializer или просто хотите более явного контроля, используйте один из стилей, продемонстрированных ниже.

published = serializers.DateTimeField(required=True)

published = serializers.DateTimeField(read_only=True, default=timezone.now)

published = serializers.HiddenField(default=timezone.now)

Необязательные поля¶

По умолчанию валидация «unique together» принудительно требует, чтобы все поля были required=True. В некоторых случаях вы можете захотеть явно применить required=False к одному из полей, и в этом случае желаемое поведение валидации будет неоднозначным.

В этом случае обычно необходимо исключить валидатор из класса сериализатора и вместо этого написать логику валидации явно, либо в методе .validate(), либо в представлении.

Например:

class BillingRecordSerializer(serializers.ModelSerializer):
    def validate(self, attrs):
        # Apply custom validation either here, or in the view.

    class Meta:
        fields = ['client', 'date', 'amount']
        extra_kwargs = {'client': {'required': False}}
        validators = []  # Remove a default "unique together" constraint.

Обновление вложенных сериализаторов¶

При применении обновления к существующему экземпляру валидаторы уникальности исключают текущий экземпляр из проверки уникальности. Текущий экземпляр доступен в контексте проверки уникальности, поскольку он существует как атрибут сериализатора, будучи изначально переданным с помощью instance=... при инстанцировании сериализатора.

В случае операций обновления для вложенных сериализаторов нет возможности применить это исключение, поскольку экземпляр недоступен.

Опять же, вы, вероятно, захотите явно удалить валидатор из класса сериализатора и написать код для ограничения валидации явно, в методе .validate() или в представлении.

Отладка сложных случаев¶

Если вы не уверены, какое именно поведение будет генерировать класс ModelSerializer, обычно полезно запустить manage.py shell , и вывести экземпляр сериализатора, чтобы вы могли проверить поля и валидаторы, которые он автоматически генерирует для вас.

>>> serializer = MyComplexModelSerializer()
>>> print(serializer)
class MyComplexModelSerializer:
    my_fields = ...

Также имейте в виду, что в сложных случаях часто бывает лучше явно определить классы сериализатора, а не полагаться на поведение по умолчанию ModelSerializer. Это требует немного больше кода, но гарантирует, что результирующее поведение будет более прозрачным.

На основе функций¶

Валидатором может быть любой вызываемый объект, который при неудаче выдает сообщение serializers.ValidationError.

def even_number(value):
    if value % 2 != 0:
        raise serializers.ValidationError('This field must be an even number.')

На основе класса¶

Чтобы написать валидатор на основе класса, используйте метод __call__. Валидаторы на основе классов полезны, так как позволяют параметризовать и повторно использовать поведение.

class MultipleOf:
    def __init__(self, base):
        self.base = base

    def __call__(self, value):
        if value % self.base != 0:
            message = 'This field must be a multiple of %d.' % self.base
            raise serializers.ValidationError(message)

requires_context = True

def __call__(self, value, serializer_field):
    ...