pydantic pycharm plugin

Pydantic PyCharm プラグイン

pydantic用の JetBrains PyCharm プラグイン。

インタビュー

JetBrains の PyCharm ブログでこのプラグインについてインタビューを受けました。

ヘルプ

詳細については、ドキュメントを参照してください。

スポンサー

クイックインストール

プラグインは Jetbrains リポジトリ (Pydantic プラグイン ページ) にあります。

安定バージョンは PyCharm のMarketplace (設定 -> プラグイン -> マーケットプレイス) でインストールできます。 公式ドキュメント

プラグインには PyCharm 2020.2 以降が必要です (他の JetBrains IDE を含む)

デモ

特徴

実装済み

pydantic.BaseModel

• モデル固有の__init__ - pydantic.BaseModelのサブクラスの署名検査とオートコンプリート
• モデル固有の__init__ - pydantic.BaseModelのサブクラスの引数の型チェック
• BaseModelのサブクラスのフィールド名変更​​のリファクタリング サポート
  • (フィールド名がモデル定義または__init__呼び出しのキーワード引数からリファクタリングされている場合、PyCharm は、モデルの初期化呼び出しで出現するキーワードの名前を自動的に変更する選択肢を提供するダイアログを表示します。)
• Ctrl+BおよびCmd+Bを使用して、クラス属性と__init__のキーワード引数によって関連フィールドを検索します
• pydantic と互換性のある型チェックのためのインスペクションを提供します。インスペクションはparsable-typeをサポートします。詳細は「型チェックのための検査」セクションを参照してください。
• pydantic.BaseModelのサブクラスの QuickFix を使用して未入力の引数を挿入する
• タイピングのサポート。注釈付き (PEP 593)
• Fieldおよびconstrの正規表現引数は、Python の正規表現文字列リテラルとして扱われます。
• Config/ConfigDict のサポート
  • Config/ConfigDict のオートコンプリート
  • Config/ConfigDict から、 frozen=Trueなどのモデル構成を読み取ります
• validator/field_validator のサポート
  • 最初の引数がメソッドのclsであることを考慮します
  • validator/field_validator のフィールド名引数のオートコンプリート
  • validator/field_validator をフィールドに関連付ける
    • リファクタリング/ジャンプをサポート
    • バリデータ引数でフィールド名を検証する

pydantic.generics.GenericModel

• pydantic.BaseModelと同じ機能をサポート
  • (本プラグインバージョン0.3.1以降)

pydantic.dataclasses.dataclass

• pydantic.BaseModelと同じ機能をサポート
  • (PyCharm 2020.2 およびこのプラグイン バージョン 0.1.0 以降、PyCharm はpydantic.dataclasses.dataclassサードパーティ データクラスとして扱います。)

pydantic.create_model [実験的]

• create_model で作成されたモデルの最小限の機能をサポートします

sqlmodel.SQLModel

• pydantic.BaseModelと同じ機能をサポート
  • (本プラグインバージョン0.3.12以降)

サポートされている Pydantic メジャー バージョン

• v0
• v1
• v2

貢献する

pydantic-pycharm-pluginへの貢献をお待ちしています。

リンク

JetBrains プラグイン ページ

Pydantic プラグイン ページ

モチベーション

BaseModel オブジェクトをインスタンス化するときのオートコンプリート #650

その他の PyCharm プラグイン プロジェクト

詩 PyCharm プラグイン

このプロジェクトは現在実験段階にあります