【OSS情報】Pythonデータ検証ツール「 Pydantic 」

Pydanticの「概要」

「 Pydantic 」(パイダンティック)とは、
Pythonタイプアノテーションを使用する「データ検証ツール」です。

実行時にタイプヒントを強制し、データが無効な場合はユーザーフレンドリーなエラーを提供します。

同様ツール

同様な機能を提供するツールとして、次のようなものがあります。

・Pythonデータ型変換ライブラリ「marshmallow」
・Pythonデータ検証ライブラリ「Cerberus」
・Pythonデータ検証ライブラリ「Voluptuous」

Pydanticの「特徴」

Pythonのタイプヒントを使用

・Python型ヒントの使用方法を知っていれば利用可能
・新しい「スキーマ定義」「マイクロ言語」を学習する必要が無い
・既存ツールとの親和性が高い

データ構造

・「型注釈を使用して定義したクラス」の単なるインスタンス

複雑な構造検証が可能

・「複雑なデータスキーマ」を明確かつ容易に「定義」「検証」「解析」できる
・「再帰的Pydanticモデル」「typing標準型」「バリデーター」などを使用

データクラス作成「dataclassデコレータ」

・Pythonデータクラスを作成するデコレータを提供
・入力データの解析＋検証を実施

デュアルユース「BaseSettingsクラス」

・「リクエストデータ検証コンテキスト」＋「システム設定ロードコンテキスト」の両方で利用可能
・システム設定は環境変数からの読み込みが可能

Pydanticモデル生成ライブラリ「datamodel-code-generator」

・タイプセーフなモデル階層をオンデマンドで生成

■以下のデータソースをサポート
・OpenAPI 3 (YAML/JSON)
・JSON スキーマ
・JSON/YAML データ

→docs.pydantic.dev　→datamodel_code_generator

機能拡張

・カスタムデータ型を定義
・デコレータで装飾されたモデルのメソッドを使用して検証を拡張

高速動作

・常にパフォーマンスを重視
・同様ライブラリ以上の速さで動作

Pydanticの「プラグイン連携」

Pythonコード型チェックライブラリ「mypy」

→docs.pydantic.dev　→mypy_plugin

Python用統合開発環境「PyCharm」

→docs.pydantic.dev　→pycharm_plugin

統合コードエディタ「Visual Studio Code」

→docs.pydantic.dev　→visual_studio_code

Python単体テストライブラリ「Hypothesis」

→docs.pydantic.dev　→hypothesis_plugin

Pydanticの「オフィシャルサイト情報」

オフィシャルサイト

→docs.pydantic.dev

GitHubページ

→github.com　→pydantic/pydantic

主要開発元

Pydanticは「Pydantic開発コミュニティ」が中心となり開発が進められています。

→docs.pydantic.dev　→contributing

ライセンス情報

Pydanticのライセンスは「MIT License」です。

詳細について、こちらを参照ください。

→github.com　→pydantic/pydantic　→LICENSE

動作環境

Python動作環境が必要です。

インストール

docs.pydantic.dev　→install

導入事例

Pydanticは、何百もの「組織」や「パッケージ」で採用されています。

→docs.pydantic.dev　[→#using-pydantic]