Yet another python interpreter selector plugin for neovim. Make LSPs (pyright, pylsp, basedpyright) and dap-python work with specific python.
whichpydemo.mov
- Only
nvim-lspconfigrequired.dap-pythonis optional. - Use
vim.ui.select. Enable dressing.nvim to get powerful UI. - Support Pylsp, Pyright, BasedPyright LSP servers by default. Other LSP server can be supported with simple config.
- Switch between python interpreters without restart LSPs. (Except
WhichPy restoreon Pyright) - Search on common directories, currently support:
- workspace (relative path of
vim.fn.getcwd()) - global (
vim.env.Pathand common posix paths) - global virtual environment
- pyenv
- poetry
- pdm
- conda
- workspace (relative path of
- Using lazy.nvim:
return {
"neolooong/whichpy.nvim",
opts = {},
}whichpy.nvim comes with these defaults:
{
cache_dir = vim.fn.stdpath("cache") .. "/whichpy.nvim",
locator = {
-- you can disable locator like this
-- locator = { enable = false },
workspace = {
search_pattern = ".*env.*", -- `:help lua-patterns`
depth = 2,
},
global = {},
global_virtual_environment = {
dirs = {
-- accept following structure
-- path
-- { path, vim.uv.os_uname().sysname }
"~/envs",
"~/.direnv",
"~/.venvs",
"~/.virtualenvs",
"~/.local/share/virtualenvs",
{ "~/Envs", "Linux" }, -- only search on linux
vim.env.WORKON_HOME,
}
},
pyenv = {},
poetry = {},
pdm = {},
conda = {},
},
lsp = {
-- lsp_name = { path_getter() , path_setter() }
pylsp = {
require("whichpy.lsp").pylsp.python_path_getter,
require("whichpy.lsp").pylsp.python_path_setter,
},
pyright = {
require("whichpy.lsp").pyright.python_path_getter,
require("whichpy.lsp").pyright.python_path_setter,
},
basedpyright = {
require("whichpy.lsp").pyright.python_path_getter,
require("whichpy.lsp").pyright.python_path_setter,
},
},
}This plugin provide these commands:
-
:WhichPy select [path?]If
pathprovided, LSPs and dap-python would be configured. Otherwise, selector prompt (throughvim.ui.select) would show up. -
:WhichPy restoreRestore LSPs and dap-python configuration, and clear the cache.
-
:WhichPy retrieveRetrieve the interpreter path from cache, then configure lsp and dap-python.
-
:WhichPy rescanSearch python interpreter again.
How this plugin activate environment?
This plugin DOES NOT activate environment (source env/bin/activate or conda activate). The purpose of the plugin is to make LSPs and dap-python work with the specified python.
When path selected, this plugin do these things:
- Save the environment variables:
VIRTUAL_ENVandCONDA_PREFIX. - Unset
VIRTUAL_ENVandCONDA_PREFIXthen set theresolve_python()of dap-python. - Iterate lsp clients, save the python path that current used (if any), before update the configuration.
How to activate environment automatically?
-
Activate environment before open neovim.
-
Set the python path when lsp initalize.
-- pyright require("lspconfig").pyright.setup({ on_init = function(client) -- client.settings.python.pythonPath = require("whichpy.lsp").find_python_path(client.config.root_dir) end }) -- pylsp require("lspconfig").pylsp.setup({ on_init = function(client) client.settings = vim.tbl_deep_extend("force", client.settings, { pylsp = { plugins = { jedi = { environment = require("whichpy.lsp").find_python_path(client.config.root_dir) } } } }) end })
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent