• 3.1
  • 3.2
  • 6.1
  • Версия документации: 5.0

Валидаторы

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

Валидатор — это вызываемый объект, который принимает значение и выдает 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.

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

regex

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

message

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

code

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

inverse_match

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

flags

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

EmailValidator

class EmailValidator(message=None, code=None, allowlist=None)
Параметры:

  • message – Если не None, переопределяет message.

  • code – Если не None, переопределяет code.

  • allowlist – Если не Нет, переопределяет allowlist.

EmailValidator гарантирует, что значение выглядит как электронное письмо, и вызывает ValidationError с message и code, если это не так. Значения длиной более 320 символов всегда считаются недействительными.

message

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

code

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

allowlist

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

DomainNameValidator

New in Django 5.1.
class DomainNameValidator(accept_idna=True, message=None, code=None)

Подкласс RegexValidator, который гарантирует, что значение будет выглядеть как имя домена. Значения длиной более 255 символов всегда считаются недействительными. IP-адреса не принимаются в качестве действительных доменных имен.

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

accept_idna

Определяет, принимать ли интернационализированные доменные имена, то есть доменные имена, содержащие символы, отличные от ASCII. По умолчанию установлено True.

URLValidator

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

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

Адреса обратной связи и зарезервированные IP-пространства считаются действительными. Поддерживаются как буквальные адреса IPv6 (RFC 3986 Section 3.2.2), так и домены Unicode.

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

schemes

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

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

Значения, начинающиеся с file:///, не пройдут проверку, даже если предоставлена ​​схема file. Допустимые значения должны содержать хост.

max_length

Максимальная длина значений, которые можно считать допустимыми. По умолчанию 2048 символов.

validate_email

validate_email

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

validate_domain_name

New in Django 5.1.
validate_domain_name

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

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 больше, чем max_value.

MinValueValidator

class MinValueValidator(limit_value, message=None)

Вызывает исключение ValidationError с кодом 'min_value', если value меньше, чем min_value.

MaxLengthValidator

class MaxLengthValidator(limit_value, message=None)

Вызывает исключение ValidationError с кодом 'max_length', если длина value больше, чем max_length.

MinLengthValidator

class MinLengthValidator(limit_value, message=None)

Вызывает исключение ValidationError с кодом 'min_length', если длина value меньше, чем min_length.

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, offset=None)

Вызывает ошибку ValidationError с кодом 'step_size', если value не является целым кратным limit_value, которое может быть числом с плавающей запятой, целым или десятичным значением или вызываемым объектом. Когда установлено offset, проверка происходит по limit_value плюс offset. Например, для StepValueValidator(3, offset=1.4) допустимые значения включают в себя 1.4, 4.4, 7.4, 10.4 и так далее.

Changed in Django 5.0:

Был добавлен аргумент offset.

Back to Top