Plugin Pydantic PyCharm
Un plugin JetBrains PyCharm pour pydantic
.
Entretien
J'ai été interviewé à propos de ce plugin pour le blog PyCharm de JetBrains.
Aide
Voir la documentation pour plus de détails.
Commanditaires
Installation rapide
Le plugin est dans le référentiel Jetbrains (Pydantic Plugin Page)
Vous pouvez installer la version stable sur Marketplace
de PyCharm (Préférence -> Plugins -> Marketplace) Documentation officielle
Le plugin nécessite PyCharm 2020.2 ou version ultérieure (inclure d'autres IDE JetBrains)
Démo
Caractéristiques
Mis en œuvre
pydantic.BaseModel
- Inspection de signature
__init__
spécifique au modèle et auto-complétion pour les sous-classes de pydantic.BaseModel
- Vérification du type d'arguments
__init__
spécifique au modèle pour les sous-classes de pydantic.BaseModel
- Prise en charge de Refactor pour renommer les champs des sous-classes de
BaseModel
- (Si le nom du champ est refactorisé à partir de la définition du modèle ou des arguments du mot-clé de l'appel
__init__
, PyCharm présentera une boîte de dialogue offrant le choix de renommer automatiquement le mot-clé là où il apparaît dans un appel d'initialisation du modèle.)
- Rechercher des champs associés par attributs de classe et arguments de mot-clé de
__init__
avec Ctrl+B
et Cmd+B
- Fournissez une inspection pour la vérification de type compatible avec pydantic. l'inspection prend en charge
parsable-type
. le détail se trouve dans la section Inspection pour la vérification de type - Insérez des arguments non remplis avec un QuickFix pour les sous-classes de
pydantic.BaseModel
- Prise en charge de la saisie. Annoté (PEP 593)
- Les arguments Regex dans
Field
et constr
sont traités comme des littéraux de chaîne regex de Python. - Prise en charge de Config/ConfigDict
- Remplissage automatique pour Config/ConfigDict
- Lire la configuration du modèle telle que
frozen=True
depuis Config/ConfigDict
- prise en charge du validateur/field_validator
- respecter le premier argument est
cls
de la méthode - Remplissage automatique des arguments de nom de champ du validateur/field_validator
- Associer le validateur/field_validator au champ
- Prise en charge du refactoring/saut
- Valider le nom du champ sur les arguments du validateur
pydantic.generics.GenericModel
- Prend en charge les mêmes fonctionnalités que
pydantic.BaseModel
- (Ce plugin version 0.3.1 ou ultérieure)
pydantic.dataclasses.dataclass
- Prend en charge les mêmes fonctionnalités que
pydantic.BaseModel
- (Après PyCharm 2020.2 et la version 0.1.0 de ce plugin, PyCharm traite
pydantic.dataclasses.dataclass
comme une classe de données tierce.)
pydantic.create_model [expérimental]
- Prise en charge des fonctionnalités minimales pour un modèle créé par create_model
sqlmodel.SQLModel
- Prend en charge les mêmes fonctionnalités que
pydantic.BaseModel
- (Ce plugin version 0.3.12 ou ultérieure)
Versions majeures de Pydantic prises en charge
Contribuer
Nous attendons vos contributions à pydantic-pycharm-plugin
.
Links
Page du plugin JetBrains
Page du plugin Pydantic
Motivation
Auto-complétion lors de l'instanciation des objets BaseModel #650
Autres projets de plugins PyCharm
Plugin de poésie PyCharm
Ce projet est actuellement en phase expérimentale