Import validation error django

Form and field validation¶

Form validation happens when the data is cleaned. If you want to customize
this process, there are various places to make changes, each one serving a
different purpose. Three types of cleaning methods are run during form
processing. These are normally executed when you call the is_valid()
method on a form. There are other things that can also trigger cleaning and
validation (accessing the errors attribute or calling full_clean()
directly), but normally they won’t be needed.

In general, any cleaning method can raise ValidationError if there is a
problem with the data it is processing, passing the relevant information to
the ValidationError constructor. See below
for the best practice in raising ValidationError. If no ValidationError
is raised, the method should return the cleaned (normalized) data as a Python
object.

Most validation can be done using validators — helpers that can be reused.
Validators are functions (or callables) that take a single argument and raise
ValidationError on invalid input. Validators are run after the field’s
to_python and validate methods have been called.

Validation of a form is split into several steps, which can be customized or
overridden:

• The to_python() method on a Field is the first step in every
  validation. It coerces the value to a correct datatype and raises
  ValidationError if that is not possible. This method accepts the raw
  value from the widget and returns the converted value. For example, a
  FloatField will turn the data into a Python float or raise a
  ValidationError.

• The validate() method on a Field handles field-specific validation
  that is not suitable for a validator. It takes a value that has been
  coerced to a correct datatype and raises ValidationError on any error.
  This method does not return anything and shouldn’t alter the value. You
  should override it to handle validation logic that you can’t or don’t
  want to put in a validator.

• The run_validators() method on a Field runs all of the field’s
  validators and aggregates all the errors into a single
  ValidationError. You shouldn’t need to override this method.

• The clean() method on a Field subclass is responsible for running
  to_python(), validate(), and run_validators() in the correct
  order and propagating their errors. If, at any time, any of the methods
  raise ValidationError, the validation stops and that error is raised.
  This method returns the clean data, which is then inserted into the
  cleaned_data dictionary of the form.

• The clean_<fieldname>() method is called on a form subclass – where
  <fieldname> is replaced with the name of the form field attribute.
  This method does any cleaning that is specific to that particular
  attribute, unrelated to the type of field that it is. This method is not
  passed any parameters. You will need to look up the value of the field
  in self.cleaned_data and remember that it will be a Python object
  at this point, not the original string submitted in the form (it will be
  in cleaned_data because the general field clean() method, above,
  has already cleaned the data once).

  For example, if you wanted to validate that the contents of a
  CharField called serialnumber was unique,
  clean_serialnumber() would be the right place to do this. You don’t
  need a specific field (it’s a CharField), but you want a
  formfield-specific piece of validation and, possibly, cleaning/normalizing
  the data.

  The return value of this method replaces the existing value in
  cleaned_data, so it must be the field’s value from cleaned_data (even
  if this method didn’t change it) or a new cleaned value.

• The form subclass’s clean() method can perform validation that requires
  access to multiple form fields. This is where you might put in checks such as
  “if field A is supplied, field B must contain a valid email address”.
  This method can return a completely different dictionary if it wishes, which
  will be used as the cleaned_data.

  Since the field validation methods have been run by the time clean() is
  called, you also have access to the form’s errors attribute which
  contains all the errors raised by cleaning of individual fields.

  Note that any errors raised by your Form.clean() override will not
  be associated with any field in particular. They go into a special
  “field” (called __all__), which you can access via the
  non_field_errors() method if you need to. If you
  want to attach errors to a specific field in the form, you need to call
  add_error().

  Also note that there are special considerations when overriding
  the clean() method of a ModelForm subclass. (see the
  ModelForm documentation for more information)

These methods are run in the order given above, one field at a time. That is,
for each field in the form (in the order they are declared in the form
definition), the Field.clean() method (or its override) is run, then
clean_<fieldname>(). Finally, once those two methods are run for every
field, the Form.clean() method, or its override, is executed whether
or not the previous methods have raised errors.

Examples of each of these methods are provided below.

As mentioned, any of these methods can raise a ValidationError. For any
field, if the Field.clean() method raises a ValidationError, any
field-specific cleaning method is not called. However, the cleaning methods
for all remaining fields are still executed.

raise ValidationError(
    _('Invalid value: %(value)s'),
    code='invalid',
    params={'value': '42'},
)

ValidationError(_('Invalid value: %s') % value)

# Good
raise ValidationError([
    ValidationError(_('Error 1'), code='error1'),
    ValidationError(_('Error 2'), code='error2'),
])

# Bad
raise ValidationError([
    _('Error 1'),
    _('Error 2'),
])

from django.core import validators
from django.forms import CharField

class SlugField(CharField):
    default_validators = [validators.validate_slug]

slug = forms.CharField(validators=[validators.validate_slug])

from django import forms
from django.core.validators import validate_email

class MultiEmailField(forms.Field):
    def to_python(self, value):
        """Normalize data to a list of strings."""
        # Return an empty list if no input was given.
        if not value:
            return []
        return value.split(',')

    def validate(self, value):
        """Check if value consists only of valid emails."""
        # Use the parent's handling of required fields, etc.
        super().validate(value)
        for email in value:
            validate_email(email)

class ContactForm(forms.Form):
    subject = forms.CharField(max_length=100)
    message = forms.CharField()
    sender = forms.EmailField()
    recipients = MultiEmailField()
    cc_myself = forms.BooleanField(required=False)

from django import forms
from django.core.exceptions import ValidationError

class ContactForm(forms.Form):
    # Everything as before.
    ...

    def clean_recipients(self):
        data = self.cleaned_data['recipients']
        if "fred@example.com" not in data:
            raise ValidationError("You have forgotten about Fred!")

        # Always return a value to use as the new cleaned data, even if
        # this method didn't change it.
        return data

from django import forms
from django.core.exceptions import ValidationError

class ContactForm(forms.Form):
    # Everything as before.
    ...

    def clean(self):
        cleaned_data = super().clean()
        cc_myself = cleaned_data.get("cc_myself")
        subject = cleaned_data.get("subject")

        if cc_myself and subject:
            # Only do something if both fields are valid so far.
            if "help" not in subject:
                raise ValidationError(
                    "Did not send for 'help' in the subject despite "
                    "CC'ing yourself."
                )

def clean(self):
    super().clean()
    cc_myself = self.cleaned_data.get("cc_myself")
    ...

from django import forms

class ContactForm(forms.Form):
    # Everything as before.
    ...

    def clean(self):
        cleaned_data = super().clean()
        cc_myself = cleaned_data.get("cc_myself")
        subject = cleaned_data.get("subject")

        if cc_myself and subject and "help" not in subject:
            msg = "Must put 'help' in subject when cc'ing yourself."
            self.add_error('cc_myself', msg)
            self.add_error('subject', msg)

Валидация форм и полей¶

Валидация формы происходит при очистке данных. Если вы хотите настроить этот процесс, есть различные места для внесения изменений, каждое из которых служит для разных целей. В процессе обработки формы выполняются три типа методов очистки. Обычно они выполняются, когда вы вызываете метод is_valid() на форме. Есть и другие вещи, которые также могут вызвать очистку и проверку (обращение к атрибуту errors или прямой вызов full_clean()), но обычно они не нужны.

В общем, любой метод очистки может поднять ValidationError, если есть проблема с данными, которые он обрабатывает, передавая соответствующую информацию конструктору ValidationError. See below для лучшей практики поднятия ValidationError. Если не поднимается ValidationError, метод должен вернуть очищенные (нормализованные) данные в виде объекта Python.

Большинство валидаций можно выполнить с помощью validators — помощников, которые можно использовать повторно. Валидаторы — это функции (или callables), которые принимают один аргумент и вызывают ValidationError при недопустимом вводе. Валидаторы запускаются после вызова методов to_python и validate поля.

Валидация формы разбита на несколько этапов, которые можно настроить или отменить:

• Метод to_python() на Field является первым шагом в каждой валидации. Он преобразует значение к правильному типу данных и выдает сообщение ValidationError, если это невозможно. Этот метод принимает необработанное значение от виджета и возвращает преобразованное значение. Например, FloatField превратит данные в Python float или выдаст ValidationError.

• Метод validate() на Field обрабатывает специфическую для поля валидацию, которая не подходит для валидатора. Он принимает значение, которое было приведено к правильному типу данных, и при любой ошибке выдает сообщение ValidationError. Этот метод ничего не возвращает и не должен изменять значение. Вы должны переопределить его для обработки логики валидации, которую вы не можете или не хотите поместить в валидатор.

• Метод run_validators() на поле Field запускает все валидаторы поля и объединяет все ошибки в один ValidationError. Вам не нужно переопределять этот метод.

• Метод clean() в подклассе Field отвечает за выполнение to_python(), validate() и run_validators() в правильном порядке и распространение их ошибок. Если в любой момент времени какой-либо из методов вызывает ошибку ValidationError, валидация останавливается, и эта ошибка выдается. Этот метод возвращает чистые данные, которые затем вставляются в словарь cleaned_data формы.

• Метод clean_<fieldname>() вызывается на подклассе формы – где <fieldname> заменяется на имя атрибута поля формы. Этот метод выполняет любую очистку, специфичную для данного атрибута, не связанную с типом поля, которым он является. Этому методу не передаются никакие параметры. Вам нужно будет найти значение поля в self.cleaned_data и помнить, что в этот момент это будет объект Python, а не исходная строка, представленная в форме (она будет в cleaned_data, потому что метод general field clean(), описанный выше, уже однажды очистил данные).

  Например, если вы хотите проверить, что содержимое CharField под названием serialnumber является уникальным, clean_serialnumber() будет подходящим местом для этого. Вам не нужно конкретное поле (это CharField), но вам нужен специфический для поля формы фрагмент проверки и, возможно, очистки/нормализации данных.

  Возвращаемое значение этого метода заменяет существующее значение в cleaned_data, поэтому это должно быть значение поля из cleaned_data (даже если этот метод не изменил его) или новое очищенное значение.

• Метод clean() подкласса формы может выполнять валидацию, требующую доступа к нескольким полям формы. Сюда можно отнести такие проверки, как «если поле A предоставлено, то поле B должно содержать действительный адрес электронной почты». При желании этот метод может вернуть совершенно другой словарь, который будет использован в качестве cleaned_data.

  Поскольку методы валидации полей были запущены к моменту вызова clean(), у вас также есть доступ к атрибуту errors формы, который содержит все ошибки, возникшие при очистке отдельных полей.

  Обратите внимание, что любые ошибки, возникающие при переопределении Form.clean(), не будут связаны с каким-либо конкретным полем. Они попадают в специальное «поле» (называемое __all__), к которому вы можете получить доступ через метод non_field_errors(), если вам это необходимо. Если вы хотите прикрепить ошибки к определенному полю формы, вам нужно вызвать add_error().

  Также обратите внимание, что существуют особые соображения при переопределении метода clean() подкласса ModelForm. (см. ModelForm documentation для получения дополнительной информации)

Эти методы выполняются в указанном выше порядке, по одному полю за раз. То есть, для каждого поля формы (в порядке их объявления в определении формы) выполняется метод Field.clean() (или его переопределение), затем clean_<fieldname>(). Наконец, когда эти два метода выполнены для каждого поля, выполняется метод Form.clean(), или его переопределение, независимо от того, вызвали ли предыдущие методы ошибки.

Примеры каждого из этих методов приведены ниже.

Как уже упоминалось, любой из этих методов может вызвать ошибку ValidationError. Для любого поля, если метод Field.clean() вызывает ValidationError, любой метод очистки, специфичный для данного поля, не вызывается. Однако методы очистки для всех оставшихся полей все равно выполняются.

raise ValidationError(
    _('Invalid value: %(value)s'),
    code='invalid',
    params={'value': '42'},
)

ValidationError(_('Invalid value: %s') % value)

# Good
raise ValidationError([
    ValidationError(_('Error 1'), code='error1'),
    ValidationError(_('Error 2'), code='error2'),
])

# Bad
raise ValidationError([
    _('Error 1'),
    _('Error 2'),
])

from django.core import validators
from django.forms import CharField

class SlugField(CharField):
    default_validators = [validators.validate_slug]

slug = forms.CharField(validators=[validators.validate_slug])

from django import forms
from django.core.validators import validate_email

class MultiEmailField(forms.Field):
    def to_python(self, value):
        """Normalize data to a list of strings."""
        # Return an empty list if no input was given.
        if not value:
            return []
        return value.split(',')

    def validate(self, value):
        """Check if value consists only of valid emails."""
        # Use the parent's handling of required fields, etc.
        super().validate(value)
        for email in value:
            validate_email(email)

class ContactForm(forms.Form):
    subject = forms.CharField(max_length=100)
    message = forms.CharField()
    sender = forms.EmailField()
    recipients = MultiEmailField()
    cc_myself = forms.BooleanField(required=False)

from django import forms
from django.core.exceptions import ValidationError

class ContactForm(forms.Form):
    # Everything as before.
    ...

    def clean_recipients(self):
        data = self.cleaned_data['recipients']
        if "fred@example.com" not in data:
            raise ValidationError("You have forgotten about Fred!")

        # Always return a value to use as the new cleaned data, even if
        # this method didn't change it.
        return data

from django import forms
from django.core.exceptions import ValidationError

class ContactForm(forms.Form):
    # Everything as before.
    ...

    def clean(self):
        cleaned_data = super().clean()
        cc_myself = cleaned_data.get("cc_myself")
        subject = cleaned_data.get("subject")

        if cc_myself and subject:
            # Only do something if both fields are valid so far.
            if "help" not in subject:
                raise ValidationError(
                    "Did not send for 'help' in the subject despite "
                    "CC'ing yourself."
                )

def clean(self):
    super().clean()
    cc_myself = self.cleaned_data.get("cc_myself")
    ...

from django import forms

class ContactForm(forms.Form):
    # Everything as before.
    ...

    def clean(self):
        cleaned_data = super().clean()
        cc_myself = cleaned_data.get("cc_myself")
        subject = cleaned_data.get("subject")

        if cc_myself and subject and "help" not in subject:
            msg = "Must put 'help' in subject when cc'ing yourself."
            self.add_error('cc_myself', msg)
            self.add_error('subject', msg)

Проверка формы и поля

Проверка формы происходит при очистке данных. Если вы хотите настроить этот процесс, есть несколько мест для внесения изменений, каждое из которых служит своей цели. Во время обработки формы запускаются три типа методов очистки. Обычно они выполняются, когда вы вызываете метод is_valid() в форме. Есть и другие вещи, которые также могут вызвать очистку и проверку (доступ к атрибуту errors или прямой вызов full_clean() ), но обычно они не нужны.

В общем, любой метод очистки может вызвать ValidationError , если есть проблема с данными, которые он обрабатывает, передав соответствующую информацию конструктору ValidationError . Ниже приведены рекомендации по повышению ValidationError . Если ValidationError не вызывается, метод должен вернуть очищенные (нормализованные) данные в виде объекта Python.

Большую часть проверки можно выполнить с помощью валидаторов — помощников, которые можно использовать повторно. Валидаторы — это функции (или вызываемые объекты), которые принимают один аргумент и вызывают ValidationError при неверном вводе. Валидаторы запускаются после вызова методов поля to_python и validate .

Проверка формы разделена на несколько этапов,которые можно настроить или переопределить:

• Метод to_python() для Field является первым шагом в каждой проверке. Он приводит значение к правильному типу данных и вызывает ValidationError , если это невозможно. Этот метод принимает необработанное значение из виджета и возвращает преобразованное значение. Например, FloatField превратит данные в число с float Python или вызовет ValidationError .
• Метод validate() для Field обрабатывает специфическую для поля проверку, которая не подходит для валидатора. Он принимает значение, которое было приведено к правильному типу данных, и вызывает ValidationError при любой ошибке. Этот метод ничего не возвращает и не должен изменять значение. Вы должны переопределить его, чтобы обрабатывать логику проверки, которую вы не можете или не хотите использовать в валидаторе.
• Метод run_validators() для Field запускает все валидаторы поля и объединяет все ошибки в один ValidationError . Вам не нужно переопределять этот метод.
• Метод clean() в подклассе Field отвечает за запуск to_python() , validate() и run_validators() в правильном порядке и распространение их ошибок. Если в любое время любой из методов вызывает ValidationError , проверка останавливается, и возникает эта ошибка. Этот метод возвращает чистые данные, которые затем вставляются в словарь cleaned_data формы.

• Метод clean_<fieldname>() вызывается в подклассе формы, где <fieldname> заменяется именем атрибута поля формы. Этот метод выполняет любую очистку, относящуюся к этому конкретному атрибуту, независимо от типа поля, которым он является. Этому методу не передаются никакие параметры. Вам нужно будет найти значение поля в self.cleaned_data и помнить, что в этот момент это будет объект Python, а не исходная строка, представленная в форме (она будет в cleaned_data потому что метод clean() общего поля , выше, уже один раз очистил данные).

  Например, если вы хотите проверить уникальность содержимого CharField , называемого serialnumber clean_serialnumber() . Вам не нужно конкретное поле (это CharField ), но вам нужна часть проверки, специфичная для поля формы, и, возможно, очистка/нормализация данных.

  Возвращаемое значение этого метода заменяет существующее значение в cleaned_data , поэтому оно должно быть значением поля из cleaned_data (даже если этот метод не изменил его) или новым очищенным значением.

• clean() подкласса формы может выполнять проверку, требующую доступа к нескольким полям формы. Здесь вы можете поставить такие проверки, как «если поле A указано, поле B должно содержать действительный адрес электронной почты». Этот метод может вернуть совершенно другой словарь, если захочет, который будет использоваться как cleaned_data .

  Поскольку методы проверки поля были запущены к моменту clean() , у вас также есть доступ к атрибуту errors формы, который содержит все ошибки, вызванные очисткой отдельных полей.

  Обратите внимание, что любые ошибки, вызванные вашим переопределением Form.clean() , не будут связаны с каким-либо конкретным полем. Они попадают в специальное «поле» (называемое __all__ ), к которому вы можете получить доступ через метод non_field_errors() , если вам это нужно. Если вы хотите прикрепить ошибки к определенному полю в форме, вам нужно вызвать add_error() .

  Также обратите внимание, что при переопределении метода clean() подкласса ModelForm есть особые соображения . (см. документацию ModelForm для получения дополнительной информации)

Эти методы выполняются в порядке, указанном выше, по одному полю за раз. То есть для каждого поля в форме (в порядке их объявления в определении формы) Field.clean() метод Field.clean () (или его переопределение), затем clean_<fieldname>() . Наконец, после того, как эти два метода запущены для каждого поля, Form.clean() метод Form.clean () или его переопределение независимо от того, были ли в предыдущих методах ошибки.

Примеры каждого из этих методов приведены ниже.

Как уже упоминалось, любой из этих методов может вызвать ValidationError . Для любого поля, если метод Field.clean() вызывает ValidationError , какой-либо специфический для поля метод очистки не вызывается. Однако методы очистки для всех оставшихся полей все еще выполняются.

Raising ValidationError

Для того,чтобы сделать сообщения об ошибках гибкими и легко преодолеваемыми,обратите внимание на следующие рекомендации:

• Предоставьте описательный code ошибки конструктору:

  ValidationError(_('Invalid value'), code='invalid')
  
  
  ValidationError(_('Invalid value'))
  

• Не добавляйте переменные в сообщение принудительно; используйте заполнители и аргумент params конструктора:

  # Good
  ValidationError(
      _('Invalid value: %(value)s'),
      params={'value': '42'},
  )
  
  # Bad
  ValidationError(_('Invalid value: %s') % value)
  

• Используйте клавиши отображения вместо позиционного форматирования.Это позволяет расположить переменные в любом порядке или вообще опустить их при переписывании сообщения:

  # Good
  ValidationError(
      _('Invalid value: %(value)s'),
      params={'value': '42'},
  )
  
  # Bad
  ValidationError(
      _('Invalid value: %s'),
      params=('42',),
  )
  

• Оберните сообщение gettext , чтобы включить перевод:

  ValidationError(_('Invalid value'))
  
  
  ValidationError('Invalid value')
  

Складывая все вместе:

raise ValidationError(
    _('Invalid value: %(value)s'),
    code='invalid',
    params={'value': '42'},
)

Соблюдение этих рекомендаций особенно необходимо,если Вы пишете формы многоразового использования,поля форм и поля моделей.

Хотя это и не рекомендуется, если вы находитесь в конце цепочки валидации (т. Е. Метода формы clean() ) и знаете, что вам никогда не понадобится переопределять сообщение об ошибке, вы все равно можете выбрать менее подробный:

ValidationError(_('Invalid value: %s') % value)

Form.errors.as_data() и Form.errors.as_json() метода извлечь большую пользу из полнофункционального ValidationError s (с code именем и params словарь).

Повышение количества ошибок

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

Как и выше, рекомендуется передавать список экземпляров ValidationError с code s и params , но также будет работать список строк:

# Good
raise ValidationError([
    ValidationError(_('Error 1'), code='error1'),
    ValidationError(_('Error 2'), code='error2'),
])

# Bad
raise ValidationError([
    _('Error 1'),
    _('Error 2'),
])

Использование валидации на практике

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

Using validators

Поля формы (и модели) Django поддерживают использование служебных функций и классов, известных как валидаторы. Валидатор — это вызываемый объект или функция, которая принимает значение и ничего не возвращает, если значение допустимо, или вызывает ValidationError , если нет. Их можно передать конструктору поля через аргумент validators поля или определить в самом классе Field с помощью атрибута default_validators .

Валидаторы можно использовать для проверки значений внутри поля, давайте взглянем на SlugField Django :

from django.core import validators
from django.forms import CharField

class SlugField(CharField):
    default_validators = [validators.validate_slug]

Как видите, SlugField — это CharField с настроенным валидатором, который проверяет, что отправленный текст подчиняется некоторым правилам символов. Это также можно сделать для определения поля так:

slug = forms.SlugField()

эквивалентно:

slug = forms.CharField(validators=[validators.validate_slug])

Распространенные случаи, такие как проверка по электронной почте или регулярному выражению, могут быть обработаны с использованием существующих классов проверки, доступных в Django. Например, validators.validate_slug является экземпляром RegexValidator , построенным с первым аргументом, являющимся шаблоном: ^[-a-zA-Z0-9_]+$ . См. Раздел о написании валидаторов, чтобы увидеть список того, что уже доступно, и пример того, как написать валидатор.

Очистка полей формы по умолчанию

Давайте сначала создадим поле пользовательской формы,которое проверяет,что его входные данные-это строка,содержащая адреса электронной почты,разделенные запятыми.Полный класс выглядит следующим образом:

from django import forms
from django.core.validators import validate_email

class MultiEmailField(forms.Field):
    def to_python(self, value):
        """Normalize data to a list of strings."""
        
        if not value:
            return []
        return value.split(',')

    def validate(self, value):
        """Check if value consists only of valid emails."""
        
        super().validate(value)
        for email in value:
            validate_email(email)

В каждой форме,использующей это поле,эти методы будут выполняться до того,как с данными поля можно будет сделать что-либо еще.Это очистка,специфичная для данного типа поля,независимо от того,как оно будет использоваться в дальнейшем.

Давайте создадим ContactForm , чтобы продемонстрировать, как вы будете использовать это поле:

class ContactForm(forms.Form):
    subject = forms.CharField(max_length=100)
    message = forms.CharField()
    sender = forms.EmailField()
    recipients = MultiEmailField()
    cc_myself = forms.BooleanField(required=False)

Используйте MultiEmailField , как и любое другое поле формы. Когда is_valid() метод вызывается на форме, MultiEmailField.clean() метод будет работать как часть процесса очистки , и это, в свою очередь, вызывать пользовательские to_python() и validate() методы.

Очистка конкретного атрибута поля

Продолжая предыдущий пример, предположим, что в нашей ContactForm мы хотим убедиться, что поле recipients всегда содержит адрес "fred@example.com" . Это проверка, специфичная для нашей формы, поэтому мы не хотим помещать ее в общий класс MultiEmailField . Вместо этого мы пишем метод очистки, который работает с полем recipients

from django import forms
from django.core.exceptions import ValidationError

class ContactForm(forms.Form):
    
    ...

    def clean_recipients(self):
        data = self.cleaned_data['recipients']
        if "fred@example.com" not in data:
            raise ValidationError("You have forgotten about Fred!")

        
        
        return data

Очистка и проверка полей,которые зависят друг от друга.

Предположим, мы добавляем еще одно требование к нашей контактной форме: если поле cc_myself равно True , subject должна содержать слово "help" . Мы выполняем проверку более чем одного поля одновременно, поэтому метод clean() формы является хорошим местом для этого. Обратите внимание, что здесь мы говорим о методе clean() для формы, тогда как ранее мы писали метод clean() для поля. Важно сохранять четкость поля и различия формы при работе над тем, где проверять вещи. Поля — это отдельные точки данных, формы — это набор полей.

К тому времени, когда будет вызван метод clean() формы , все методы очистки отдельных полей будут запущены (предыдущие два раздела), поэтому self.cleaned_data будет заполнен всеми данными, которые сохранились до сих пор. Поэтому вам также необходимо помнить о том, что поля, которые вы хотите проверить, могли не пройти первоначальную проверку отдельных полей.

На этом этапе есть два способа сообщить о любых ошибках. Вероятно, наиболее распространенный способ — отобразить ошибку в верхней части формы. Чтобы создать такую ​​ошибку, вы можете вызвать ValidationError из метода clean() . Например:

from django import forms
from django.core.exceptions import ValidationError

class ContactForm(forms.Form):
    
    ...

    def clean(self):
        cleaned_data = super().clean()
        cc_myself = cleaned_data.get("cc_myself")
        subject = cleaned_data.get("subject")

        if cc_myself and subject:
            
            if "help" not in subject:
                raise ValidationError(
                    "Did not send for 'help' in the subject despite "
                    "CC'ing yourself."
                )

В этом коде, если возникает ошибка проверки, форма будет отображать сообщение об ошибке вверху формы (обычно) с описанием проблемы. Такие ошибки не относятся к полевым ошибкам, которые отображаются в шаблоне с помощью {{ form.non_field_errors }} .

Вызов super().clean() в коде примера гарантирует, что любая логика проверки в родительских классах сохраняется. Если ваша форма наследует другую, которая не возвращает словарь cleaned_data в своем методе clean() (это необязательно), то не назначайте cleaned_data результату вызова super() и вместо этого используйте self.cleaned_data :

def clean(self):
    super().clean()
    cc_myself = self.cleaned_data.get("cc_myself")
    ...

Второй подход для сообщения об ошибках валидации может включать присвоение сообщения об ошибке одному из полей.В данном случае давайте присвоим сообщение об ошибке обеим строкам «subject» и «cc_myself» в отображении формы.Будьте осторожны,делая это на практике,так как это может привести к запутанному выводу формы.Мы показываем,что здесь возможно,и предоставляем вам и вашим дизайнерам самим решать,что будет эффективно работать в вашей конкретной ситуации.Наш новый код (заменяющий предыдущий пример)выглядит следующим образом:

from django import forms

class ContactForm(forms.Form):
    
    ...

    def clean(self):
        cleaned_data = super().clean()
        cc_myself = cleaned_data.get("cc_myself")
        subject = cleaned_data.get("subject")

        if cc_myself and subject and "help" not in subject:
            msg = "Must put 'help' in subject when cc'ing yourself."
            self.add_error('cc_myself', msg)
            self.add_error('subject', msg)

Второй аргумент add_error() может быть строкой или предпочтительно экземпляром ValidationError . См. Повышение ValidationError для получения дополнительной информации. Обратите внимание, что add_error() автоматически удаляет поле из cleaned_data .

Django

4.1

• Форма модели Функции

  Ссылка на API API модели формы.

• API рендеринга формы

  Виджеты форм в Django отображаются с помощью системы шаблонизаторов.

• Widgets

  Виджет-это представление Django элемента ввода HTML.

• Built-in widgets

  Django предоставляет представление всех основных HTML виджетов,плюс некоторые часто используемые группы в модуле django.forms.widgets,включая текст ввода,различные

Prerequisites: Django Installation | Introduction to Django
Django works on an MVT pattern. So there is a need to create data models (or tables). For every table, a model class is created. 
Suppose there is a form that takes Username, gender, and text as input from the user, the task is to validate the data and save it.
In django this can be done, as follows:
 

After creating the data models, the changes need to be reflected in the database to do this run the following command:
 

python manage.py makemigrations

Doing this compiles the models and if it didn’t find any errors then, it creates a file in the migration folder. Later run the command given below to finally reflect the changes saved onto the migration file onto the database.
 

python manage.py migrate

Now a form can be created. Suppose that the username length should not be less than 5 and post length should be greater than 10. Then we define the Class PostForm with the required validation rules as follows: 
 

Till now, the data models and the Form class are defined. Now the focus will be on how these modules, defined above, are actually used.
First, run on localhost through this command 
 

python manage.py runserver

Open http://localhost:8000/ in the browser, then it’s going to search in the urls.py file, looking for ‘ ‘ path
urls.py file is as given below: 
 

Basically, this associates the ‘ ‘ url with a function home which is defined in views.py file.
views.py file: 
 

home.html template file 
 

Opening http://localhost:8000/ in the browser shows the following,
 

If a form with a username of length less than 5 is submitted, it gives an error at the time of submission and similarly for the Post Text filled as well. The following image shows how the form behaves on submitting invalid form data.