LSP-pyright

by sublimelsp ST3

Python support for Sublime's LSP plugin provided through microsoft/pyright.

Labels auto-complete, linting, formatting, code navigation, intellisense

Details

Versions
1.4.47

1.2.42
Homepage github.com
Issues github.com
Modified 1 week ago
Last Seen 4 hours ago
First Seen 5 years ago

Installs

Total 27K
Win 11K
Mac 7K
Linux 9K

	Jun 18	Jun 17	Jun 16	Jun 15	Jun 14	Jun 13	Jun 12	Jun 11	Jun 10	Jun 9	Jun 8	Jun 7	Jun 6	Jun 5	Jun 4	Jun 3	Jun 2	Jun 1	May 31	May 30	May 29	May 28	May 27	May 26	May 25	May 24	May 23	May 22	May 21	May 20	May 19	May 18	May 17	May 16	May 15	May 14	May 13	May 12	May 11	May 10	May 9	May 8	May 7	May 6	May 5	May 4
Windows	13	12	11	12	6	17	12	12	10	16	7	15	15	8	8	14	11	5	9	11	18	12	9	12	10	16	15	16	14	7	22	11	7	11	9	16	13	12	7	9	8	14	11	7	9	12
Mac	8	4	10	7	5	10	4	11	6	10	5	4	5	4	10	7	1	6	3	6	11	16	9	7	5	9	12	10	7	8	4	6	5	8	14	7	9	8	3	2	10	4	7	7	4	6
Linux	6	12	13	3	11	5	10	10	10	8	13	8	9	7	11	2	8	7	6	9	11	16	9	5	7	5	11	9	16	9	0	11	4	14	12	10	4	7	7	5	10	8	9	13	5	10

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 node is not in your $PATH, this package will suggest to install a local Node.js runtime automatically. If you instead decide to use node that 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-json package which provides validation and auto-complete for LSP-pyright settings and the pyrightconfig.json configuration 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 Project and add your settings in:

{
     "settings": {
        "LSP": {
           "LSP-pyright": {
              "settings": {
                 // Put your settings here
              }
           }
        }
     }
  }

Various options can only be configured through a pyrightconfig.json configuration file (check Pyright configuration for more info)

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.