{"id":15134554,"url":"https://github.com/koxudaxi/pydantic-pycharm-plugin","last_synced_at":"2025-04-08T08:14:44.484Z","repository":{"id":37887946,"uuid":"197027423","full_name":"koxudaxi/pydantic-pycharm-plugin","owner":"koxudaxi","description":"PyCharm plugin for pydantic.  This plugin provides autocompletion, inspection, type-checking, inserting unfilled argument, and more.","archived":false,"fork":false,"pushed_at":"2024-10-28T16:19:43.000Z","size":7664,"stargazers_count":455,"open_issues_count":70,"forks_count":16,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-29T17:35:34.665Z","etag":null,"topics":["autocomplete","fastapi","inspection","intellij","intellij-plugin","jetbrains","kotlin","pycharm","pycharm-plugin","pydantic"],"latest_commit_sha":null,"homepage":"https://koxudaxi.github.io/pydantic-pycharm-plugin/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/koxudaxi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["koxudaxi"]}},"created_at":"2019-07-15T15:41:01.000Z","updated_at":"2024-10-25T17:54:07.000Z","dependencies_parsed_at":"2023-10-14T18:11:04.634Z","dependency_job_id":"ff49d4f0-1618-4f8c-9ea1-286748950bcb","html_url":"https://github.com/koxudaxi/pydantic-pycharm-plugin","commit_stats":{"total_commits":753,"total_committers":10,"mean_commits":75.3,"dds":"0.36387782204515273","last_synced_commit":"ff0d6515f543854736ffb23a77b21c6ddf06db93"},"previous_names":[],"tags_count":85,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2Fpydantic-pycharm-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2Fpydantic-pycharm-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2Fpydantic-pycharm-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2Fpydantic-pycharm-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koxudaxi","download_url":"https://codeload.github.com/koxudaxi/pydantic-pycharm-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247801169,"owners_count":20998339,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autocomplete","fastapi","inspection","intellij","intellij-plugin","jetbrains","kotlin","pycharm","pycharm-plugin","pydantic"],"created_at":"2024-09-26T05:22:52.031Z","updated_at":"2025-04-08T08:14:44.442Z","avatar_url":"https://github.com/koxudaxi.png","language":"Kotlin","funding_links":["https://github.com/sponsors/koxudaxi"],"categories":["Utilities"],"sub_categories":[],"readme":"# Pydantic PyCharm Plugin\n[![Build](https://github.com/koxudaxi/pydantic-pycharm-plugin/actions/workflows/build.yml/badge.svg)](https://github.com/koxudaxi/pydantic-pycharm-plugin/actions/workflows/build.yml)\n[![](https://img.shields.io/jetbrains/plugin/v/12861)](https://plugins.jetbrains.com/plugin/12861-pydantic)\n![JetBrains IntelliJ plugins](https://img.shields.io/jetbrains/plugin/d/12861-pydantic)\n![JetBrains IntelliJ Plugins](https://img.shields.io/jetbrains/plugin/r/rating/12861-pydantic)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n[A JetBrains PyCharm plugin](https://plugins.jetbrains.com/plugin/12861-pydantic) for [`pydantic`](https://github.com/samuelcolvin/pydantic).\n\n## Interview\nI got interviewed about this plugin for [JetBrains' PyCharm Blog](https://blog.jetbrains.com/pycharm/2020/04/interview-koudai-aono-author-of-pydantic-plugin-for-pycharm/).\n\n## Help\nSee [documentation](https://koxudaxi.github.io/pydantic-pycharm-plugin/) for more details.\n\n## Sponsors\n[![JetBrains](https://avatars.githubusercontent.com/u/60931315?s=200\u0026v=4)](https://github.com/JetBrainsOfficial)\n\n\n## Quick Installation\n\nThe plugin is in Jetbrains repository ([Pydantic Plugin Page](https://plugins.jetbrains.com/plugin/12861-pydantic))\n\nYou can install the stable version on PyCharm's `Marketplace` (Preference -\u003e Plugins -\u003e Marketplace) [Official Documentation](https://www.jetbrains.com/help/idea/managing-plugins.html)\n\n**The plugin requires PyCharm 2020.2 or later (include other JetBrains IDEs)**\n\n![search plugin](https://raw.githubusercontent.com/koxudaxi/pydantic-pycharm-plugin/main/docs/search_plugin.png)\n\n## Demo\n![demo1](https://raw.githubusercontent.com/koxudaxi/pydantic-pycharm-plugin/main/docs/demo1.gif)\n\n\u003c!-- Plugin description --\u003e\n##  Features\n### Implemented\n#### pydantic.BaseModel\n* Model-specific `__init__`-signature inspection and autocompletion for subclasses of `pydantic.BaseModel`\n* Model-specific `__init__`-arguments type-checking for subclasses of `pydantic.BaseModel` \n* Refactor support for renaming fields for subclasses of `BaseModel`\n  * (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.)\n* Search related-fields by class attributes and keyword arguments of `__init__` with `Ctrl+B` and `Cmd+B`\n* Provide an inspection for type-checking which is compatible with pydantic. the inspection supports `parsable-type`. the detail is at [Inspection for type-checking section](https://koxudaxi.github.io/pydantic-pycharm-plugin/type-checking/)\n* Insert unfilled arguments with a QuickFix for subclasses of `pydantic.BaseModel`\n* Support typing.Annotated (PEP 593)\n* Regex arguments in `Field` and `constr` are treated as Python's regex string literals\n* Config/ConfigDict support\n  * Auto-completion for Config/ConfigDict\n  * Read Model config such `frozen=True` from Config/ConfigDict\n* validator/field_validator support\n  * respect first argument is `cls` of the method\n  * Auto-completion for field name arguments of validator/field_validator\n  * Associate validator/field_validator with field\n    * Support refactoring/jumping\n    * Validate field name on validator arguments \n\n#### pydantic.generics.GenericModel\n* Support same features as `pydantic.BaseModel`\n  * (This plugin version 0.3.1 or later)\n  \n#### pydantic.dataclasses.dataclass\n* Support same features as `pydantic.BaseModel`\n  * (After PyCharm 2020.2 and this plugin version 0.1.0, PyCharm treats `pydantic.dataclasses.dataclass` as third-party dataclass.)\n\n#### pydantic.create_model [experimental]\n* Support minimum features for a model which is created by create_model\n\u003c!-- Plugin description end --\u003e\n\n#### [sqlmodel.SQLModel](https://github.com/tiangolo/sqlmodel)\n* Support same features as `pydantic.BaseModel`\n  * (This plugin version 0.3.12 or later)\n\n### Supported Pydantic major versions\n- v0\n- v1\n- v2\n\n## Contribute\nWe are waiting for your contributions to `pydantic-pycharm-plugin`.\n\n\n## Links\n### JetBrains Plugin Page\n[Pydantic Plugin Page](https://plugins.jetbrains.com/plugin/12861-pydantic)\n\n### Motivation\n[Auto-completion when instantiating BaseModel objects #650](https://github.com/samuelcolvin/pydantic/issues/650)\n\n### Other PyCharm plugin projects\n[Poetry PyCharm Plugin](https://github.com/koxudaxi/poetry-pycharm-plugin/)\n\n## This project is currently in an experimental phase\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoxudaxi%2Fpydantic-pycharm-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoxudaxi%2Fpydantic-pycharm-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoxudaxi%2Fpydantic-pycharm-plugin/lists"}