/pyright-langserver-for-pycharm

Pyright language server integration for PyCharm Professional

Primary LanguageKotlinMIT LicenseMIT

Pyright Language Server for PyCharm Professional

Build Docs Version Rating Downloads

Pyright language server integration for PyCharm Professional.

This plugin acts as a bridge between the Pyright language server and the experimental LSP API 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 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 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:

#com.intellij.platform.lsp

Installation

This plugin is available on the Marketplace. You can also download the ZIP files manually from the Releases tab, the build branch or the Actions tab and follow the instructions described here.

Currently supported versions: 2024.1 (build 241.14494.241) and later.

Credits

Most of the code is derived from @koxudaxi/ruff-pycharm-plugin. 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 of the @microsoft/pyright repository, generated using Inkscape's autotrace feature.

Some other files are based on or copied directly from @JetBrains/intellij-platform-plugin-template.