Pydantic で Python のデータを検証する

​

はじめに

• この記事では、pydantic を使ったデータ検証について解説します。pydantic は、検証のコア (pydantic-core) が Rust で書かれた Python ライブラリです。例では pydantic v2 を使用します。
• はじめる前に、お使いの環境に Python と pydantic ライブラリがインストールされていることを確認してください。pydantic のインストールコマンドは以下のとおりです。

pip install pydantic

​

モデルの作成

• まず、検証を始めるために、pydantic.BaseModel をインポートしてクラスに継承させる必要があります。この例では Person という名前のクラスを作成し、name、age、e-mail を持たせます。

from pydantic import BaseModel

class Person(BaseModel):
    name: str
    age: int
    email: str

• このクラスをインスタンス化すると、pydantic は name と email が文字列であること、age が整数であることを検証します。

​

モデルの使用

• 作成できたので、クラスをインスタンス化します。データを含む辞書を作成し、それをクラスに展開して渡します。

data = {
    "name": "John",
    "age": 19,
    "email": "john@example.com"
}
person = Person(**data)

• 上記の例では、すべての フィールド が正しい型になっているため、エラーは発生しません。pydantic はデフォルトで互換性のある値も変換します。age が文字列 "19" の場合は、整数 19 になります。次に、検証が機能することを確認するために、誤ったデータを渡します。

data = {
    "name": "John",
    "age": "nineteen",
    "email": "john@example.com"
}
person = Person(**data)

• 上記の例では、age は 整数 である必要があり、"nineteen" は整数に変換できないため、ValidationError が発生します。

1 validation error for Person
age
  Input should be a valid integer, unable to parse string as an integer [type=int_parsing, input_value='nineteen', input_type=str]

• エラーでプログラムを止めずに処理するには、try/except で捕捉します。errors() メソッドで、無効なフィールドを 1 つずつ確認できます。

from pydantic import ValidationError

try:
    Person(name="John", age="nineteen", email="john@example.com")
except ValidationError as error:
    for item in error.errors():
        print(item["loc"], item["msg"])
# ('age',) Input should be a valid integer, unable to parse string as an integer

​

strict モード

• "19" のような文字列も拒否したい場合は、モデルで strict モードを有効にします。すると age は本物の int しか受け付けなくなり、Person(name="John", age="19", email="john@example.com") は ValidationError を発生させます。

from pydantic import BaseModel, ConfigDict

class Person(BaseModel):
    model_config = ConfigDict(strict=True)

    name: str
    age: int
    email: str

​

dataclass の作成

• pydantic を使って dataclass を作成することもできます。これは標準の Python の dataclass に似ていますが、BaseModel と同じようにフィールドを検証します。

from pydantic.dataclasses import dataclass

@dataclass
class Person:
    name: str
    age: int
    email: str

• age に文字列 "19" を渡すと、int の 19 に変換されます。

​

その他

• Pydantic には、e-mail の検証やフォールバック用の timezone パッケージなどの追加機能があります。これらをインストールするには、次のコマンドを実行します。

pip install "pydantic[email]"

pip install "pydantic[timezone]"

• 次のコマンドを実行すると、両方を一度にインストールできます。

pip install "pydantic[email,timezone]"

• pydantic[email] は EmailStr 型を追加します。この型は user@domain.tld の形式を検証し、アドレスを正規化します。

from pydantic import EmailStr
from pydantic.dataclasses import dataclass

@dataclass
class Person:
    name: str
    age: int
    email: EmailStr

​

起動時に環境変数を検証する

• ボットや API は、トークンや設定を環境変数から読み込みます。pydantic-settings を使うと、変数がない、または無効な場合に、リクエストの処理中に後から失敗するのではなく、起動時にわかりやすいエラーでアプリケーションを停止できます。

pip install pydantic-settings

• アプリケーションが必要とする変数を、BaseSettings を継承したクラスで宣言します。各フィールドは、大文字と小文字を区別せずに同じ名前の環境変数を読み込みます。discord_token は DISCORD_TOKEN を読み込みます。

from pydantic import SecretStr
from pydantic_settings import BaseSettings


class Settings(BaseSettings):
    discord_token: SecretStr  # required: the application doesn't start without it
    port: int = 80  # optional: 80 when PORT isn't set
    debug: bool = False


settings = Settings()

• DISCORD_TOKEN が設定されていない場合、Settings() は discord_token について Field required というメッセージの ValidationError を発生させます。port は整数でなければならないため、PORT=abc のような値も同じように失敗します。
• SecretStr は、設定を print したりログに出力したりするときにトークンを隠します。実際の値は settings.discord_token.get_secret_value() で読み込みます。
• Square Cloud では、ダッシュボードまたは squarecloud app env set で変数を設定し、requirements.txt に pydantic-settings を記載してください。環境変数を参照してください。

​

次のステップ

​

この記事は役に立ちましたか？

• 私たちは可能な限り最良のサポートを提供するため、細心の注意を払ってこのコンテンツを作成しました。 この記事が少しでもお役に立ったなら、ぜひ私たちの活動を応援してください。すでに多くの開発者が Google と Trustpilot で Square Cloud に 402 件のレビューで 4.9/5 の評価をつけています。あなたのレビューもぜひ残してください。あなたにとって何が最も重要かを理解する助けになります。