LSP-basedpyright

by sublimelsp ST4

Python support for Sublime's LSP plugin provided through DetachHead/basedpyright.

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

Details

Version 1.2.46
Homepage github.com
Issues github.com
Modified 1 month ago
Last Seen 1 month ago
First Seen 12 months ago

Installs

Total 909
Win 331
Mac 243
Linux 335

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

Readme

Source: raw.githubusercontent.com

LSP-basedpyright

Python support for Sublime's LSP plugin provided through DetachHead/basedpyright, which basically includes all Pyright features and some exclusive Pylance features such as semantic highlighting and inlay hints.

Installation

Install LSP and LSP-basedpyright 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 basedpyright 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-basedpyright 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-basedpyright
From the command palette Preferences: LSP-basedpyright Settings
Project-specific configuration From the command palette run Project: Edit Project and add your settings in:

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

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

Provided Command Palette commands

Command	Description
`LSP-basedpyright: Create Basedpyright 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.