Skip to content
Autocomplete for pydantic
Kotlin Python
Branch: master
Clone or download
Latest commit a4df49d Oct 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs add image Jul 15, 2019
gradle/wrapper add gradle-wrapper.jar Aug 9, 2019
resources/META-INF update history Oct 13, 2019
src/com/koxudaxi/pydantic fix inspection on namedtuple (#81) Oct 13, 2019
testData ignore protected fields (#79) Oct 10, 2019
testSrc/com/koxudaxi/pydantic ignore protected fields (#79) Oct 10, 2019
.gitignore add build script Aug 9, 2019
.travis.yml add unittest Aug 21, 2019
LICENSE
README.md Update README.md Sep 19, 2019
build.gradle update kotlin version to 1.3.50 Aug 26, 2019
gradle.properties disable vm options Aug 9, 2019
gradlew add build script Aug 9, 2019
gradlew.bat add build script Aug 9, 2019
pydantic-pycharm-plugin.iml ignore protected fields (#79) Oct 10, 2019
settings.gradle add build script Aug 9, 2019

README.md

pydantic-pycharm-plugin

Build Status codecov

A JetBrains PyCharm plugin for pydantic.

(See Auto-completion when instantiating BaseModel objects #650 for motivation.)

Example:

type check1

Features

Implemented

pydantic.BaseModel

  • Model-specific __init__-signature inspection and autocompletion for subclasses of pydantic.BaseModel
  • Model-specific __init__-arguments type-checking for subclasses of pydantic.BaseModel
  • Refactor support for renaming fields for subclasses of BaseModel
    • (If the field name is refactored from the model definition or __init__ call keyword arguments, PyCharm will present a dialog offering the choice to automatically rename the keyword where it occurs in a model initialization call.
  • Search related-fields by class attributes and keyword arguments of __init__ with Ctrl+B and Cmd+B

pydantic.dataclasses.dataclass

  • Support same features as pydantic.BaseModel

How to install:

MarketPlace

The plugin is in Jetbrains repositry (Pydantic Plugin Page)

You can install the stable version on PyCharm's marketpale (Preference -> Plugins -> Marketplace) Offical Document

Complied binary

The releases section of this repository contains a compiled version of the plugin: pydantic-pycharm-plugin.zip(latest)

After downloading this file, you can install the plugin from disk by following the JetBrains instructions here.

Source

Alternatively, you can clone this repository and follow the instructions under the "Building the plugin" heading below to build from source. The build process will create the file build/distributions/pydantic-pycharm-plugin.zip. This file can be installed as a PyCharm plugin from disk following the same instructions.

Development

Building the plugin

You can build and run the plugin either via the command line or through IntelliJ IDEA:

Shell on Linux or MacOS

$ ./gradlew buildPlugin

Command Prompt on Windows

$ gradlew.bat buildPlugin

JetBrains IDE on any platform

Official documentation

Running the IDE with the built plugin

$ ./gradlew runIde

Links

JetBrains Plugin Page

Pydantic Plugin Page

This project is currently in an experimental phase

You can’t perform that action at this time.