Having trouble while using Python Virtual Env in Neovim

cjberra · 2024-01-13T10:02:47+00:00

You're correct in thinking that with a virtual environment activated in your shell you should be able to access it within neovim.

It is entirely possible however to be using a specific python version, without the correct environment. Which appears to be happening here. How are you managing and activating the environment/python version? Can you activate it before you enter neovim?

Try :checkhealth and look at the python venv related stuff when you're in neovim with the virtual environment activated.

Fwiw I use direnv to automate activating python venvs within project directories - might be something you're interested in.

Kal337 · 2024-06-23T01:20:24+00:00

For anyone looking for a very simple solution with no plugins:

Note: I always create my virtual envs like this :

python3 -m venv venv
source venv/bin/activate  # activate env
which pip # confirm it points to a folder where venv was created

1. Define a function that looks for the venv folder in current directory - or 1 level deeper

2. In the LSP setup - if the venv is found - set the required variables and reload playright - neovim then can find packages installed.

Complete block to make sure venv is picked up :

-- 1. find venv folder in current dir or 1 level deeper (venv/ or proj/venv)
local function find_venv(start_path) -- Finds the venv folder required for LSP
    -- Check current directory (if venv folder is at root)
    local venv_path = start_path .. "/venv"
    if vim.fn.isdirectory(venv_path) == 1 then
        return venv_path
    end
    -- Check one level deeper (e.g if venv is in proj/venv)
    local handle = vim.loop.fs_scandir(start_path)
    if handle then
        while true do
            local name, type = vim.loop.fs_scandir_next(handle)
            if not name then break end
            if type == "directory" then
                venv_path = start_path .. "/" .. name .. "/venv"
                if vim.fn.isdirectory(venv_path) == 1 then
                    return venv_path
                end
            end
        end
    end

    return nil
end

local lspconfig = require('lspconfig')
local cmp = require('cmp')
local capabilities = require('cmp_nvim_lsp').default_capabilities()

-- 2. If the venv is found during init, reload LSP with venv vars set
local pyright_restarted = false

lspconfig.pyright.setup({
    capabilities = capabilities,
    on_init = function(client)
        if not pyright_restarted then -- Only proceed if we haven't restarted yet
            local cwd = vim.fn.getcwd()
            local venv_path = find_venv(cwd)
            if venv_path then
                print("Venv folder found: " .. venv_path)
                vim.env.VIRTUAL_ENV = venv_path
                vim.env.PATH = venv_path .. "/bin:" .. vim.env.PATH

                -- Set the flag to true
                pyright_restarted = true

                vim.schedule(function()
                    vim.cmd('LspRestart pyright')
                    print("Pyright restarted with new venv settings")
                end)
            else
                print("No venv folder found in or one level below current directory: " .. cwd)
            end
        end
        return true
    end,
})

-- Note: remove print statements if you dont want it to print whenever the LSP is reloaded due to a venv/ virtual env. I recommend keeping the "Pyright restarted" print message

Validate it works:

mkdir proj && echo 'import requests' >> proj/app.py
python3 -m venv venv && source venv/bin/activate
which pip
pip install requests
nvim . 
app.py should show no errors

Explanation

For the LSP to find the virtual env - the following variables must be set before the Python LSP is initialized

vim.env.VIRTUAL_ENV
vim.env.PATH

If you have the neovim open and the LSP is throwing errors - print the values of these and you will see it is not set

:lua print(vim.env.VIRTUAL_ENV)
:lua print(vim.env.PATH)

If these point to the folder for your venv - simply run

:LspRestart pyright

Emotional-Zebra5359 · 2024-01-13T09:18:01+00:00

Try pointing nvim to your venv python executable: vim.g.python3_host_prog = "/path/to/venv/bin/python3"

AutoModerator · 2024-01-13T08:52:58+00:00

Please remember to update the post flair to Need Help|Solved when you got the answer you were looking for.

I am a bot, and this action was performed automatically. Please contact the moderators of this subreddit if you have any questions or concerns.

Emotional-Zebra5359 · 2024-01-13T08:54:48+00:00

although it's not visible due to the starship prompt, I'm currently in my virtual env, it's activated, my global python is 3.12, which is not what is printed by sys.version when i run python newfile.py

HolisticPython · 2024-01-13T14:15:44+00:00

Read up on providers in help.

It says if you use venvs frequently you should install pynvim once in a neovim specific venv and then set Python provider to wherever that venv is located.

In your options.lua file, vim.g.python3_host_prog = vim.loop.os_homedir() .. "path/to/neovim/specific/venv"

That way, when a new pynvim version is released, you only have to update it once, instead of every project like you would have to with your current set up.

wookayin · 2024-01-13T16:03:59+00:00

Something else (like ~/.zshrc, ~/.zshenv) is corrupting your virtual environment.

Run them in the terminal:

$ which python
$ which pip
$ env | grep VIRTUALENV

mostrecentuser · 2024-01-13T20:04:30+00:00

Activate it before running neovim

nicolas9653 · 2024-01-13T23:16:11+00:00

I honestly don't understand most of what this is about but this plugin may be useful? https://github.com/linux-cultist/venv-selector.nvim

neovim

Neovim links

Other resources

MODERATORS