LSP-pyright
Python support for Sublime's LSP plugin provided through microsoft/pyright.
Details
Installs
- Total 8K
- Win 3K
- Mac 2K
- Linux 3K
| Oct 5 | Oct 4 | Oct 3 | Oct 2 | Oct 1 | Sep 30 | Sep 29 | Sep 28 | Sep 27 | Sep 26 | Sep 25 | Sep 24 | Sep 23 | Sep 22 | Sep 21 | Sep 20 | Sep 19 | Sep 18 | Sep 17 | Sep 16 | Sep 15 | Sep 14 | Sep 13 | Sep 12 | Sep 11 | Sep 10 | Sep 9 | Sep 8 | Sep 7 | Sep 6 | Sep 5 | Sep 4 | Sep 3 | Sep 2 | Sep 1 | Aug 31 | Aug 30 | Aug 29 | Aug 28 | Aug 27 | Aug 26 | Aug 25 | Aug 24 | Aug 23 | Aug 22 | Aug 21 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 3 | 8 | 8 | 7 | 7 | 12 | 9 | 6 | 9 | 4 | 8 | 2 | 2 | 3 | 8 | 7 | 4 | 8 | 10 | 3 | 10 | 3 | 3 | 3 | 5 | 2 | 4 | 7 | 10 | 5 | 9 | 4 | 5 | 5 | 6 | 11 | 3 | 7 | 3 | 2 | 6 | 6 | 6 | 3 | 4 | 1 |
| Mac | 2 | 7 | 9 | 2 | 6 | 13 | 6 | 3 | 2 | 9 | 2 | 3 | 1 | 7 | 7 | 7 | 6 | 3 | 5 | 6 | 2 | 7 | 7 | 2 | 8 | 3 | 12 | 10 | 8 | 13 | 4 | 3 | 5 | 8 | 3 | 7 | 3 | 8 | 4 | 1 | 3 | 3 | 6 | 4 | 5 | 1 |
| Linux | 1 | 1 | 4 | 5 | 9 | 6 | 9 | 4 | 5 | 4 | 6 | 8 | 6 | 10 | 6 | 7 | 4 | 5 | 2 | 3 | 6 | 8 | 13 | 9 | 5 | 8 | 6 | 6 | 7 | 7 | 10 | 8 | 3 | 10 | 4 | 9 | 4 | 10 | 4 | 7 | 3 | 4 | 2 | 4 | 6 | 7 |
Readme
- Source
- raw.githubusercontent.com
LSP-pyright
Python support for Sublime's LSP plugin provided through microsoft/pyright.
Installation
- Install LSP and LSP-pyright via Package Control.
- (Optional but recommended) Install the LSP-file-watcher-chokidar via Package Control to enable functionality to notify the server about new files.
- Restart Sublime.
- (Optional) Configure pyright for your
virtualenv.
The Node.js is required by this server. If
nodeis not in your$PATH, this package will suggest to install a local Node.js runtime automatically. If you instead decide to usenodethat is already installed on your system, make sure that it's at least a version 14.
Configuration
TIP: It's recommended to additionally install the
LSP-jsonpackage which provides validation and auto-complete forLSP-pyrightsettings and thepyrightconfig.jsonconfiguration file.
Here are some ways to configure the package and the language server.
- From
Preferences > Package Settings > LSP > Servers > LSP-pyright - From the command palette
Preferences: LSP-pyright Settings - Project-specific configuration
From the command palette run
Project: Edit Projectand add your settings in:
{
"settings": {
"LSP": {
"LSP-pyright": {
"settings": {
// Put your settings here
}
}
}
}
}
- Through a
pyrightconfig.jsonconfiguration file (check settings documentation)
Provided Command Palette commands
| Command | Description |
|---|---|
LSP-pyright: Create Pyright Configuration File |
Creates a pyrightconfig.json file in the root of the project with basic options. Opens the configuration file if it already exists. |
Virtual environments
The plugin attempts to resolve the virtual environment automatically from well-known environment variables and workspace files.
This behavior can be disabled by explicitly setting the python interpreter in the python.pythonPath setting.
If you want to overwrite the virtual environment, the pyrightconfig.json file must be present at the root of your project.
This configuration file, at a minimum, should define where your Python virtualenvs are located, as well as the name of the one to use for your project:
{
"venvPath": "/path/to/virtualenvs/",
"venv": "myenv"
}
For example, if you have created a virtual environment inside the directory .venv within the project directory then you would use:
{
"venvPath": ".",
"venv": ".venv"
}
Note that the venv option is only supported in the pyrightconfig.json file. The venvPath option can also be specified in your .sublime-project, in case you don't want to hard-code a system-specific path in a shared project.
Please see Pyright Documentation for more options.