hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added PyCharm API notes

Browse Source
This commit is contained in:
Matt Ellis 2017-11-06 16:08:44 +00:00
parent 379cb0efe2
commit dc0d26cf44
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
_SUMMARY.md
View File

@ -156,6 +156,7 @@
* [Setting-up the Environment](phpstorm/setting_up_environment.md)
* [PHP Open API](phpstorm/php_open_api.md)
* [Existing Third Party Plugins](phpstorm/existing_plugins.md)
* [PyCharm](products/pycharm.md)
* DataGrip
* Android Studio
* Rider

19
products/pycharm.md Normal file
View File

@ -0,0 +1,19 @@
---
title: PyCharm
---
## Which API should be used by PyCharm plugin developers?
### Platform Open API
The APIs from the standard set of Platform Open API modules can be safely used in plugins. Public symbols defined in these modules have a lifecycle, and will be marked as deprecated for several releases before being removed.
The modules are [defined in the `CommunityRepositoryModules.groovy` file](https://github.com/JetBrains/intellij-community/blob/master/platform/build-scripts/groovy/org/jetbrains/intellij/build/CommunityRepositoryModules.groovy).
### PyCharm Open API
Symbols defined in the **python-psi-api** and **python-openapi** modules are also public API and considered stable.
### Other API
Classes and methods defined in other modules are used at your own risk, and care should be taken to test your plugin with any version of PyCharm you wish to support.