表单和字段验证

表单验证发生在清理数据的时候。如果你想自定义这个过程，有各种地方可以进行更改，每个地方都有不同的目的。在表单处理过程中会运行三种类型的清理方法。这些方法通常在调用表单上的 is_valid() 方法时执行。还有其他一些事情也可以触发清理和验证（访问 errors 属性或直接调用 full_clean()），但通常不需要。

一般来说，任何清理方法都可以在处理的数据出现问题时引发 ValidationError，将相关信息传递给 ValidationError 构造函数。 参见下文 关于引发 ``ValidationError` 的最佳实践。如果没有引发 ValidationError，该方法应该将清理后（规范化）的数据作为 Python 对象返回。

大多数验证可以使用 validators —— 可以重复使用的辅助功能来完成。验证器是函数（或可调用对象），它只接受一个参数，并在无效输入时引发 ValidationError。验证器在字段的 to_python 和 validate 方法被调用后运行。

表单的验证分为几个步骤，可以自定义或覆盖：

• Field 上的 to_python() 方法是每次验证的第一步。它强制将值转换为正确的数据类型，并在不可能的情况下引发 ValidationError。该方法接受来自部件的原始值并返回转换后的值。例如，一个 FloatField 将把数据变成 Python float 或引发 ValidationError。

• Field 上的 validate() 方法处理不适合验证器的特定字段验证。它接受一个被强制为正确数据类型的值，并在任何错误时引发 ValidationError。这个方法不会返回任何东西，也不应该改变值。你应该覆盖它来处理你不能或不想放在验证器中的验证逻辑。

• Field 上的 run_validators() 方法会运行该字段的所有验证器，并将所有错误汇总到一个 ValidationError。你不应该需要覆盖这个方法。

• Field 子类上的 clean() 方法负责以正确的顺序运行 to_python()、validate() 和 run_validators() 并传播它们的错误。如果在任何时候，任何一个方法引发了 ValidationError，验证就会停止，并引发该错误。该方法返回干净的数据，然后将其插入到表单的 cleaned_data 字典中。

• clean_<fieldname>() 方法是在表单子类上调用的——其中 <fieldname> 被替换为表单字段属性的名称。这个方法做任何特定属性的清理工作，与字段的类型无关。这个方法不传递任何参数。你需要在 self.cleaned_data 中查找字段的值，并且记住，此时它将是一个 Python 对象，而不是在表单中提交的原始字符串（它将在 cleaned_data 中，因为上面的一般字段 clean() 方法已经清理了一次数据）。

  例如，如果你想验证一个叫 serialnumber 的 CharField 的内容是唯一的，clean_serialnumber() 就可以做这件事。你不需要一个特定的字段（它是一个 CharField），但你需要一个特定字段的验证，可能的话，清理／规范数据。

  这个方法的返回值会替换 cleaned_data 中的现有值，所以它必须是 cleaned_data 中的字段值（即使这个方法没有改变它）或一个新的干净值。

• 表单子类的 clean() 方法可以执行需要访问多个表单字段的验证。在这里，你可以放入诸如“如果提供了字段 A，字段 B 必须包含一个有效的电子邮件地址”这样的检查。如果你愿意，这个方法可以返回一个完全不同的字典，这个字典将被用作 cleaned_data。

  因为在调用 clean() 时，字段验证方法已经运行，所以你也可以访问表单的 errors 属性，它包含了所有清理单个字段时产生的错误。

  请注意，任何由 Form.clean() 覆盖引起的错误都不会与任何特定的字段相关联。它们会进入一个特殊的“字段”（称为 __all__），如果需要的话，你可以通过 non_field_errors() 方法来访问。如果你想将错误附加到表单中的某个特定字段，你需要调用 add_error()。

  还需要注意的是，当覆盖 ModelForm 子类的 clean() 方法时，有一些特殊的注意事项。（更多信息见 模型表单文档）

这些方法按上述顺序运行，每次只运行一个字段。 也就是说，对于表单中的每一个字段（按照表单定义中声明的顺序），先运行 Field.clean() 方法（或其覆盖），然后运行 clean_()。最后，一旦这两个方法对每个字段都被运行，无论前面的方法是否出错，都会执行 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.SlugField()

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)