バリデータ (validator) は呼び出し可能なオブジェクトで、値を受け取り、ある基準を満たしていない場合に ValidationError を発生させます。バリデータは異なるタイプのフィールド間でバリデーションロジックを再利用するのに便利です。
たとえば、以下は偶数のみを許容するバリデータです。
\nfrom django.core.exceptions import ValidationError\nfrom django.utils.translation import gettext_lazy as _\n\n\ndef validate_even(value):\n if value % 2 != 0:\n raise ValidationError(\n _("%(value)s is not an even number"),\n params={"value": value},\n )\nこれはフィールドの validators 属性を通じて設定できます:
from django.db import models\n\n\nclass MyModel(models.Model):\n even_field = models.IntegerField(validators=[validate_even])\n値はバリデータ実行前に Python に変換されているため、フォームでも同じバリデータを使用できます:
\nfrom django import forms\n\n\nclass MyForm(forms.Form):\n even_field = forms.IntegerField(validators=[validate_even])\nより複雑なバリデータに対しては、クラスで __call__() メソッドを利用することもできます。RegexValidator はその一例で、このテクニックを使っています。クラスベースのバリデータが validators モデルフィールドのオプション内で使用されるときは、deconstruct() と __eq__() メソッドを追加して マイグレーションフレームワークによりシリアライズ可能 になるようにしてください。
バリデータが実行される方法については、フォーム上での実行は フォームのバリデーション、モデル上の実行は オブジェクトを検証する にそれぞれ詳細が記載されています。モデルを save してもバリデータは自動的には呼び出されませんが、ModelForm を使用している場合にはフォームに含まれるすべてのフィールドでバリデータを実行することに注意してください。モデルのバリデーションがフォーム上でどのように動作するかについては、ModelForm ドキュメント を参照してください。
django.core.validators モジュールは、モデルやフォームで使用する呼び出し可能なバリデータの集まりを有しています。これらは内部で使用されますが、作成したフィールドで使用することもできます。 追加で使うことも、field.clean() メソッドの代わりに使うことも可能です。
RegexValidatorLink to this heading#regex -- None 以外の場合、regex をオーバーライドします。正規表現の文字列か、コンパイル済みの正規表現を指定します。
message -- None 以外の場合、message をオーバーライドします。
code -- None 以外の場合、code をオーバーライドします。
inverse_match -- None 以外の場合、inverse_match をオーバーライドする。
flags -- None 以外の場合、flags をオーバーライドします。指定する場合、regex は正規表現の文字列にする必要があります。それ以外の場合は TypeError が発生します。
RegexValidator は、与えられた value を指定された正規表現で re.search() で検索します。デフォルトでは、一致が 見つからない 場合に message と code を持つ ValidationError を発生させます。inverse_match を True に設定することで、動作を逆にできます。この場合、一致が 見つかった ときに ValidationError が発生します。
re.search() を使用して、指定された value 内を検索する正規表現パターンです。これは文字列か re.compile() で作成されたコンパイル済みの正規表現です。 デフォルトは空文字列で、すべての value から検索されます。
バリデーションが失敗した場合に ValidationError で使用されるエラーメッセージです。デフォルトは "Enter a valid value" です。
バリデーションが失敗した場合に ValidationError で使用されるエラーコードです。デフォルトは "invalid" です。
regex に対する match モードです。デフォルトは False です。
EmailValidatorLink to this heading#EmailValidator は値がメールアドレスとして解釈可能であることを確認し、そうでない場合は message と code を持つ ValidationError を発生させます。320 文字以上の値は常に無効とみなされます。
バリデーションに失敗した場合に ValidationError が使用するエラーメッセージです。デフォルトは "Enter a valid email address" です。
バリデーションが失敗した場合に ValidationError で使用されるエラーコードです。デフォルトは "invalid" です。
メールドメインの許可リスト。デフォルトでは、正規表現(domain_regex 属性)を使って @ 記号の後に現れる文字列を検証します。しかし、その文字列が allowlist に含まれている場合、この検証はバイパスされます。指定しない場合、デフォルトの allowlist は ['localhost'] です。ドットを含まない他のドメインはバリデーションを通過しないので、必要に応じて allowlist に追加する必要があります。
URLValidatorLink to this heading#RegexValidator のサブクラスで、値が URL として解釈可能であることを確認し、そうでない場合は 'invalid' というエラーコードを発生させます。 max_length 文字より長い値は常に無効とみなされます。
ループバックアドレスと予約済み IP スペースは有効とみなされます。リテラル IPv6 アドレス (RFC 3986 Section 3.2.2) と Unicode ドメインの両方がサポートされています。
\n親クラスである RegexValidator のオプション引数に加え、 URLValidator はさらにオプション属性を受け付けます：
検証するURL/URIスキームのリスト。指定がない場合、デフォルトのリストは ['http', 'https', 'ftp', 'ftps'] です。参考として、IANAのウェブサイトに valid URI schemes の完全なリストがあります。
有効な値とみなされる最大長。デフォルトは2048文字です。
\nvalidate_emailLink to this heading#カスタマイズされていない EmailValidator インスタンスです。
validate_slugLink to this heading#値が文字、数字、アンダースコアまたはハイフンのみで構成されていることを確認する RegexValidator インスタンスです。
validate_unicode_slugLink to this heading#値が Unicode 文字、数字、アンダースコア、またはハイフンのみで構成されていることを確認する RegexValidator インスタンスです。
validate_ipv4_addressLink to this heading#値がIPv4アドレスとして解釈可能であることを保証する RegexValidator インスタンスです。
validate_ipv6_addressLink to this heading#IPv6 アドレスの有効性をチェックするには django.utils.ipv6 を使います。
validate_ipv46_addressLink to this heading#validate_ipv4_address と validate_ipv6_address の両方を使用して、値が有効な IPv4 アドレスまたは IPv6 アドレスであることを確認します。
validate_comma_separated_integer_listLink to this heading#値がカンマで区切られた整数のリストであることを確認する RegexValidator インスタンスです。
int_list_validatorLink to this heading#文字列が sep で区切られた整数で構成されていることを確認する RegexValidator インスタンスを返します。これは allow_negative が True の場合に負の整数を許容します。
MaxValueValidatorLink to this heading#value が limit_value よりも大きい場合、'max_value' のエラーコードを持つ ValidationError を発生させます。limit_value には呼び出し可能オブジェクトを指定可能です。
MinValueValidatorLink to this heading#value が limit_value よりも小さい場合、'min_value' のエラーコードを持つ ValidationError を発生させます。limit_value には呼び出し可能オブジェクトを指定できます。
MaxLengthValidatorLink to this heading#value が limit_value よりも長い場合、'max_length' のエラーコードを持つ ValidationError を発生させます。limit_value には呼び出し可能オブジェクトを指定できます。
MinLengthValidatorLink to this heading#value が limit_value よりも短い場合、'min_length' のエラーコードを持つ ValidationError を発生させます。limit_value には呼び出し可能オブジェクトを指定できます。
DecimalValidatorLink to this heading#以下のコードで ValidationError を例外を発生させます：
桁数が max_digits より大きい場合は 'max_digits' 。
小数点以下の桁数が decimal_places より大きい場合は 'max_decimal_places' 。
整数部の桁数が max_digits と decimal_places の差よりも大きい場合は、'max_whole_digits' 。
FileExtensionValidatorLink to this heading#value.name (value は File) の拡張子が allowed_extensions で見つからなかった場合、 ValidationError を 'invalid_extension' のエラーコードで発生させます。拡張子は大文字小文字を区別せずに allowed_extensions と比較されます。
validate_image_file_extensionLink to this heading#Pillow を使って value.name (value は File) が 有効な画像拡張子 を持っていることを確認します。
ProhibitNullCharactersValidatorLink to this heading#str(value) に null 文字 ('˶x00') が一つ以上含まれる場合、 ValidationError を発生させます。
バリデーションに失敗した場合に ValidationError が使用するエラーメッセージです。デフォルトは "Null characters are not allowed." です。
バリデーションに失敗した場合に ValidationError が使用するエラーコードです。デフォルトは "null_characters_not_allowed" です。
StepValueValidatorLink to this heading#値が limit_value の整数倍でない場合、 ValidationError を 'step_size' のコードで発生させます。 offset が設定されている場合は、 limit_value と offset を足した値に対してバリデーションが行われます。たとえば、 StepValueValidator(3, offset=1.4) の場合、有効な値は 1.4、4.4、7.4、10.4 などです。