Pydantic
Pydantic は、標準的な Python 型アノテーションを利用してデータモデルを定義するデータバリデーションライブラリです。 PyCharm は、Pydantic モデル向けに、他の 型ヒント機能 を提供しているのと同じ型エンジン上に構築された専用のサポートを提供します。
このサポートは、 pydantic.BaseModel とそのサブクラス、 pydantic.dataclasses.dataclass 、ジェネリックモデル、および フィールド 、モデルやフィールドバリデーター、 ConfigDict オプションなどの関連構造をカバーします。 Pydantic v1 と v2 の両方が認識されます。
モデルフィールドのコードインサイト
Pydantic モデルをインスタンス化すると、PyCharm は宣言されたフィールドを __init__ のキーワード引数として扱い、次のコードインサイトを提供します:
宣言された型やデフォルト値を含む、キーワード引数としてのフィールド名の補完。
各フィールドに渡された値が対応するアノテーションと合致しているかの型チェック。
必須フィールドの不足をハイライトし、未入力の引数にプレースホルダーを挿入するクイックフィックスを提供するインスペクション。
__init__呼び出しにおけるキーワード引数からフィールド宣言へのナビゲーションや戻る操作が可能で、サブクラスや基底クラス間も対応します。
リファクタリングとバリデーター
モデルフィールドの名前を変更すると、 __init__ 呼び出し内のすべてのキーワード引数が更新され、その変更がサブクラスや基底クラスにも反映されます。 __init__ 呼び出しでキーワード引数の名前を変更すると、対応するフィールド宣言も同様に更新されます。
@field_validator、 @model_validator 、あるいはレガシーな @validator および @root_validator デコレーターで宣言されたフィールドやモデルバリデーターは、適切に認識されます。最初のパラメーターには正しい型が割り当てられ、デコレートされた関数に対する標準インスペクションも誤検出を避けて調整されます。