py_lsp.nvim
What is py_lsp?
py_lsp.nvim
is a neovim plugin that helps with using the lsp feature for python development.
It tackles the problem about the activation and usage of python virtual environments for the nvim lsp.
Installation
Using vim-plug:
Plug 'HallerPatrick/py_lsp.nvim'
Using packer.nvim:
use {'HallerPatrick/py_lsp.nvim'}
Usage
Instead of initializing the server on your own, like in nvim-lspconfig, py_lsp
is doing that for you.
Put this in your init.lua
(or wrap in lua call for your init.vim
)
require'py_lsp'.setup {
-- This is optional, but allows to create virtual envs from nvim
host_python = "/path/to/python/bin"
}
This minimal setup will automatically pass a python virtual environment path to the LSP client for completion/linting.
Features
py_lsp
exposes several commands that help with a virtual env workflow.
Command | Parameter | Usage |
---|---|---|
:PyLspCurrentVenv |
No | Prints the currently used python venv |
:PyLspDeactiveVenv |
No | Shuts down the current LSP client |
:PyLspReload |
No | Reload LSP client with current python venv |
:PyLspActivateVenv |
venv name | Activates a virtual env with given name (default: 'venv'). This venv should lie in project root |
:PyLspCreateVenv |
venv name | Creates a virtual env with given name (default: 'venv'). Requires host_python to be set and have virtualenv installed |
:PyRun |
command | Run files and modules from current virtuale env |
Most of these commands can be also run over a popup menu with :PyLspPopup
.
Example Workflow
You open up your python project. Because there is no python virtual env confirgured, the LSP is not starting.
- You run
:PyLspCreateVenv venv
to create a new virtual env fromhost_python
. - You run
:PyLspCurrentVenv
to check if the LSP client is using your new venv. - You run
:PyRun -m pip install -r requirements.txt
to install project dependencies. - You run
:PyLspReload
so that the LSP client also find your new site-packages for autocompletion and correct linting.
You start programming!
Extras
The virtual environment path and name can be retrieved with client.config.settings.python.pythonPath
and client.config.settings.python.venv_name
. This can for example be used in your statuslines.
Example provider for feline:
local function lsp_provider(component)
local clients = {}
local icon = component.icon or ' '
for _, client in pairs(vim.lsp.buf_get_clients()) do
if client.name == "pyright" then
-- Check if lsp was initialized with py_lsp
if client.config.settings.python["pythonPath"] ~= nil then
local venv_name = client.config.settings.python.venv_name
clients[#clients+1] = icon .. client.name .. '('.. venv_name .. ')'
end
else
clients[#clients+1] = icon .. client.name
end
end
return table.concat(clients, ' ')
end
This will give you a VSCode like status:
Configuration
The configurations are not sensible yet, and are suiting my setup. This will change.
Default:
Default Values:
auto_source = true,
language_server = "pyright",
on_attach = nil,
source_strategies = {"default", "poetry", "system"},
capabilities = nil,
host_python = nil
Todo
- Support for different environment systems:
- virtualenvwrapper
- Conda
- Pipenv
Limitations
- All features are currently only available with
pyright
.pylsp
is weird. It will still be started, but all features are run with a 'pyright' server or not at all. py_lsp
expects to find virtualenv in thecwd
, please check for that
Note
This plugin is created due to following Issue.
This plugin currently includes a utility to automatically pass a virtualenv to the pyright lsp server before initialization also take from the Issue. (Thanks lithammer and others).