pydanticとは

pydantic とは

pydantic は本来型に寛大な言語である Python に、型ヒントや型指定を扱えるようにするためのライブラリです。

FastAPIにも含まれているので、そちらで知っている方もいるかもしれません。

本記事では、pydantic の基本的な使い方について紹介いたします。

どんなことができる？

• モデルとして、型を用いたクラスを定義できます。
• 与えられた入力値を、モデルで指定した型に変換します。
• 変換できない無効な型はエラーにします。
• バリデーションを用いて、入力値を検証できます。
• Json や Dict など色々な型にモデルをエクスポートできます。

使用するための準備

pydantic を使用するためには、pip でインストールする必要があります。

依存の関係上、Python 3.6 以降推奨となります。

pip install pydantic

また、VSCode を Editor としてしている方は、下記設定をしましょう。

• 拡張機能【Pylance】のインストール
• 設定でPython › Analysis: Type Checking Modeを basic か strict に変更

この設定を行うと、エラーチェックを行なうようになります。

簡単な実装例

下記は、簡単なモデルを使用した型変換と辞書型へのエクスポートの例となります。

from pydantic import BaseModel


class User(BaseModel):  # BaseModelを継承
    id: int             # 型指定：入力時に必須になる要素
    name = "John Doe"   # デフォルト値からstrと型を推測している


external_data = {
    "id": "123",
}
user = User(**external_data)

print(user.id)          # idはint型のため、"123" -> 123に変換されている
print(user.dict())      # 辞書型でエクスポート

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

123
{'id': 123, 'name': 'John Doe'}

参考

• Pydantic

備考

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