pydanticの `BaseModel` とは？

Pythonでデータを扱うとき、特にWebアプリケーションやAPI開発の現場では、入力データの型や形式が正しいかを簡単にチェックしたい場面が多くあります。そこでよく使われるのがpydanticというライブラリであり、その中心となるクラスが BaseModel です。

`BaseModel` とは何か？

BaseModel は、pydanticが提供するデータモデルの基本クラスであり、主に以下の役割を持っています。

つまり、BaseModel を継承するだけで、定義したデータ型に対して自動的に型の検証やデータ変換を行ってくれる非常に便利なクラスです。

例えば、ユーザーの情報を扱うデータモデルを定義したい場合、次のように書けます。

from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str
    email: str

このように書くことで、次のようなことが簡単にできます。

以下のようにモデルを使ってデータを渡すと、自動的に型チェックを行います。

# 正しいデータの場合
user = User(id=1, name="Keita", email="keita@example.com")
print(user)

もし、型が異なるデータを渡してしまった場合はエラーになります。

# 誤った型を渡した場合
user = User(id="one", name="Keita", email="keita@example.com")
# => エラーが発生: idは整数型(int)でなければいけない

データを簡単にJSON形式に変換したり、逆にJSONデータをモデルに変換できます。

# JSONへの変換
user_json = user.json()
print(user_json)

# JSONからモデルへの変換
user_from_json = User.parse_raw(user_json)
print(user_from_json)

主に以下のような場面でよく使われます。

これらの用途で、シンプルかつ安全にデータを扱う仕組みを作るのに役立っています。

BaseModel は非常に便利な仕組みですが、Pythonには似たような目的で使える構文やライブラリがいくつかあります。以下は、混同しやすい代表的な例です。

概念	バリデーション	自動型変換	JSON変換	実行時型チェック	備考
`BaseModel`	✅	✅	✅	✅	APIやフォーム処理向け
`@dataclass`	❌（自作必要）	❌	❌（手動）	❌	軽量な構造体向け
`NamedTuple`	❌	❌	❌	❌	イミュータブル
`TypedDict`	❌	❌	❌	❌（静的型のみ）	型ヒント用
`attrs`	✅（定義可）	❌	❌	❌（オプション）	柔軟なデータクラス

BaseModel は、pydanticライブラリでデータを扱うための基本的なクラスであり、データの検証や型チェックを容易にします。Pythonで安全かつ簡単にデータ管理したい場合にぜひ活用してみましょう。

また、似たような機能を持つ構文やライブラリ（@dataclass, NamedTuple, TypedDict, attrsなど）との違いを理解して、適材適所で使い分けることが重要です。