Валидатор — это вызываемый объект (callable), который принимает значение и вызывает исключение ValidationError, если значение не соответствует неким критериям. Валидаторы могут быть полезны когда надо использовать одинаковую логику проверки для разных типов полей.
Например, здесь показан валидатор, который принимает только чётные числа:
from django.core.exceptions import ValidationError
def validate_even(value):
if value % 2 != 0:
raise ValidationError('%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])
Вы можете использовать класс с методом __call__() для сложных или настраиваемых валидаторов. RegexValidator, например, использует эту технику. Если валидатор-класс используется в параметре validators поля модели, он должен быть сериализируемым для работы миграций. Для этого добавьте методы deconstruct() и __eq__().
Обратитесь к документации по проверке форм для получения подробностей о работе валидаторов в формах и к документации по проверке объектов, чтобы узнать как валидаторы запускаются для моделей. Следует отметить, что валидаторы не запускаются автоматически в случае когда вы сохраняете модель. Но если вы используете класс ModelForm, то он запустит ваши валидаторы для всех полей формы. Обратитесь к документации на модельные формы для получения информации о том, как валидаторы модели взаимодействуют с формами.
Модуль django.core.validators содержит коллекцию валидаторов, которые можно использовать как с моделями, так и с полями формы. Они используются Django, но также доступны для применения в ваших полях. Их можно использовать в дополнение к или вместо метода field.clean().
| Параметры: |
|
|---|
Шаблон регулярного выражения для поиска в предоставленном value или заранее скомпилированное регулярное выражение. По умолчанию вызывает исключение ValidationError с атрибутами message и code, если было найдено совпадение. Если inverse_match равно True, исключение ValidationError будет вызвано, если совпадение не найдено. По умолчанию совпадает с любыми строками, включая пустые строки.
Сообщение об ошибке, используемое исключением ValidationError, если проверка не прошла. По умолчанию, "Enter a valid value".
Код ошибки, используемый исключением ValidationError, если проверка не прошла. По умолчанию "invalid".
Режим совпадения для regex. По умолчанию False.
| Параметры: |
|
|---|
Сообщение об ошибке, используемое исключением ValidationError, если проверка не прошла. По умолчанию, "Enter a valid email address".
Код ошибки, используемый исключением ValidationError, если проверка не прошла. По умолчанию "invalid".
Описывает белый список доменов электронной почты. По умолчанию, для проверки написанного после знака @ используется регулярное выражение (атрибут domain_regex). Однако, если данная строка указана в белом списке, то такая валидация не выполняется. Если список не предоставлен, то белый список содержит ['localhost']. Другие домены, что не содержат точку, не пройдут проверку, таким образом вам потребуется вносить их в белый список по необходимости.
Экземпляр класса RegexValidator, который проверяет, что значение выглядит как URL, иначе вызывает ошибку с кодом 'invalid'.
Кольцевые адреса и зарезервированные пространства адресов IP. Поддерживаются оба варианта: адрес IPv6 в виде текста (RFC 2732) и имена доменов юникоде.
В дополнение к необязательным аргументам родительского класса RegexValidator, URLValidator принимает дополнительный необязательный атрибут:
Список разрешенных для URL/URI протоколов. По умолчанию ['http', 'https', 'ftp', 'ftps']. Сайт IANA Web предоставляет полный список валидных протоколов URI.
Была добавлена поддержка адресов IPv6, юникодных доменов и URL, содержащих аутентификационные данные.
Экземпляр EmailValidator без каких-либо настроек.
Экземпляр класса RegexValidator, который проверяет, что значение содержит только буквы, числа, символы подчёркивания или тире.
Экземпляр класса RegexValidator, который проверяет, что значение содержит только Unicode буквы, числа, символы подчёркивания или тире.
Экземпляр класса RegexValidator, который проверяет, что значение выглядит как IPv4 адрес.
Использует django.utils.ipv6 для проверки соответствия значения IPv6 адресу.
Использует оба валидатора (validate_ipv4_address и validate_ipv6_address) для проверки, что значение соответствует IPv4 или IPv6 адресу.
Экземпляр класса RegexValidator, который проверяет, что значение является списком целых чисел, разделённых запятыми.
Экземпляр класса RegexValidator, который проверяет, что значение является списком целых чисел, разделённых sep.
Вызывает исключение ValidationError с кодом 'max_value', если value больше, чем max_value.
Был добавлен параметр message.
Вызывает исключение ValidationError с кодом 'min_value', если value меньше, чем min_value.
Был добавлен параметр message.
Вызывает исключение ValidationError с кодом 'max_length', если длина value больше, чем max_length.
Был добавлен параметр message.
Вызывает исключение ValidationError с кодом 'min_length', если длина value меньше, чем min_length.
Был добавлен параметр message.
Вызывает исключение ValidationError со следующими кодами ошибок:
'max_digits', если количество цифр больше max_digits.
'max_decimal_places', если количество знаков после запятой больше decimal_places.
'max_whole_digits', если количество цифр в целой части больше, чем разница между max_digits и decimal_places.
Mar 31, 2016