Валидаторы

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

Валидатор — это вызываемый объект (callable), который принимает значение и вызывает исключение 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, то он запустит ваши валидаторы для всех полей формы. Обратитесь к документации на модельные формы для получения информации о том, как валидаторы модели взаимодействуют с формами.

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

Модуль django.core.validators содержит коллекцию валидаторов, которые можно использовать как с моделями, так и с полями формы. Они используются Django, но также доступны для применения в ваших полях. Их можно использовать в дополнение к или вместо метода 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.
regex

Шаблон регулярного выражения для поиска в предоставленном value или заранее скомпилированное регулярное выражение. По умолчанию вызывает исключение ValidationError с атрибутами message и code, если не было найдено совпадение. Если inverse_match равно True, исключение ValidationError будет вызвано, если совпадение было найдено. По умолчанию совпадает с любыми строками, включая пустые строки.

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, whitelist=None)
Параметры:
  • message – Если не None, переопределяет message.
  • code – Если не None, переопределяет code.
  • whitelist – Если не None, переопределяет whitelist.
message

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

code

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

whitelist

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

URLValidator

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

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

Loopback addresses and reserved IP spaces are considered valid. Literal IPv6 addresses (RFC 3986#section-3.2.2) and unicode domains are both supported.

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

schemes

Список разрешенных для URL/URI протоколов. По умолчанию ['http', 'https', 'ftp', 'ftps']. Сайт IANA Web предоставляет полный список валидных протоколов 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)

Raises a ValidationError with a code of 'max_value' if value is greater than limit_value, which may be a callable.

Changed in Django 2.2:

limit_value can now be a callable.

MinValueValidator

class MinValueValidator(limit_value, message=None)

Raises a ValidationError with a code of 'min_value' if value is less than limit_value, which may be a callable.

Changed in Django 2.2:

limit_value can now be a callable.

MaxLengthValidator

class MaxLengthValidator(limit_value, message=None)

Raises a ValidationError with a code of 'max_length' if the length of value is greater than limit_value, which may be a callable.

Changed in Django 2.2:

limit_value can now be a callable.

MinLengthValidator

class MinLengthValidator(limit_value, message=None)

Raises a ValidationError with a code of 'min_length' if the length of value is less than limit_value, which may be a callable.

Changed in Django 2.2:

limit_value can now be a callable.

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) содержит один или несколько «null» символов ('\x00').

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

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

code

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