Awesome
lsp-pyright
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->Table of Contents
<!-- markdown-toc end -->lsp-mode client leveraging Pyright language server
Quickstart
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp)))) ; or lsp-deferred
Configuration
lsp-pyright
supports the following configuration. Each configuration is described in detail in
Pyright Settings.
pyright.disableLanguageServices
vialsp-pyright-disable-language-services
pyright.disableOrganizeImports
vialsp-pyright-disable-organize-imports
pyright.disableTaggedHints
vialsp-pyright-disable-tagged-hints
python.analysis.autoImportCompletions
vialsp-pyright-auto-import-completions
python.analysis.diagnosticMode
vialsp-pyright-diagnostic-mode
python.analysis.logLevel
vialsp-pyright-log-level
python.analysis.autoSearchPaths
vialsp-pyright-auto-search-paths
python.analysis.extraPaths
vialsp-pyright-extra-paths
python.pythonPath
vialsp-pyright-locate-python
python.venvPath
vialsp-pyright-venv-path
Projects can be further configured using pyrightconfig.json
file. For further details please see
Pyright Configuration.
Choosing the correct version of Python
lsp-pyright
will try its best to select the correct version of the
python executable to use. It will do so by iteratively executing
different search functions, going from most precise to most
general.
The list and order of the list can be modified by customizing
lsp-pyright-python-search-functions
. By default the order is:
- Look for a parent directory with a virtual-environment named
.venv
orvenv
vialsp-pyright--locate-python-venv
. - Look for a python executable on your PATH via
lsp-pyright--locate-python-python
.