https://github.com/InSyncWithFoo/pyright-langserver-for-pycharm
Pyright language server integration for PyCharm Professional
https://github.com/InSyncWithFoo/pyright-langserver-for-pycharm
intellij-plugin pycharm-plugin pyright python
Last synced: about 1 year ago
JSON representation
Pyright language server integration for PyCharm Professional
- Host: GitHub
- URL: https://github.com/InSyncWithFoo/pyright-langserver-for-pycharm
- Owner: InSyncWithFoo
- License: mit
- Archived: true
- Created: 2024-02-20T07:35:12.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-22T04:27:32.000Z (over 1 year ago)
- Last Synced: 2025-03-19T22:58:24.527Z (about 1 year ago)
- Topics: intellij-plugin, pycharm-plugin, pyright, python
- Language: Kotlin
- Homepage: https://insyncwithfoo.github.io/pyright-langserver-for-pycharm/
- Size: 17.5 MB
- Stars: 52
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Pyright Language Server for PyCharm Professional
[][5]
[][6]
[][7]
[][8]
[][9]
> [!NOTE]
> This plugin is deprecated. Install [the Pyright plugin][3] instead.
> See [the migration guide][0] for more information.
[0]: https://insyncwithfoo.github.io/pyright-for-pycharm/migration-guide/
---
Pyright language server integration for PyCharm Professional.
This plugin acts as a bridge between [the Pyright language server][1]
and [the experimental LSP API][2] added in PyCharm Professional 2023.2
to give you diagnostics about your code as you edit your Python files.
Note: If you use PyCharm Community,
install [the Pyright plugin][3] instead.
## Usage
Go to Settings | Tools |
Pyright LS | Global / Project and
set the path to your Pyright language server executable.
It is typically named `pyright-langserver`/`pyright-python-langserver`.
(Not sure what this means? See [the docs][4] for more information.)
You might need to reopen your files or restart the IDE
for the files to be recognized by the language server.
## Logging
You are strongly encouraged to enable logging.
This will allow corresponding logs to be recorded in `idea.log`
for further analysis should a problem arises.
Add the following line to the Help | Diagnostic Tools |
Debug Log Settings panel:
```text
#com.intellij.platform.lsp
```
[1]: https://github.com/microsoft/pyright
[2]: https://plugins.jetbrains.com/docs/intellij/language-server-protocol.html
[3]: https://github.com/InSyncWithFoo/pyright-for-pycharm
[4]: https://insyncwithfoo.github.io/pyright-langserver-for-pycharm/configurations/#executable
## Installation
This plugin [is available][8] on the Marketplace.
You can also download the ZIP files manually from [the Releases tab][10],
[the `build` branch][11] or [the Actions tab][12]
and follow the instructions described [here][13].
Currently supported versions:
2024.1 (build 241.14494.241) and later.
## Credits
Most of the code is derived from [@koxudaxi/ruff-pycharm-plugin][14].
It is such a fortune that that plugin does almost the same thing
and is also written in Kotlin, and hence easily understandable.
The SVG and PNG logos are derived from [the README image][15]
of the [@microsoft/pyright][1] repository,
generated using Inkscape's autotrace feature.
Some other files are based on or copied directly from
[@JetBrains/intellij-platform-plugin-template][16].
[5]: https://github.com/InSyncWithFoo/pyright-langserver-for-pycharm/actions/workflows/build.yaml
[6]: https://github.com/InSyncWithFoo/pyright-langserver-for-pycharm/actions/workflows/docs.yaml
[7]: https://plugins.jetbrains.com/plugin/24146/versions
[8]: https://plugins.jetbrains.com/plugin/24146/reviews
[9]: https://plugins.jetbrains.com/plugin/24146
[10]: https://github.com/InSyncWithFoo/pyright-langserver-for-pycharm/releases
[11]: https://github.com/InSyncWithFoo/pyright-langserver-for-pycharm/tree/build
[12]: https://github.com/InSyncWithFoo/pyright-langserver-for-pycharm/actions/workflows/build.yaml
[13]: https://www.jetbrains.com/help/pycharm/managing-plugins.html#install_plugin_from_disk
[14]: https://github.com/koxudaxi/ruff-pycharm-plugin
[15]: https://github.com/microsoft/pyright/blob/main/docs/img/PyrightLarge.png
[16]: https://github.com/JetBrains/intellij-platform-plugin-template