{"title":"バリデータ","version":"3.1","locale":"ja","docname":"ref/validators","url":"/ja/3.1/ref/validators/","canonical":"https://djangodocs.dev/ja/3.1/ref/validators/","summary":"バリデータを記述する Link to this heading # バリデータは、値を取って 特定の条件に合致しない場合に ValidationError を返す呼び出し可能オブジェクトです。バリデータは、異なるタイプのフィールド間におけるバリデーションロジックを再利用したいときに役立ちます。…","html":"

バリデータLink to this heading#

\n
\n

バリデータを記述するLink to this heading#

\n

バリデータは、値を取って 特定の条件に合致しない場合に ValidationError を返す呼び出し可能オブジェクトです。バリデータは、異なるタイプのフィールド間におけるバリデーションロジックを再利用したいときに役立ちます。

\n

例えば、以下は偶数のみを許容するバリデータです:

\n
Code
from django.core.exceptions import ValidationError\nfrom django.utils.translation import gettext_lazy as _\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
\n

これはフィールドの validators 属性を通じて設定することができます:

\n
Code
from django.db import models\n\nclass MyModel(models.Model):\n    even_field = models.IntegerField(validators=[validate_even])\n
\n

値はバリデータ実行前に Python に変換されているため、フォームでも同じバリデータを使用することができます:

\n
Code
from django import forms\n\nclass MyForm(forms.Form):\n    even_field = forms.IntegerField(validators=[validate_even])\n
\n

より複雑なバリデータに対しては、クラスで __call__() メソッドを利用することもできます。RegexValidator はその一例で、このテクニックを使っています。クラスベースのバリデータが validators モデルフィールドのオプション内で使用されるときは、deconstruct() と __eq__() メソッドを追加して 移行フレームワークによりシリアライズ可能 になるようにしてください。

\n
\n
\n

バリデータはどのように実行されるかLink to this heading#

\n

バリデータが実行される方法については、フォーム上での実行は フォームのバリデーション、モデル上の実行は オブジェクトを検証する にそれぞれ詳細が記載されています。モデルを save してもバリデータは自動的には呼び出されませんが、ModelForm を使用している場合にはフォームに含まれるすべてのフィールドでバリデータを実行することに注意してください。モデルのバリデーションがフォーム上でどのように動作するかについては、ModelForm ドキュメント を参照してください。

\n
\n
\n

ビルトインのバリデータLink to this heading#

\n

django.core.validators モジュールは、モデルやフォームで使用する呼び出し可能なバリデータの集まりを有しています。これらは内部で使用されますが、作成したフィールドで使用することもできます。 追加で使うことも、field.clean() メソッドの代わりに使うことも可能です。

\n
\n

RegexValidatorLink to this heading#

\n
\n
\nclass RegexValidator(regex=None, message=None, code=None, inverse_match=None, flags=0)Link to this definition#
\n
\n
パラメータ:
\n
    \n

  • regex -- None 以外の場合、regex をオーバーライドします。正規表現の文字列か、コンパイル済みの正規表現を指定します。

    • \n

  • message -- None 以外の場合、message をオーバーライドします。

    • \n

  • code -- None 以外の場合、code をオーバーライドします。

    • \n

  • inverse_match -- None 以外の場合、inverse_match をオーバーライドする。

    • \n

  • flags -- None 以外の場合、flags をオーバーライドします。指定する場合、regex は正規表現の文字列にする必要があります。それ以外の場合は TypeError が発生します。

    • \n
\n
\n
\n

A RegexValidator searches the provided value for a given\nregular expression with re.search(). By default, raises a\nValidationError with message and\ncode if a match is not found. Its behavior can be inverted by\nsetting inverse_match to True, in which case the\nValidationError is raised when a match\nis found.

\n
\n
\nregexLink to this definition#
\n

The regular expression pattern to search for within the provided\nvalue, using re.search(). This may be a string or a\npre-compiled regular expression created with re.compile().\nDefaults to the empty string, which will be found in every possible\nvalue.

\n
\n\n
\n
\nmessageLink to this definition#
\n

バリデーションが失敗した場合に ValidationError で使用されるエラーメッセージです。デフォルトは "Enter a valid value" です。

\n
\n\n
\n
\ncodeLink to this definition#
\n

バリデーションが失敗した場合に ValidationError で使用されるエラーコードです。デフォルトは "invalid" です。

\n
\n\n
\n
\ninverse_matchLink to this definition#
\n

regex に対する match モードです。デフォルトは False です。

\n
\n\n
\n
\nflagsLink to this definition#
\n

The regex flags used when\ncompiling the regular expression string regex. If regex\nis a pre-compiled regular expression, and flags is overridden,\nTypeError is raised. Defaults to 0.

\n
\n\n
\n\n
\n
\n

EmailValidatorLink to this heading#

\n
\n
\nclass EmailValidator(message=None, code=None, whitelist=None)Link to this definition#
\n
\n
パラメータ:
\n
    \n

  • message -- None 以外の場合、message をオーバーライドします。

    • \n

  • code -- None 以外の場合、code をオーバーライドします。

    • \n

  • whitelist -- If not None, overrides whitelist.

    • \n
\n
\n
\n
\n
\nmessageLink to this definition#
\n

The error message used by\nValidationError if validation fails.\nDefaults to "Enter a valid email address".

\n
\n\n
\n
\ncodeLink to this definition#
\n

バリデーションが失敗した場合に ValidationError で使用されるエラーコードです。デフォルトは "invalid" です。

\n
\n\n
\n
\nwhitelistLink to this definition#
\n

Whitelist of email domains to allow. By default, a regular expression\n(the domain_regex attribute) is used to validate whatever appears\nafter the @ sign. However, if that string appears in the whitelist, this\nvalidation is bypassed. If not provided, the default whitelist is\n['localhost']. Other domains that don't contain a dot won't pass\nvalidation, so you'd need to whitelist them as necessary.

\n
\n\n
\n\n
\n
\n

URLValidatorLink to this heading#

\n
\n
\nclass URLValidator(schemes=None, regex=None, message=None, code=None)Link to this definition#
\n

A RegexValidator subclass that ensures a value looks like a URL,\nand raises an error code of 'invalid' if it doesn't.

\n

Loopback addresses and reserved IP spaces are considered valid. Literal\nIPv6 addresses (RFC 3986 Section 3.2.2) and Unicode domains are both\nsupported.

\n

In addition to the optional arguments of its parent RegexValidator\nclass, URLValidator accepts an extra optional attribute:

\n
\n
\nschemesLink to this definition#
\n

URL/URI scheme list to validate against. If not provided, the default\nlist is ['http', 'https', 'ftp', 'ftps']. As a reference, the IANA\nwebsite provides a full list of valid URI schemes.

\n
\n\n
\n\n
\n
\n

validate_emailLink to this heading#

\n
\n
\nvalidate_emailLink to this definition#
\n

An EmailValidator instance without any customizations.

\n
\n\n
\n
\n

validate_slugLink to this heading#

\n
\n
\nvalidate_slugLink to this definition#
\n

A RegexValidator instance that ensures a value consists of only\nletters, numbers, underscores or hyphens.

\n
\n\n
\n
\n

validate_unicode_slugLink to this heading#

\n
\n
\nvalidate_unicode_slugLink to this definition#
\n

A RegexValidator instance that ensures a value consists of only\nUnicode letters, numbers, underscores, or hyphens.

\n
\n\n
\n
\n

validate_ipv4_addressLink to this heading#

\n
\n
\nvalidate_ipv4_addressLink to this definition#
\n

A RegexValidator instance that ensures a value looks like an IPv4\naddress.

\n
\n\n
\n
\n

validate_ipv6_addressLink to this heading#

\n
\n
\nvalidate_ipv6_addressLink to this definition#
\n

Uses django.utils.ipv6 to check the validity of an IPv6 address.

\n
\n\n
\n
\n

validate_ipv46_addressLink to this heading#

\n
\n
\nvalidate_ipv46_addressLink to this definition#
\n

Uses both validate_ipv4_address and validate_ipv6_address to\nensure a value is either a valid IPv4 or IPv6 address.

\n
\n\n
\n
\n

validate_comma_separated_integer_listLink to this heading#

\n
\n
\nvalidate_comma_separated_integer_listLink to this definition#
\n

A RegexValidator instance that ensures a value is a\ncomma-separated list of integers.

\n
\n\n
\n
\n

int_list_validatorLink to this heading#

\n
\n
\nint_list_validator(sep=',', message=None, code='invalid', allow_negative=False)Link to this definition#
\n

Returns a RegexValidator instance that ensures a string consists\nof integers separated by sep. It allows negative integers when\nallow_negative is True.

\n
\n\n
\n
\n

MaxValueValidatorLink to this heading#

\n
\n
\nclass MaxValueValidator(limit_value, message=None)Link to this definition#
\n

Raises a ValidationError with a code of\n'max_value' if value is greater than limit_value, which may be\na callable.

\n
\n\n
\n
\n

MinValueValidatorLink to this heading#

\n
\n
\nclass MinValueValidator(limit_value, message=None)Link to this definition#
\n

Raises a ValidationError with a code of\n'min_value' if value is less than limit_value, which may be a\ncallable.

\n
\n\n
\n
\n

MaxLengthValidatorLink to this heading#

\n
\n
\nclass MaxLengthValidator(limit_value, message=None)Link to this definition#
\n

Raises a ValidationError with a code of\n'max_length' if the length of value is greater than\nlimit_value, which may be a callable.

\n
\n\n
\n
\n

MinLengthValidatorLink to this heading#

\n
\n
\nclass MinLengthValidator(limit_value, message=None)Link to this definition#
\n

Raises a ValidationError with a code of\n'min_length' if the length of value is less than limit_value,\nwhich may be a callable.

\n
\n\n
\n
\n

DecimalValidatorLink to this heading#

\n
\n
\nclass DecimalValidator(max_digits, decimal_places)Link to this definition#
\n

Raises ValidationError with the following\ncodes:

\n
    \n

  • 'max_digits' if the number of digits is larger than max_digits.

    • \n

  • 'max_decimal_places' if the number of decimals is larger than\ndecimal_places.

    • \n

  • 'max_whole_digits' if the number of whole digits is larger than\nthe difference between max_digits and decimal_places.

    • \n
\n
\n\n
\n
\n

FileExtensionValidatorLink to this heading#

\n
\n
\nclass FileExtensionValidator(allowed_extensions, message, code)Link to this definition#
\n

Raises a ValidationError with a code of\n'invalid_extension' if the extension of value.name (value is\na File) isn't found in allowed_extensions.\nThe extension is compared case-insensitively with allowed_extensions.

\n\n
\n\n
\n
\n

validate_image_file_extensionLink to this heading#

\n
\n
\nvalidate_image_file_extensionLink to this definition#
\n

Uses Pillow to ensure that value.name (value is a\nFile) has a valid image extension.

\n
\n\n
\n
\n

ProhibitNullCharactersValidatorLink to this heading#

\n
\n
\nclass ProhibitNullCharactersValidator(message=None, code=None)Link to this definition#
\n

Raises a ValidationError if str(value)\ncontains one or more nulls characters ('\\x00').

\n
\n
パラメータ:
\n
    \n

  • message -- None 以外の場合、message をオーバーライドします。

    • \n

  • code -- None 以外の場合、code をオーバーライドします。

    • \n
\n
\n
\n
\n
\nmessageLink to this definition#
\n

The error message used by\nValidationError if validation fails.\nDefaults to "Null characters are not allowed.".

\n
\n\n
\n
\ncodeLink to this definition#
\n

The error code used by ValidationError\nif validation fails. Defaults to "null_characters_not_allowed".

\n
\n\n
\n\n
\n
","rootId":"module-django.core.validators","toc":[{"title":"バリデータを記述する","anchor":"writing-validators","children":[]},{"title":"バリデータはどのように実行されるか","anchor":"how-validators-are-run","children":[]},{"title":"ビルトインのバリデータ","anchor":"built-in-validators","children":[{"title":"RegexValidator","anchor":"regexvalidator","children":[]},{"title":"EmailValidator","anchor":"emailvalidator","children":[]},{"title":"URLValidator","anchor":"urlvalidator","children":[]},{"title":"validate_email","anchor":"validate-email","children":[]},{"title":"validate_slug","anchor":"validate-slug","children":[]},{"title":"validate_unicode_slug","anchor":"validate-unicode-slug","children":[]},{"title":"validate_ipv4_address","anchor":"validate-ipv4-address","children":[]},{"title":"validate_ipv6_address","anchor":"validate-ipv6-address","children":[]},{"title":"validate_ipv46_address","anchor":"validate-ipv46-address","children":[]},{"title":"validate_comma_separated_integer_list","anchor":"validate-comma-separated-integer-list","children":[]},{"title":"int_list_validator","anchor":"int-list-validator","children":[]},{"title":"MaxValueValidator","anchor":"maxvaluevalidator","children":[]},{"title":"MinValueValidator","anchor":"minvaluevalidator","children":[]},{"title":"MaxLengthValidator","anchor":"maxlengthvalidator","children":[]},{"title":"MinLengthValidator","anchor":"minlengthvalidator","children":[]},{"title":"DecimalValidator","anchor":"decimalvalidator","children":[]},{"title":"FileExtensionValidator","anchor":"fileextensionvalidator","children":[]},{"title":"validate_image_file_extension","anchor":"validate-image-file-extension","children":[]},{"title":"ProhibitNullCharactersValidator","anchor":"prohibitnullcharactersvalidator","children":[]}]}],"breadcrumbs":[{"docname":"ref/index","title":"API Reference","url":"/ja/3.1/ref/"}],"prev":{"docname":"ref/utils","title":"Django Utils","url":"/ja/3.1/ref/utils/"},"next":{"docname":"ref/views","title":"Built-in Views","url":"/ja/3.1/ref/views/"},"formats":{"html":"/ja/3.1/ref/validators/","markdown":"/ja/3.1/ref/validators.md","json":"/ja/3.1/ref/validators.json"},"source":"https://github.com/django/django/blob/stable/3.1.x/docs/ref/validators.txt","official":"https://docs.djangoproject.com/ja/3.1/ref/validators/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","zh-hans","fr","ja","id","pt-br","ko","es","el","pl"]}