Валидаторы

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

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

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

from django.core.exceptions import ValidationError

def validate_even(value):
    if value % 2 != 0:
        raise ValidationError(u'%s is not an even number' % 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])

Как валидаторы запускаются

Обратитесь к документации по проверке форм для получения подробностей о работе валидаторов в формах и к документации по проверке объектов, чтобы узнать как валидаторы запускаются для моделей. Следует отметить, что валидаторы не запускаются автоматически в случае когда вы сохраняете модель. Но если вы используете класс 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 равен False и было найдено совпадение, или inverse_match равно True и совпадение не найдено. По умолчанию совпадает с любыми строками, включая пустые строки.

message

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

code

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

inverse_match
Добавлено в Django 1.7.

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

flags
Добавлено в Django 1.7.

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

URLValidator

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

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

schemes

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

Изменено в Django 1.7:

Был добавлен не обязательный атрибут schemes.

validate_email

validate_email

Экземпляр класса EmailValidator, который проверяет, что значение содержит email.

validate_slug

validate_slug

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

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, который проверяет, что значение является списком целых чисел, разделённых запятыми.

MaxValueValidator

class MaxValueValidator(max_value)

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

MinValueValidator

class MinValueValidator(min_value)

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

MaxLengthValidator

class MaxLengthValidator(max_length)

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

MinLengthValidator

class MinLengthValidator(min_length)

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