【Python】Pydanticでデータバリデーションを実装する方法

当ページのリンクには広告が含まれています。
いずみ

こんな悩みを解決できる記事を書きました!

僕は現役フリーランスエンジニア(歴年)で、資格は個保有しています。

PythonでPydanticを使ったデータバリデーションを実装する方法を知りたい」とお考えではありませんか?

APIやフォームから受け取ったデータの型チェックを、手作業で書いていませんか。

Pydanticを使えば、クラス定義だけで型チェックとバリデーションを自動化することが可能です。

いずみ

FastAPIをはじめ多くのライブラリで採用されているツールなので、覚えておいて損はありません。

ということで、本記事ではPythonでPydanticを使ったデータバリデーションを実装する方法を解説します。

いずみ

すぐ読み終わるので、ぜひ最後まで読んでくださいませ。

スクロールできます
【当サイト】おすすめフリーランスエージェント3選
エージェント評価ポイント公式サイト
レバテックフリーランス

5.0
業界最大級のエージェント。
高単価案件が豊富。
公式
Midworks

4.8
満足度調査で
3年連続3冠を達成。
公式
ITプロパートナーズ

4.6
週2〜3向けの案件が豊富。公式
執筆者/監修者
  • フリーランスエンジニア(保有資格個、企業と直接契約
  • ブログ・アフィリエイト歴7年(2018年〜)
  • ブランドせどりで月利50万円⇨脱サラ
  • 投資(仮想通貨・FX)歴7年(2018年〜)
  • X(旧Twitter)フォロワー約1,900人
  • 運営者情報はこちら
いずみです
目次

【Python】Pydanticでデータバリデーションを実装する方法

早速ですが、PythonでPydanticを使ったデータバリデーションを実装する方法を解説します。

Pydanticとは

Pydanticは、Pythonの型ヒントを使ってデータのバリデーションと変換を行うライブラリです。

バージョン2以降はコアエンジンがRustで書き直されており、バリデーション処理が高速化されています。

FastAPIやLangChainなど、多くのライブラリの内部でも採用されています。

Pydanticの基本的な使い方

基本的な使い方として、インストールからモデル定義までを実装してみます。

STEP
pipでインストールする

pipコマンドでPydanticをインストールします。

pip install pydantic

仮想環境を使っている場合は、有効化してから実行してください。

STEP
BaseModelでモデルを定義する
from pydantic import BaseModel, Field

class UserModel(BaseModel):
    name: str = Field(min_length=1, max_length=50)
    email: str
    age: int = Field(ge=0, le=120)

user = UserModel(name='Izumi', email='izumi@example.com', age=35)
print(user)

BaseModelを継承したクラスを定義するだけで、型チェックが自動的に働きます。

Fieldを使うと、文字数や数値の範囲といった制約も宣言的に指定できます。

いずみ

型ヒントを書くだけでバリデーションが付いてくるので、コード量はかなり減ります。

バリデーションをカスタマイズする

単純な型チェックだけでなく、独自のルールでバリデーションを実装してみます。

STEP
field_validatorで単一フィールドを検証する
from pydantic import BaseModel, field_validator

class UserModel(BaseModel):
    name: str
    email: str

    @field_validator('email')
    @classmethod
    def validate_email(cls, v: str) -> str:
        if '@' not in v:
            raise ValueError('メールアドレスの形式が正しくありません')
        return v.lower()

field_validatorデコレータを使うと、特定のフィールドに独自の検証ロジックを追加できます。

STEP
model_validatorで複数フィールドを検証する
from pydantic import BaseModel, model_validator
from typing_extensions import Self

class SignupModel(BaseModel):
    password: str
    password_confirm: str

    @model_validator(mode='after')
    def check_passwords_match(self) -> Self:
        if self.password != self.password_confirm:
            raise ValueError('パスワードが一致しません')
        return self

model_validatorはモデル全体を対象にするため、複数フィールドをまたいだ整合性チェックに向いています。

いずみ

単一フィールドの検証はfield_validator、複数フィールドをまたぐ検証はmodel_validatorと使い分けるのがポイントです。

バリデーションエラーのハンドリング

不正な値を渡した場合、Pydanticは例外を送出します。

from pydantic import ValidationError

try:
    UserModel(name='Izumi', email='invalid-email')
except ValidationError as e:
    print(e.errors())

ValidationErrorをキャッチし、errorsメソッドを呼び出すと、失敗したフィールド名と理由を一覧で取得できます。

APIのレスポンスとしてそのままクライアントに返せば、エラー内容が分かりやすいメッセージになります。

スクロールできます
【当サイト】おすすめフリーランスエージェント3選
エージェント評価ポイント公式サイト
レバテックフリーランス

5.0
業界最大級のエージェント。
高単価案件が豊富。
公式
Midworks

4.8
満足度調査で
3年連続3冠を達成。
公式
ITプロパートナーズ

4.6
週2〜3向けの案件が豊富。公式

【厳選】フリーランスエンジニアにおすすめなエージェント3選

フリーランスエンジニアになるにはエージェントから案件をもらう必要があります。

僕が実際に利用しているおすすめエージェントを紹介しますね。

いずみ

エージェントは必ず複数登録してください。

担当者によっては「全然案件紹介してくれない…」みたいなこともあるので…

僕は実際に5つのエージェントを使い回していますよ。

フリーランスを始めるなら「

案件数マージン率単価
約88,000件非公開
初心者福利厚生申し込み
無料
Good Point
  • 業界最大級の案件数。
  • 業界トップクラスの高単価報酬、低マージン(平均年収862万円)。
  • 案件参画中のフォローの充実。

※詳細は「【業界最大手】レバテックフリーランスとは?メリットや利用手順を解説!」を参照。

は業界最大手のフリーランスエージェントです。

とにかく案件数が多いので、とりあえず登録しておけば間違いないエージェントです!

いずみ

僕もはじめてフリーランスの案件を貰ったのはです。

保有している案件数が多いので、業務経験がなくても何かしらの案件は紹介してもらえますよ(僕はJavaの経験3年でも案件を貰えました)。

手厚い保障を重視したいなら「

案件数マージン率単価
約10,000件非公開
初心者福利厚生申し込み
無料
Good Point
  • 手厚い保障で正社員並みの安心感。
  • 還元率60%超え&単価公開でクリアな契約。
  • 給与保障制度(審査あり)。

は手厚い保障が特徴のフリーランスエージェントです。

フリーランスを目指しているけど不安な方や保障を重視したい方におすすめです。

いずみ

僕も何度か案件を紹介してもらいました。

自分のスキルに合った案件を紹介してもらえましたし、電話のやり取りも非常に丁寧でした。

週2〜3日の案件探しなら「

案件数マージン率単価
約5,000件非公開
初心者福利厚生申し込み
経験者向け無料
Good Point
  • IT案件に特化したフリーランスエージェント。
  • 週2〜3日の案件が豊富。
  • リモート案件が多く、直エンドなので単価も高い。

※詳細は「【週2・3案件】ITプロパートナーズとは?メリットや利用手順を解説!」を参照。

はIT案件に特化したフリーランスエージェントです。

週2〜3日から参画できる案件が豊富なので、起業したい人にもおすすめです。

いずみ

週2〜3日の案件はある程度スキルがないと紹介してもらえない印象です。

とはいえ、週5の案件ももちろんありますし、僕が利用した時は迅速・丁寧に対応していただきました!

よくある質問

Pydantic v1とv2で書き方はどう変わりましたか?

v1の@validator@field_validatorに置き換わりました。

設定用のclass Configも、model_config = ConfigDict()という書き方に変更されています。

dataclassとBaseModelはどちらを使うべきですか?

標準のdataclassには型変換やバリデーション機能が無いため、外部から受け取るデータを扱うならBaseModelが適しています。

内部だけで完結する単純なデータ構造であれば、dataclassでも十分です。

Pydanticはどのくらい高速なのですか?

バージョン2からコアエンジンがRustで実装されたpydantic-coreに置き換わり、旧バージョンより大幅に高速化されています。

大量のリクエストを処理するAPIサーバーでも、バリデーション処理がボトルネックになりにくくなっています。

まとめ

今回は、PythonでPydanticを使ったデータバリデーションを実装する方法について解説しました。

以下が本記事のまとめになります。

まとめ
  • Pydanticは、クラス定義だけで型チェックとバリデーションを自動化できる。
  • field_validatorとmodel_validatorを使い分けることで、単一フィールドと複数フィールドの検証を柔軟に実装できる。
まとめ
  • おすすめ本
¥2,970 (2023/07/25 22:48時点 | Amazon調べ)
\楽天ポイント4倍セール!/
楽天市場

Pythonの勉強なら「」が体系的に学べるのでおすすめですよ♪

いずみ

最後までお読みいただき、ありがとうございました!

スクロールできます
【当サイト】おすすめフリーランスエージェント3選
エージェント評価ポイント公式サイト
レバテックフリーランス

5.0
業界最大級のエージェント。
高単価案件が豊富。
公式
Midworks

4.8
満足度調査で
3年連続3冠を達成。
公式
ITプロパートナーズ

4.6
週2〜3向けの案件が豊富。公式
  • クソおすすめ本
¥4,480 (2024/06/01 23:28時点 | Amazon調べ)
\楽天ポイント4倍セール!/
楽天市場
いずみ

海外のエンジニアがどういった思考で働いているかが理解できます。

海外に行く気はないけど海外エンジニアの動向が気になる雑魚エンジニアにおすすめです(本当におすすめな本しか紹介しないのでご安心を)。

この記事が気に入ったら
フォローしてね!

シェアしてね!
  • URLをコピーしました!
目次