【Python】Pydanticのvalidatorが非推奨だからfield_validatorを使って2段階バリデーションを実装する

はじまり#

リサちゃん

くそう、こんがらがってきやがった・・・

135ml

クロージャを使ってバリデーションチェックですね。

PydanticのBaseModelのバリデーションをする#

Pythonには、Pydanticという強力な型アノテーションおよび値のバリデーションを実装することが出来るライブラリがあります。

Python標準パッケージの中にdataclassesという似たような型ヒント用のライブラリもありますが、Pydanticの方がもっと強力に例外を発生することが出来るので、堅牢なコードを書くことが出来ます。

僕個人的には、Pydanticを導入したらコーディング中に型の不整合によってハマることは無くなりましたし、テストコードも使う以前よりも書きやすくなりました。

Pydantic Docs

Welcome to Pydantic

pydantic.dev

そして今回は、そのPydanticの機能を利用する上で最も使うであろうクラスのBaseModelクラスに対する型アノテーションと値のバリデーションチェックを実装するまでの流れを紹介していきます。

ちなみに今回作ったコードは、以下のNotionのデータベースから取得したデータをAPIを介して渡したりリクエストするために作っていたものです。なのでNotionTasksとかいうクラス名になっているわけです。

エンドルフィン風呂に浸かる。

【Python、Golang】NotionのページのプロパティをCloud SQLのPostgreSQLに記録する（第1回）

NotionのページのプロパティをPythonで取得して、Cloud SQL上に作成されたPostgreSQLのDBに記録する手順を紹介します。Cloud FunctionsではCloud SQLを使えない。

www.endorphinbath.com

それでは行ってみましょう。

「クラス」メソッドと「インスタンス」メソッドの分別を付ける。#

まあ、まずはChatGPTに質問してみるわけです。「Pydanticでバリデーションチェックをするコードを書いて。」と。

1
from pydantic import BaseModel, validator, ValidationError
2

3
class MyModel(BaseModel):
4
    name: str = "default_name"  # 任意フィールド
5

6
    @validator("name", pre=True, always=True)
7
    def check_not_none(cls, v):
8
        if v is None:
9
            raise ValueError("name cannot be None")
10
        return v
11

12
# OK
13
model = MyModel(name="John")
14
print(model)
15

16
# Error: name cannot be None
17
try:
18
    model = MyModel(name=None)
19
except ValidationError as e:
20
    print(e)

そして疑問に思うわけです。

このpreとalwaysって・・・何だ？

そこでChatGPTに聞いてみるわけです。「@validator("name", pre=True, always=True)の処理の内容を教えて。」と。そして、返ってきた回答を意訳するとこんな感じでした。

pre=Trueは、バリデーションが「前処理の段階」で実行されることを意味します。 always=Trueは、フィールドに値が提供されていなくても、常にバリデーションを実行します。 Pydanticでは、バリデーションには 前処理（pre-processing） と 後処理（post-processing） があります。pre=True を設定すると、フィールドの型が適用される「前」にバリデーションが実行されます。また、always=Trueを設定すると、「入力がない場合にデフォルト値を使うが、そのデフォルト値もバリデーションを通したい」といったケースをカバーできます。

なるほど、クラスのフィールドに入る前と入る後の2種類のタイミングでバリデーションを評価することが出来るわけだ。すごいなPydantic。

この2つのモードでバリデーションをすれば、BaseModelに代入する前にはデータベース（PostgreSQLなど）の中でnot nullで定義したカラムが何らかの理由でNoneになった場合に例外を出すことが出来ます。（pre=True）

そして、BaseModelに代入した後にはデフォルト値を定義しておくことで、必ず代入しなければならないフィールドに代入されていないことを検知できて、値自体の評価をすることも可能です。（always=True）よし、実装してみよう。そして、渡されたコードを少しいじって動かしてみるわけです。ーーーしかし動かないのです。えっ・・・？

1
from pydantic import BaseModel, validator, ValidationError
2

3
class MyModel(BaseModel):
4
    name: str = "default_name"  # 任意フィールド
5

6
    @validator("name", pre=True, always=True)
7
    def check_not_none(self, v):
8
        if v is None:
9
            raise ValueError("name cannot be None")
10
        return v
11

12
# OK
13
model = MyModel(name="John")
14
print(model)
15

16
# Error: name cannot be None
17
try:
18
    model = MyModel(name=None)
19
except ValidationError as e:
20
    print(e)

エラーメッセージの抜粋。

pydantic.errors.PydanticUserError: @field_validator cannot be applied to instance methods

1
Positive prompt: Anime style, high quality, rough, (from above, upper body), 1 young woman with brown hairr, white eyes, Stinking eyes, wearing sports wear, sadness, under the blue sky
2
negative prompt: violence, sexual, derogatory, toxic
3
(generated by Imagen 3)

あれっ・・・、なんかそれっぽいイイ感じの回答が返ってきてたのに・・・。

いいえ、違います。これは僕がいじった内容に問題がありました。

これは、@classmethodを入れて、メソッドの第一引数にclsを指定したら直ります。なぜなら、Pythonで定義するクラスでは、そのクラスのメソッドの第一引数にclsを指定するとクラスメソッド、selfを指定するとインスタンスメソッドになるんですよねそう言えば。

なので、インスタンスメソッドではなくクラスメソッドとしてバリデーション用のメソッドを実行すれば問題なく通るわけです。（この例外はそれなりにPythonを使ってないと気付かなそう。）

1
    # ↓ class method
2
    @validator("name", pre=True, always=True)
3
    def check_not_none(cls, v):
4

5
    # ↓ instance method
6
    @validator("name", pre=True, always=True)
7
    def check_not_none(self, v):

@validatorデコレータは非推奨。#

それじゃあ、clsをselfで指定して、そんでもって@validatorを使った実装でハイッ解決。　　とはなりませんでした。

色々調べていくと、判明してしまったのです。（いや、して良かった。）

なんと、@validatorデコレータは非推奨、deprecatedだったのです。（@root_validatorも非推奨です。）

Pydantic Docs

Migration Guide

Migrating from Pydantic V1.

pydantic.dev

その公式ページには、@validatorは非推奨となり、さまざまな新機能と改善を提供する@field_validator に置き換える必要があるとかなんやら記載されています。なので、@field_validator でバリデーションの処理を書き換えました。それから、selfを渡していたメソッドにclsを渡してクラスメソッドにします。

1
from pydantic import BaseModel, Field, field_validator
2

3
class NotionTask(BaseModel):
4
    number: int = -1
5
    con_id: str = Field("default_value", example="TK000012345")
6
    page_id: str = Field("default_value", description="Notion page UUID")
7
    page_icon: str = Field(..., description="Notion page icon")
8
    is_page_archived: bool = Field(False, description="if page is archived")
9

10
    @field_validator("number")
11
    def validate_number(cls, v):
12
        FIELD_NAME = "con_id"
13
        if v is None:
14
            raise ValueError(f"'{FIELD_NAME}' cannot be None")
15
        if v <= -1:
16
            raise ValueError(f"'{FIELD_NAME}' must be over -1")
17
        return v
18

19
    @field_validator("con_id")
20
    def validate_con_id(cls, v):
21
        FIELD_NAME = "con_id"
22
        LENGTH_OF_CHARACTERS = 11
23
        if v is None:
24
            raise ValueError(f"'{FIELD_NAME}' cannot be None")
25
        if v == "default_value":
26
            raise ValueError(f"'{FIELD_NAME}' must not be 'default_value'")
27
        if len(v) != LENGTH_OF_CHARACTERS:
28
            raise ValueError(f"'{FIELD_NAME}' must have {LENGTH_OF_CHARACTERS} characters")
29
        return v
30

31
    @field_validator("page_id")
32
    def validate_page_id(cls, v):
33
        FIELD_NAME = "page_id"
34
        LENGTH_OF_CHARACTERS = 36
35
        if v is None:
36
            raise ValueError(f"'{FIELD_NAME}' cannot be None")
37
        if v == "default_value":
38
            raise ValueError(f"'{FIELD_NAME}' must have and not 'default_value'")
39
        if len(v) != LENGTH_OF_CHARACTERS:
40
            raise ValueError(f"'{FIELD_NAME}' must have {LENGTH_OF_CHARACTERS} characters")
41
        return v

そしてさらに、クラスメソッドに@classmethodのデコーレーターも付けて実行します。まあ、このコードは大丈夫だった気がします。

1
from pydantic import BaseModel, Field, field_validator
2

3
class NotionTask(BaseModel):
4
    number: int = -1
5
    con_id: str = Field("default_value", example="TK000012345")
6
    page_id: str = Field("default_value", description="Notion page UUID")
7
    page_icon: str = Field(..., description="Notion page icon")
8
    is_page_archived: bool = Field(False, description="if page is archived")
9

10
    @field_validator("number")
11
    @classmethod
12
    def validate_number(cls, v):
13
        FIELD_NAME = "con_id"
14
        if v is None:
15
            raise ValueError(f"'{FIELD_NAME}' cannot be None")
16
        if v <= -1:
17
            raise ValueError(f"'{FIELD_NAME}' must be over -1")
18
        return v
19

20
    @field_validator("con_id")
21
    @classmethod
22
    def validate_con_id(cls, v):
23
        FIELD_NAME = "con_id"
24
        LENGTH_OF_CHARACTERS = 11
25
        if v is None:
26
            raise ValueError(f"'{FIELD_NAME}' cannot be None")
27
        if v == "default_value":
28
            raise ValueError(f"'{FIELD_NAME}' must not be 'default_value'")
29
        if len(v) != LENGTH_OF_CHARACTERS:
30
            raise ValueError(f"'{FIELD_NAME}' must have {LENGTH_OF_CHARACTERS} characters")
31
        return v
32

33
    @field_validator("page_id")
34
    @classmethod
35
    def validate_page_id(cls, v):
36
        FIELD_NAME = "page_id"
37
        LENGTH_OF_CHARACTERS = 36
38
        if v is None:
39
            raise ValueError(f"'{FIELD_NAME}' cannot be None")
40
        if v == "default_value":
41
            raise ValueError(f"'{FIELD_NAME}' must have and not 'default_value'")
42
        if len(v) != LENGTH_OF_CHARACTERS:
43
            raise ValueError(f"'{FIELD_NAME}' must have {LENGTH_OF_CHARACTERS} characters")
44
        return v

しかし・・・、@field_validatorでは、先程の@validatorでは設定できた、pre=True とか、always=Trueを設定することが出来ません。（preとかを設定するとそんな感じのエラーが表示されるんですよね。）なので、フィールドの中に入れる前か入れる後でアノテーションやらバリデーションやらが漏れてしまうんですよね・・・。

他の方法は無いのか。

field_validatorのダブルバリデーションチェック#

Pydanticの公式リファレンスのこのページにその方法が掲載されていました。

Pydantic Docs

Validators

pydantic.dev

基本的にはそのページの通りに実装しました。そして実装の方法が2種類あるようです。上記の公式ページでは2種類とも使用して実行順序を示してくれていますが、実際に使う時には片方で事足りると思います。

1つ目は、from pydantic.functional_validators import field_validatorでインポートしたfield_validatorを使用する方法です。まずは、この方法で実装してみます。

元々@field_validatorとして実装していたものを、別のValidatorを使ってクロージャ（Callableを返す関数）として作り直すのが煩雑で大変でした。なので、こういう場合は、ゼロから適当なクラスを作って、それをベースに実装し直すと楽かも。そして、一旦ここまでコードが出来上がりました。これを実行してみます。

1
from typing import Any, Callable, ClassVar, List, cast
2
from pydantic import BaseModel, Field, field_validator, ValidationInfo
3

4
# Validator makers definition
5
def make_validator_it_is_not_none(validation_target: str) -> Callable[[Any, ValidationInfo], Any]:
6
    def validator(v: Any, info: ValidationInfo) -> Any:
7
        if v is None:
8
            raise ValueError(f"'{validation_target}' cannot be None")
9
        return v
10
    return validator
11
def validate_con_id_value(validation_target: str) -> Callable[[Any, ValidationInfo], Any]:
12
    def validator(v: Any, info: ValidationInfo) -> Any:
13
        LENGTH_OF_CHARACTERS = 11
14
        if v == "default_value":
15
            raise ValueError(f"'{validation_target}' must not be 'default_value'")
16
        if len(v) != LENGTH_OF_CHARACTERS:
17
            raise ValueError(f"'{validation_target}' must have {LENGTH_OF_CHARACTERS} characters")
18
        return v
19
    return validator
20
def make_validator_page_id_value_is_valid(validation_target: str) -> Callable[[Any, ValidationInfo], Any]:
21
    def validator(v: Any, info: ValidationInfo) -> Any:
22
        LENGTH_OF_CHARACTERS = 36
23
        if v == "default_value":
24
            raise ValueError(f"'{validation_target}' must have and not 'default_value'")
25
        if len(v) != LENGTH_OF_CHARACTERS:
26
            raise ValueError(f"'{validation_target}' must have {LENGTH_OF_CHARACTERS} characters")
27
        return v
28
    return validator
29

30
# Schema definition
31
class NotionTask(BaseModel):
32
    number: Annotated[int, -1]
33
    con_id: Annotated[str, Field("default_value", example="TK000012345")]
34
    page_id: Annotated[str, Field("default_value", description="Notion page UUID")]
35
    page_icon: Annotated[str, Field(..., description="Notion page icon")]
36
    is_page_archived: Annotated[bool, Field(False, description="if page is archived")]
37
    val_target = ""
38

39
    val_target = "number"
40
    val_number_before = field_validator(val_target, mode="before")(
41
        make_validator_it_is_not_none(val_target)
42
    )
43
    val_number_after = field_validator(val_target, mode="after")(
44
        make_validator_number_is_not_negative(val_target)
45
    )
46
    val_target = "con_id"
47
    val_con_id_before = field_validator(val_target, mode="before")(
48
        make_validator_it_is_not_none(val_target)
49
    )
50
    val_con_id_after = field_validator(val_target, mode="after")(
51
        validate_con_id_value(val_target)
52
    )
53
    val_target = "page_id"
54
    val_page_id_before = field_validator(val_target, mode="before")(
55
        make_validator_it_is_not_none(val_target)
56
    )
57
    val_page_id_after = field_validator(val_target, mode="after")(
58
        make_validator_page_id_value_is_valid(val_target)
59
    )
60
    val_target = "is_page_archived"
61
    # Validate nothing
62

63
@app.get("/task")
64
def return_all_tasks():
65
    result = {"number": 1, "con_id": "TK000012345", "page_id": "TK000012345TK000012345TK000012345789", "page_title": "test test title no test", "page_icon": "🍞", "is_page_archived": False}
66
    NotionTask.model_validate(result, context=context)
67
    return [NotionTask(**result)]

エラーメッセージです。

raise PydanticUserError( pydantic.errors.PydanticUserError: A non-annotated attribute was detected: val_target = 'con_id'. All model fields require a type annotation; if val_target is not meant to be a field, you may be able to resolve this error by annotating it as a ClassVar or updating model_config['ignored_types'].

1
Positive prompt: Anime style, high quality, rough, (from above, upper body), 1 young woman with brown hair, white eyes, Stinking eyes, wearing sports wear, sadness, under the blue sky
2
negative prompt: violence, sexual, derogatory, toxic
3
(generated by Imagen 3)

やっぱりシード値が変わると印象変わるなあ。

まあエラーメッセージに色々書いてありますが、結局は、ClassVarというアノテーションを付けるか、model_config['ignored_types']を設定するかの2種類の選択肢があるようですね。今回は、ClassVarを付けてクラス変数として定義するのが良さそうです。（先程も、インスタンスメソッドからクラスメソッドに直しましたね。）

1
    # ↓ インスタンス変数として宣言してしまっている。
2
    val_target = ""
3

4
    # ↓ クラス変数にする。
5
    from typing import ClassVar
6
    val_target: ClassVar[str] = ""

デフォルト値を設定し忘れると、代入不足が検知できない。#

さあ、クラス変数にしたから直ったぞ。と思って実行するのですが・・・、

・・・ここで、例外が発生しない不具合が発生してしまいます。なんてこった・・・。

先程のソースでは、わざとフィールドが不足するようにインスタンスを作成しようとしていました。なので、例外が発生しなければおかしいわけです。しかし発生しなかった・・・。

1
@app.get("/task")
2
def return_all_tasks():
3
    result = {"number": 1, "con_id": "TK000012345", "page_id": "TK000012345TK000012345TK000012345789", "page_title": "test test title no test", "page_icon": "🍞", "is_page_archived": False}
4
    NotionTask.model_validate(result, context=context)
5
    return [NotionTask(**result)]

この原因としては2つありました。1つ目は、クラス変数の宣言時に、デフォルト値が設定されていないことが原因でした。そして2つ目は、Fieldの中でvalidate_default=Trueという設定も必要でした。元々Annotatedの中のFieldで設定した"default_value"は何のフィルターとしても機能していなかったみたいです。

1
from typing import Any, Callable, ClassVar, List
2

3
# ↓ デフォルト値の設定をグローバルインスタンスに一元化した。
4
class Context(TypedDict):
5
    logs: List[str]
6
    default_value: str
7
context = Context(logs=[], default_value="default_value")
8

9
# ↓ 修正前：デフォルト値が設定されていない。
10
# Schema definition
11
class NotionTask(BaseModel):
12
    number: Annotated[int, -1]
13
    con_id: Annotated[str, Field("default_value", example="TK000012345")]
14

15
# ↓ 修正後：デフォルト値を設定した。
16
# Schema definition
17
class NotionTask(BaseModel):
18
    number: Annotated[int, -1]
19
    con_id: Annotated[str, Field(validate_default=True, example="TK000012345")] = context["default_value"]

修正したコードが下記のものです。これで、1つ目のバリデーション実装である、from pydantic.functional_validators import field_validatorでインポートしたfield_validatorを使用する方法が出来上がりました。（ちなみに、チラホラコメントアウトされている行は、2つ目の方法でバリデーションチェックを実装した部分です。）

1
from typing import Any, Callable, ClassVar, List, cast
2
from typing_extensions import Annotated, TypedDict
3
from pydantic import BaseModel, Field, field_validator, AfterValidator, BeforeValidator, ValidationInfo, HttpUrl
4

5
class NotionTask(BaseModel):
6
    number: Annotated[int, -1]
7
    con_id: Annotated[str, Field(validate_default=True, example="TK000012345")] = context["default_value"]
8
    page_id: Annotated[str, Field(validate_default=True, description="Notion page UUID")] = context["default_value"]
9
    page_title: Annotated[str, Field(...)]
10
    status: Annotated[str, Field(validate_default=True, description="Notion page UUID")] = context["default_value"]
11
    page_icon: Annotated[str, Field(..., description="Notion page icon")]
12
    is_page_archived: Annotated[bool, Field(False, description="if page is archived")]
13
    val_target: ClassVar[str] = ""
14

15
    val_target = "number"
16
    # number: Annotated[int, -1, BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_number_is_not_negative(val_target))]
17
    val_number_before = field_validator(val_target, mode="before")(
18
        make_validator_it_is_not_none(val_target)
19
    )
20
    val_number_after = field_validator(val_target, mode="after")(
21
        make_validator_number_is_not_negative(val_target)
22
    )
23
    val_target = "con_id"
24
    # con_id: Annotated[str, Field(validate_default=True, example="TK000012345"), BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_values_length_is_equal(val_target, 11))] = context["default_value"]
25
    val_con_id_before = field_validator(val_target, mode="before")(
26
        make_validator_it_is_not_none(val_target)
27
    )
28
    val_con_id_after = field_validator(val_target, mode="after")(
29
        make_validator_values_length_is_equal(val_target, 11)
30
    )
31
    val_target = "page_id"
32
    # page_id: Annotated[str, Field(validate_default=True, description="Notion page UUID"), BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_values_length_is_equal(val_target, 36))] = context["default_value"]
33
    val_page_id_before = field_validator(val_target, mode="before")(
34
        make_validator_it_is_not_none(val_target)
35
    )
36
    val_page_id_after = field_validator(val_target, mode="after")(
37
        make_validator_values_length_is_equal(val_target, 36)
38
    )
39
    val_target = "page_title"
40
    # page_title: Annotated[str, Field(validate_default=True), BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_value_is_less(val_target, 120))]
41
    val_page_title_before = field_validator(val_target, mode="before")(
42
        make_validator_it_is_not_none(val_target)
43
    )
44
    val_page_title_after = field_validator(val_target, mode="after")(
45
        make_validator_value_is_less(val_target, 120)
46
    )
47
    val_target = "status"
48
    # status: Annotated[str, Field(validate_default=True, description="Notion page UUID"), BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_values_length_is_equal(val_target, 36))] = context["default_value"]
49
    val_status_before = field_validator(val_target, mode="before")(
50
        make_validator_it_is_not_none(val_target)
51
    )
52
    val_status_after = field_validator(val_target, mode="after")(
53
        make_validator_values_length_is_equal(val_target, 36)
54
    )
55
    val_target = "page_icon"
56
    # page_icon: Annotated[str, Field(validate_default=True, description="Notion page icon"), BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_value_is_less(val_target, 2))]
57
    val_page_icon_before = field_validator(val_target, mode="before")(
58
        make_validator_it_is_not_none(val_target)
59
    )
60
    val_page_icon_after = field_validator(val_target, mode="after")(
61
        make_validator_value_is_less(val_target, 2)
62
    )
63
    val_target = "is_page_archived"
64
    # is_page_archived: Annotated[bool, False, BeforeValidator(make_validator_it_is_not_none(val_target))]
65
    val_is_page_archived_before = field_validator(val_target, mode="before")(
66
        make_validator_it_is_not_none(val_target)
67
    )
68
    # Validates nothing

例えばそのコードをFastAPI上で実行すると、フィールドの代入漏れがあると例外を発生するようになりました。これで、意図しないデータを誤ってレスポンスのボディに載せる挙動を無くすことが出来ます。

1
from fastapi import FastAPI
2

3
app = FastAPI(
4
    title="NotionSynchronizer API",
5
    summary="Retrieves Notion pages and manages with PostgreSQL",
6
    description="You will be able to:\n- Retrieve Notion pages.\n- Store info of Notion pages into PostgreSQL.",
7
    version="0.0.1",
8
    openapi_url="/api/v0/openapi.json",
9
    separate_input_output_schemas=True
10
)
11

12
@app.get("/task")
13
def return_all_tasks():
14
    result = {"number": 1, "con_id": "TK000012345", "page_id": "TK000012345TK000012345TK000012345789", "page_title": "test test title no test", "page_icon": "🍞", "is_page_archived": False}
15
    NotionTask.model_validate(result, context=context)
16
    return [NotionTask(**result)]
17
# pydantic_core._pydantic_core.ValidationError: 1 validation error for NotionTask
18
# status
19
#  Value error, 'status' must not be 'default_value' [type=value_error, input_value='default_value', input_type=str]

Annotatedの中でダブルバリデーションチェック#

次に、2つ目の実装方法である、BeforeValidatorとAfterValidatorをAnnotatedの中に入れる実装方法です。

先程のコード内で、from pydantic.functional_validators import field_validatorでインポートしたfield_validatorを使用する実装部分をコメントアウトして、BeforeValidatorとAfterValidatorをAnnotatedの中に入れる方法で実装した部分のコメントアウトを外します。

1
class NotionTask(BaseModel):
2
    # con_id: Annotated[str, Field(context["default_value"], example="TK000012345")]
3
    # page_id: Annotated[str, Field(context["default_value"], description="Notion page UUID")]
4
    # page_title: Annotated[str, Field(...)]
5
    # status: Annotated[str, Field(context["default_value"], description="Notion page UUID")]
6
    # page_icon: Annotated[str, Field(..., description="Notion page icon")]
7
    # is_page_archived: Annotated[bool, Field(False, description="if page is archived")]
8
    val_target: ClassVar[str] = ""
9

10
    val_target = "number"
11
    number: Annotated[int, -1, BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_number_is_not_negative(val_target))]
12
    # val_number_before = field_validator(val_target, mode="before")(
13
    #     make_validator_it_is_not_none(val_target)
14
    # )
15
    # val_number_after = field_validator(val_target, mode="after")(
16
    #     make_validator_number_is_not_negative(val_target)
17
    # )
18
    val_target = "con_id"
19
    con_id: Annotated[str, Field(validate_default=True, example="TK000012345"), BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_values_length_is_equal(val_target, 11))] = context["default_value"]
20
    # val_con_id_before = field_validator(val_target, mode="before")(
21
    #     make_validator_it_is_not_none(val_target)
22
    # )
23
    # val_con_id_after = field_validator(val_target, mode="after")(
24
    #     make_validator_values_length_is_equal(val_target, 11)
25
    # )
26
    val_target = "page_id"
27
    page_id: Annotated[str, Field(validate_default=True, description="Notion page UUID"), BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_values_length_is_equal(val_target, 36))] = context["default_value"]
28
    # val_page_id_before = field_validator(val_target, mode="before")(
29
    #     make_validator_it_is_not_none(val_target)
30
    # )
31
    # val_page_id_after = field_validator(val_target, mode="after")(
32
    #     make_validator_values_length_is_equal(val_target, 36)
33
    # )
34
    val_target = "page_title"
35
    page_title: Annotated[str, Field(validate_default=True), BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_value_is_less(val_target, 120))]
36
    # val_page_title_before = field_validator(val_target, mode="before")(
37
    #     make_validator_it_is_not_none(val_target)
38
    # )
39
    # val_page_title_after = field_validator(val_target, mode="after")(
40
    #     make_validator_value_is_less(val_target, 120)
41
    # )
42
    val_target = "status"
43
    status: Annotated[str, Field(validate_default=True, description="Notion page UUID"), BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_values_length_is_equal(val_target, 36))] = context["default_value"]
44
    val_status_before = field_validator(val_target, mode="before")(
45
        make_validator_it_is_not_none(val_target)
46
    )
47
    val_status_after = field_validator(val_target, mode="after")(
48
        make_validator_values_length_is_equal(val_target, 36)
49
    )
50
    val_target = "page_icon"
51
    page_icon: Annotated[str, Field(validate_default=True, description="Notion page icon"), BeforeValidator(make_validator_it_is_not_none(val_target)), AfterValidator(make_validator_value_is_less(val_target, 2))]
52
    # val_page_icon_before = field_validator(val_target, mode="before")(
53
    #     make_validator_it_is_not_none(val_target)
54
    # )
55
    # val_page_icon_after = field_validator(val_target, mode="after")(
56
    #     make_validator_value_is_less(val_target, 2)
57
    # )
58
    val_target = "is_page_archived"
59
    is_page_archived: Annotated[bool, False, BeforeValidator(make_validator_it_is_not_none(val_target))]
60
    # val_is_page_archived_before = field_validator(val_target, mode="before")(
61
    #     make_validator_it_is_not_none(val_target)
62
    # )
63
    # Validates nothing

このコードもFastAPI上で実行すると、先程のコードと同様にフィールドの代入漏れがあると例外を発生させるようになりました。（これが代入前のチェック。）

そして、フィールドの値自体が文字数の超過や不足が発生している場合も例外が発生するようになりました。（これが代入後のチェック。実は、先程のコードも同様のバリデーションチェックが可能です。）

1
# statusフィールドが存在しない場合のチェック
2
@app.get("/task")
3
def return_all_tasks():
4
    result = {"number": 1, "con_id": "TK000012345", "page_id": "TK000012345TK000012345TK000012345789", "page_title": "test test title no test", "page_icon": "🍞", "is_page_archived": False}
5
    NotionTask.model_validate(result, context=context)
6
    return [NotionTask(**result)]
7
# pydantic_core._pydantic_core.ValidationError: 1 validation error for NotionTask
8
# status
9
#   Value error, 'status' must not be 'default_value' [type=value_error, input_value='default_value', input_type=str]
10

11
# statusフィールドの文字列が短すぎる場合のチェック
12
@app.get("/task")
13
def return_all_tasks():
14
    result = {"number": 1, "con_id": "TK000012345", "page_id": "TK000012345TK000012345TK000012345789", "page_title": "test test title no test", "status": "TK000012345TK000012345TK00001234578", "page_icon": "🍞", "is_page_archived": False}
15
    NotionTask.model_validate(result, context=context)
16
    return [NotionTask(**result)]
17
# pydantic_core._pydantic_core.ValidationError: 1 validation error for NotionTask
18
# status
19
#   Value error, 'status' must have 36 characters [type=value_error, input_value='TK000012345TK000012345TK00001234578', input_type=str]
20

21
# statusフィールドの文字列が長すぎる場合のチェック
22
@app.get("/task")
23
def return_all_tasks():
24
    result = {"number": 1, "con_id": "TK000012345", "page_id": "TK000012345TK000012345TK000012345789", "page_title": "test test title no test", "status": "TK000012345TK000012345TK0000123457890", "page_icon": "🍞", "is_page_archived": False}
25
    NotionTask.model_validate(result, context=context)
26
    return [NotionTask(**result)]
27
# pydantic_core._pydantic_core.ValidationError: 1 validation error for NotionTask
28
# status
29
#   Value error, 'status' must have 36 characters [type=value_error, input_value='TK000012345TK000012345TK0000123457890', input_type=str]

このような流れで、Pydanticを用いてオブジェクトのフィールドの型安全を担保したコードを実装することが出来ます。これで自分のコードがより堅牢になると思います。

まとめ#

今回の記事は、クラスのフィールドのバリデーションチェックを@validatorで書いてみたが、@validatorはdeprecatedになってて、代わりに@field_validatorを使ってみる。しかし、@field_validatorにはpreとかalwaysフラグが無いから、from pydantic.functional_validators import field_validatorでインポートしたfield_validatorを使用する方法と、BeforeValidatorとAfterValidatorをAnnotateの中に入れる実装方法で実装してみた。という流れの記事でした。

例えば、データベースにデータを格納する時や、APIとしてレスポンスを返す時などに、Pydanticはより堅牢で明確な機能性を担保してくれるでしょう。

おしまい#

リサちゃん

よし、形になったぞ・・・

135ml

こういうのって最初が一番たいへんですよね。

以上になります！

音楽

音楽

はじまり#

PydanticのBaseModelのバリデーションをする#

「クラス」メソッドと「インスタンス」メソッドの分別を付ける。#

@validatorデコレータは非推奨。#

field_validatorのダブルバリデーションチェック#

デフォルト値を設定し忘れると、代入不足が検知できない。#

Annotatedの中でダブルバリデーションチェック#

まとめ#

おしまい#

記事を共有

音楽

目次