Validatorとは | Hakky Handbook

pydantic の Validator とは

ここまでの説明で model で定義したフィールド値は特定の型にすることができたかと思いますが、人によってはその値がフォーマットに合っているかどうか、一定基準に満たしているのかなどチェックしたい方もいるかと思います。

本記事では Validator という機能を用いてモデルのフィールドを検証するやり方を紹介していきます。

この記事で伝えたいこと

pydantic の validator の基本的な使い方と実装例
validator はどんな時に使えるのか
公式ドキュメントのうち、特に遭遇しやすいパターンに対する実装例

具体的な使い方

フィールド値を検証したい場合、@validatorデコレータを使うことで実現できます。

モデル内に下記のような validator デコレータをつけた関数を定義することで、@validator で指定したフィールド値に対して作成した関数が実行されます。

@validator("some_field_value")
def custom_validator(cls, v):
    # 検証内容を記載

validator はクラスメソッドのため、第一引数は cls となります。第二引数は検証対象の値が入りますが、任意の名前をつけることができます。

Validator の返り値は必ず、下記のいずれかである必要があります。

解析された値
ValueError
assert 文を使用した AssersionError

下記コード例では、name に空白が入っているか、password が一致しているか、username がアルファベットなのかを検証しています。

# デコレータを使うためにはvalidator、エラー検証のためにはValidationErrorをインポートする必要があります
from pydantic import BaseModel, ValidationError, validator


class UserModel(BaseModel):
    name: str
    username: str
    password1: str
    password2: str

    @validator("name")  # フィールド値を指定する
    def name_must_contain_space(cls, v):  # validatorはクラスメソッド。第２引数は好きな名前でOK
        if " " not in v:
            raise ValueError("must contain a space")
        return v.title() # 先頭文字を大文字にしている

    @validator("password2")
    def passwords_match(
        cls, v, values, **kwargs
    ):  # values, **kwargsは　validatorのサブセットです。
        if "password1" in values and v != values["password1"]:
            raise ValueError("passwords do not match")
        return v

    @validator("username")
    def username_alphanumeric(cls, v):
        assert v.isalnum(), "must be alphanumeric"
        return v


user = UserModel(
    name="samuel colvin",
    username="scolvin",
    password1="zxcvbn",
    password2="zxcvbn",
)
print(user)

try:
    # Validation Errorの確認
    UserModel(
        name="samuel",        # 名前に空白が含まれていない
        username="scolvin!",  # アルファベット以外が含まれている
        password1="zxcvbn",
        password2="zxcvbn2",  # password1とpassword2が一致しない
    )
except ValidationError as e:
    print(e)

上記を実行すると、結果は下記のようになります。

python validator.py
name='Samuel Colvin' username='scolvin' password1='zxcvbn' password2='zxcvbn'
3 validation errors for UserModel
name
  must contain a space (type=value_error)
username
  must be alphanumeric (type=assertion_error)
password2
  passwords do not match (type=value_error)

Validator のサブセットについて

validator には特定のキーワードのサブセットが用意されています。引数に設定するとそのサブセットの値を利用できるようになります。

values : 検証が終わっているフィールド値が辞書型で渡されます。
config : Config クラスが渡されます。
field : pydantic.fields.ModelField型で field 値が渡されます。
**kwarg : 明示していないサブセットが辞書型で渡されます。

下記コード例は渡されるサブセットの表示例になります。どのように値が渡されるのか確認しておきましょう。

from pydantic import BaseModel, validator


class Model(BaseModel):
    a: str
    b: str
    c: str

    @validator("a", "b")
    def subset_check(cls, v, values, config, field, **kwargs):
        print("v:{}".format(v))
        print("values:{}".format(values))
        print("config:{}".format(config))
        print("field:{}".format(field))
        print("**kwargs:{}".format(kwargs))
        print()
        return v

    @validator("c")
    def kwargs_checl(cls, v, **kwargs):
        print("v:{}".format(v))
        print("**kwargs:{}".format(kwargs))
        print()
        return v


Model(a="how", b="are", c="you?")

上記を実行すると、結果は下記のようになります。

$ python subset.py
v:how
values:{}
config:<class '__main__.Config'>
field:name='a' type=str required=True
**kwargs:{}

v:are
values:{'a': 'how'}
config:<class '__main__.Config'>
field:name='b' type=str required=True
**kwargs:{}

v:you?
**kwargs:{'values': {'a': 'how', 'b': 'are'}, 'field': ModelField(name='c', type=str, required=True), 'config': <class '__main__.Config'>}

特にありそうなパターンに対する対処法

複数のフィールド値を検証したいとき

検証対象のフィールドを@validator デコレータの()内に記載しますが、複数対象にしたい場合は（"a","b"）のようにカンマ区切りで複数対象に設定することが可能です。

また、全てのフィールド値を検証したい場合は（”＊”）で全て対象にすることができます。

下記コードは複数フィールドに対する検証例になります。

from pydantic import BaseModel, validator, ValidationError


class NameModel(BaseModel):
    first_name: str
    last_name: str
    nick_name: str

    @validator("*")
    def isalnum(cls, v):
        assert v.isalnum(), "must be alphanumeric"
        return v

    @validator("first_name", "last_name")
    def uppercase_first_letter(cls, v):
        return v.title()


name = NameModel(first_name="jane", last_name="doe", nick_name="joe")
print(name)

# errorチェック
try:
    NameModel(first_name="Jone!", last_name="Doe?", nick_name="joe*")
except ValidationError as e:
    print(e)

実行結果は下記のとおりとなります。成功例では first,last も一文字目が大文字（uppercase_first_letter が実行されている）になっており、失敗例で全てのフィールドがエラーになっている（isalnum が実行されている）ことを確認できます。

$ python multi_validator.py
first_name='Jane' last_name='Doe' nick_name='joe'
3 validation errors for NameModel
first_name
  must be alphanumeric (type=assertion_error)
last_name
  must be alphanumeric (type=assertion_error)
nick_name
  must be alphanumeric (type=assertion_error)

validator の優先順位を変更したいとき

validator デコレータにpre＝Trueキーワードを渡すと、その validator は先に検証を行います。

下記コード例では int 型の List が平方数かチェックしていますが、渡されたのが|で区切られた文字列の場合、｜で区切った List に変換する処理を先に行なっております。

from typing import List
from pydantic import BaseModel, validator


class DemoModel(BaseModel):
    square_numbers: List[int] = []

    @validator("*", pre=True) #先にこちらのvalidatorが実行されます。
    def split_str(cls, v):
        if isinstance(v, str):
            return v.split("|")
        return v

    @validator("square_numbers", each_item=True)
    def check_squares(cls, v):
        assert v**0.5 % 1 == 0, f"{v} is not a square number"
        return v


print(DemoModel(square_numbers="1|4|9|16"))
print(DemoModel(square_numbers=[1, 4, 9, 16]))

上記を実行すると、結果は下記のようになります。

$ python pre_validator.py
square_numbers=[1, 4, 9, 16]
square_numbers=[1, 4, 9, 16]

list などの個々の値に対して検証をしたいとき

前述の平方数チェックのように、each_item=Trueキーワードを渡すと、オブジェクト全体ではなく各値を検証するようになります。

ただし、サブクラスの場合は実行されないため注意してください。サブクラスでもここの値に対してチェックを行いたい場合、下記コード例 ChildModel2 のように繰り返しを用いてチェックを行います。

from pydantic import BaseModel, validator, ValidationError
from typing import List


class ParentModel(BaseModel):
    names: List[str]


# こちらは正常に動かない
class ChildModel1(ParentModel):
    @validator("names", each_item=True)
    def check_names_not_empty(cls, v):
        assert v != "", "Empty strings are not allowed."
        return v


# こちらは正常に動く
class ChildModel2(ParentModel):
    @validator("names")
    def check_names_not_empty(cls, v):
        for name in v:
            assert name != "", "Empty strings are not allowed."
        return v


try:
    child1 = ChildModel1(names=["a", "b", "", "c"])
except ValidationError as e:
    print(e)

try:
    child2 = ChildModel2(names=["a", "b", "", "c"])
except ValidationError as e:
    print(e)

実行結果は下記のとおりです。ChildModel2 のみしか ValidationError が発生していないことに注意してください。

$ python validator_child.py
1 validation error for ChildModel2
names
  Empty strings are not allowed. (type=assertion_error)

参考

Usage validators

備考

Hakky ではエンジニアを募集中です！まずは話してみたいなどでも構いませんので、ぜひお気軽に採用ページからお問い合わせくださいませ。