pydantic pycharm plugin

Плагин Pydantic PyCharm

Плагин JetBrains PyCharm для pydantic .

Интервью

Я дал интервью об этом плагине для блога PyCharm компании JetBrains.

Помощь

Более подробную информацию смотрите в документации.

Спонсоры

Быстрая установка

Плагин находится в репозитории Jetbrains (страница плагина Pydantic).

Вы можете установить стабильную версию на Marketplace PyCharm (Предпочтения -> Плагины -> Торговая площадка). Официальная документация.

Для плагина требуется PyCharm 2020.2 или новее (включая другие IDE JetBrains).

Демо

Функции

Реализовано

pydantic.BaseModel

• __init__ - проверка сигнатуры и автодополнение для подклассов pydantic.BaseModel для конкретной модели.
• __init__ - проверка типа аргументов для подклассов pydantic.BaseModel специфичная для модели
• Поддержка рефакторинга для переименования полей для подклассов BaseModel
  • (Если имя поля реорганизовано из определения модели или аргументов ключевого слова вызова __init__ , PyCharm отобразит диалоговое окно, предлагающее автоматически переименовать ключевое слово там, где оно встречается при вызове инициализации модели.)
• Поиск связанных полей по атрибутам класса и аргументам ключевого слова __init__ с помощью Ctrl+B и Cmd+B
• Проведите проверку типов, совместимую с pydantic. проверка поддерживает parsable-type . Подробности находятся в разделе «Проверка типа»
• Вставьте незаполненные аргументы с помощью QuickFix для подклассов pydantic.BaseModel
• Поддержка набора текста. С аннотациями (PEP 593).
• Аргументы регулярных выражений в Field и constr рассматриваются как строковые литералы регулярных выражений Python.
• Поддержка конфигурации/ConfigDict
  • Автозаполнение для Config/ConfigDict
  • Прочитайте конфигурацию модели, такую frozen=True из Config/ConfigDict.
• поддержка валидатора/field_validator
  • уважайте первый аргумент - это cls метода
  • Автозаполнение аргументов имени поля валидатора/field_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

Плагин Poetry PyCharm

В настоящее время этот проект находится на экспериментальной стадии.