Валидаторы

Создание валидаторов

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

Например, вот валидатор, который допускает только чётные числа:

from django.core.exceptions import ValidationError
from django.utils.translation import gettext_lazy as _


def validate_even(value):
    if value % 2 != 0:
        raise ValidationError(
            _("%(value)s is not an even number"),
            params={"value": value},
        )

Вы можете добавить его к полю модели через аргумент поля validators:

from django.db import models


class MyModel(models.Model):
    even_field = models.IntegerField(validators=[validate_even])

Поскольку значения преобразуются в Python перед запуском валидаторов, вы можете даже использовать один и тот же валидатор с формами:

from django import forms


class MyForm(forms.Form):
    even_field = forms.IntegerField(validators=[validate_even])

Вы также можете использовать класс с методом __call__() для более сложных или настраиваемых валидаторов. RegexValidator, например, использует эту технику. Если валидатор на основе класса используется в опции поля модели validators, вы должны убедиться, что он сериализуется системой миграций, добавив методы deconstruct() и __eq__().

Как работают валидаторы

См. валидацию форм для получения дополнительной информации о том, как валидаторы работают в формах, и валидацию объектов для получения информации о том, как они работают в моделях. Обратите внимание, что валидаторы не будут запускаться автоматически при сохранении модели, но если вы используете ModelForm, он запустит ваши валидаторы для всех включённых в форму полей. См. документацию ModelForm для получения информации о взаимодействии валидации моделей с формами.

Встроенные валидаторы

Модуль django.core.validators содержит набор вызываемых валидаторов для использования с полями моделей и форм. Они используются во внутренней работе, но также доступны для использования с вашими собственными полями. Они могут быть использованы дополнительно к или вместо пользовательских field.clean() методов.

RegexValidator

class RegexValidator(regex=None, message=None, code=None, inverse_match=None, flags=0)

Параметры:

regex – Если не None, переопределяет regex. Может быть строкой регулярного выражения или предварительно скомпилированным регулярным выражением. message – Если не None, переопределяет message. code – Если не None, переопределяет code. inverse_match – Если не None, переопределяет inverse_match. flags – Если не None, переопределяет flags. В этом случае, regex должен быть строкой регулярного выражения, иначе возникает TypeError.

RegexValidator ищет в предоставленном value заданное регулярное выражение с помощью re.search(). По умолчанию, вызывает ValidationError с message и code, если совпадение не найдено. Его поведение можно инвертировать, установив inverse_match в True, в этом случае ValidationError вызывается при нахождении совпадения.

regex

Образец регулярного выражения для поиска в предоставленном value, с помощью re.search(). Может быть строкой или предварительно скомпилированным регулярным выражением, созданным с помощью re.compile(). По умолчанию пустая строка, которая найдётся в любом возможном value.

message

Сообщение об ошибке, используемое ValidationError в случае неудачи валидации. По умолчанию "Enter a valid value".

code

Код ошибки, используемый ValidationError в случае неудачи валидации. По умолчанию "invalid".

inverse_match

Режим соответствия для regex. По умолчанию False.

flags

флаги регулярных выражений, используемые при компиляции строки регулярного выражения regex. Если regex является предварительно скомпилированным регулярным выражением, а flags переопределяется, возникает TypeError. По умолчанию 0.

EmailValidator

class EmailValidator(message=None, code=None, allowlist=None)

Параметры:	message – Если не None, переопределяет message. code – Если не None, переопределяет code. allowlist – Если не None, переопределяет allowlist.

message

Сообщение об ошибке, используемое ValidationError при ошибке валидации. По умолчанию "Enter a valid email address".

code

Код ошибки, используемый ValidationError при ошибке валидации. По умолчанию "invalid".

allowlist

Список разрешенных доменов электронной почты. По умолчанию используется регулярное выражение (атрибут domain_regex) для проверки всего, что следует за символом @. Однако, если эта строка присутствует в списке allowlist, эта проверка пропускается. Если не указано, значение по умолчанию allowlist равно ['localhost']. Другие домены, не содержащие точки, не пройдут проверку, поэтому их нужно добавить в allowlist по мере необходимости.

URLValidator

class URLValidator(schemes=None, regex=None, message=None, code=None)

Подкласс RegexValidator, который гарантирует, что значение выглядит как URL, и генерирует код ошибки 'invalid' в случае неудачи.

Локальные адреса и зарезервированные IP-пространства считаются допустимыми. Допустимы литеральные IPv6-адреса (RFC 3986#section-3.2.2) и домены Unicode.

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

schemes

Список схем URL/URI для проверки. Если не указано, по умолчанию используется список ['http', 'https', 'ftp', 'ftps']. В качестве справки, на сайте IANA представлен полный список допустимых схем URI.

validate_email

validate_email

Экземпляр EmailValidator без каких-либо настроек.

validate_slug

validate_slug

Экземпляр RegexValidator, который гарантирует, что значение состоит только из букв, цифр, подчеркиваний или дефисов.

validate_unicode_slug

validate_unicode_slug

Экземпляр RegexValidator, который гарантирует, что значение состоит только из букв, цифр, подчеркиваний или дефисов Unicode.

validate_ipv4_address

validate_ipv4_address

Экземпляр RegexValidator, который гарантирует, что значение имеет вид IPv4-адреса.

validate_ipv6_address

validate_ipv6_address

Использует django.utils.ipv6 для проверки корректности IPv6-адреса.

validate_ipv46_address

validate_ipv46_address

Использует validate_ipv4_address и validate_ipv6_address для обеспечения того, что значение является либо корректным IPv4, либо IPv6-адресом.

validate_comma_separated_integer_list

validate_comma_separated_integer_list

Экземпляр RegexValidator, который гарантирует, что значение является списком целых чисел, разделенных запятыми.

int_list_validator

int_list_validator(sep=',', message=None, code='invalid', allow_negative=False)

Возвращает экземпляр RegexValidator, который гарантирует, что строка состоит из целых чисел, разделенных sep. Разрешает отрицательные целые числа, когда allow_negative равно True.

MaxValueValidator

class MaxValueValidator(limit_value, message=None)

Вызывает ValidationError с кодом 'max_value', если value больше limit_value, что может быть вызываемой функцией.

MinValueValidator

class MinValueValidator(limit_value, message=None)

Вызывает ValidationError с кодом 'min_value', если value меньше limit_value, что может быть вызываемой функцией.

MaxLengthValidator

class MaxLengthValidator(limit_value, message=None)

Вызывает ValidationError с кодом 'max_length', если длина value больше limit_value, что может быть вызываемой функцией.

MinLengthValidator

class MinLengthValidator(limit_value, message=None)

Вызывает ValidationError с кодом 'min_length', если длина value меньше limit_value, что может быть вызываемой функцией.

DecimalValidator

class DecimalValidator(max_digits, decimal_places)

Вызывает ValidationError с следующими кодами:

• 'max_digits' если количество цифр больше max_digits.
• 'max_decimal_places' если количество десятичных знаков больше decimal_places.
• 'max_whole_digits' если количество целых цифр больше разницы между max_digits и decimal_places.

FileExtensionValidator

class FileExtensionValidator(allowed_extensions, message, code)

Вызывает ValidationError с кодом 'invalid_extension', если расширение value.name (value является File) не найдено в allowed_extensions. Расширение сравнивается с allowed_extensions без учета регистра.

Предупреждение

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

validate_image_file_extension

validate_image_file_extension

Использует Pillow для проверки того, что value.name (value является File) имеет валидное расширение изображения.

ProhibitNullCharactersValidator

class ProhibitNullCharactersValidator(message=None, code=None)

Вызывает ValidationError, если str(value) содержит один или несколько нулевых символов ('\x00').

Параметры:	message – Если не None, переопределяет message. code – Если не None, переопределяет code.

message

Сообщение об ошибке, используемое ValidationError при ошибке валидации. По умолчанию "Null characters are not allowed.".

code

Код ошибки, используемый ValidationError при ошибке валидации. По умолчанию "null_characters_not_allowed".

StepValueValidator

class StepValueValidator(limit_value, message=None)

Вызывает ValidationError с кодом 'step_size', если value не является целым кратным limit_value, которое может быть значением с плавающей точкой, целым числом или десятичным значением, или вызываемой функцией.