pydantic pycharm plugin

Plug-in Pydantic PyCharm

Um plugin JetBrains PyCharm para pydantic .

Entrevista

Fui entrevistado sobre este plugin para o PyCharm Blog da JetBrains.

Ajuda

Consulte a documentação para obter mais detalhes.

Patrocinadores

Instalação rápida

O plugin está no repositório Jetbrains (Pydantic Plugin Page)

Você pode instalar a versão estável no Marketplace do PyCharm (Preferência -> Plugins -> Marketplace) Documentação Oficial

O plugin requer PyCharm 2020.2 ou posterior (inclui outros IDEs JetBrains)

Demonstração

Características

Implementado

pydantic.BaseModel

• Inspeção de assinatura __init__ específica do modelo e preenchimento automático para subclasses de pydantic.BaseModel
• Verificação de tipo de argumentos __init__ específicos do modelo para subclasses de pydantic.BaseModel
• Refatorar suporte para renomear campos para subclasses de BaseModel
  • (Se o nome do campo for refatorado a partir da definição do modelo ou dos argumentos da palavra-chave de chamada __init__ , o PyCharm apresentará uma caixa de diálogo oferecendo a opção de renomear automaticamente a palavra-chave onde ela ocorrer em uma chamada de inicialização do modelo.)
• Pesquise campos relacionados por atributos de classe e argumentos de palavra-chave de __init__ com Ctrl+B e Cmd+B
• Fornece uma inspeção para verificação de tipo que seja compatível com o pydantic. a inspeção suporta parsable-type . o detalhe está na seção Inspeção para verificação de tipo
• Insira argumentos não preenchidos com um QuickFix para subclasses de pydantic.BaseModel
• Suporte para digitação. Anotado (PEP 593)
• Argumentos Regex em Field e constr são tratados como literais de string regex do Python
• Suporte Config/ConfigDict
  • Preenchimento automático para Config/ConfigDict
  • Leia a configuração do modelo como frozen=True em Config/ConfigDict
• suporte validador/field_validator
  • respeito, o primeiro argumento é cls do método
  • Preenchimento automático para argumentos de nome de campo do validador/field_validator
  • Associar validador/field_validator ao campo
    • Suporta refatoração/salto
    • Validar o nome do campo nos argumentos do validador

pydantic.generics.GenericModel

• Suporta os mesmos recursos do pydantic.BaseModel
  • (Este plugin versão 0.3.1 ou posterior)

pydantic.dataclasses.dataclass

• Suporta os mesmos recursos do pydantic.BaseModel
  • (Depois do PyCharm 2020.2 e deste plugin versão 0.1.0, o PyCharm trata pydantic.dataclasses.dataclass como classe de dados de terceiros.)

pydantic.create_model [experimental]

• Suporta recursos mínimos para um modelo criado por create_model

sqlmodel.SQLModel

• Suporta os mesmos recursos do pydantic.BaseModel
  • (Este plugin versão 0.3.12 ou posterior)

Versões principais do Pydantic suportadas

• v0
• v1
• v2

Contribuir

Estamos aguardando suas contribuições para pydantic-pycharm-plugin .

Ligações

Página do plug-in JetBrains

Página do plug-in Pydantic

Motivação

Preenchimento automático ao instanciar objetos BaseModel #650

Outros projetos de plugins PyCharm

Plug-in Poesia PyCharm

Este projeto está atualmente em fase experimental