Visual Studio Code 配置 Python 虚拟环境的最佳实践_vscode pyenv

作者：你好赵伟 | 2024-06-24 09:53:17

踩

vscode pyenv

VSCode 最佳实践系列：

0 前言

为什么要写这篇文章？

自从微软推出了 LSP 语言服务协议（Language Server Protocol）后，每种编程语言只需实现一个 Language Server 后端，就可以为任何支持 LSP 协议的 IDE/Editor 提供代码高亮、自动补全、导航重构等功能，而不必为每一个 IDE/Editor 重复开发上述组件。实际上，LSP 和 DAP 的出现正在让 IDE 和编辑器的界限越发模糊。

截止到 2022 年，开源社区已经涌现出一大批优秀的 Language Server 实现，它们在各自领域已经拥有了接近甚至超越商业化 IDE 的功能：

Rust-Analyzer(Rust)
Clangd(C/C++)
Haskell-Language-Server(Haskell)
Gopls(Go)
Pylance(Python)
TexLab(LaTeX)
…

目前支持 LSP 协议的 IDE/Editor：

Zed
Visual Studio Code
Clion(没错，jetbrains 开发的 Clion 也使用 clangd)
Neovim
Sublime Text
Emacs
Fleet
Eclipse
…

与 VSCode 官方文档配置相比拥有的优势

使用 Pyenv 管理 Python版本
使用 venv 构建虚拟环境
配合 VSCode 进行开发

1 安装 Pyenv

Pyenv 是用来管理不同 Python 版本的工具，通过它你可以在操作系统中安装多个不同版本的 Python 并随意切换。

Pyenv 仅支持 Linux 和 Mac OS，Windows 平台可以使用 Pyenv-win 项目，或者直接使用 WSL 2。笔者推荐后者，因为本地的 Pyenv-win 和 WSL 中的 Pyenv 有可能冲突，考虑到 Python 的 Linux 生态优于 Windows，建议尽可能把开发环境搬进 WSL：

Linux & WSL 2

curl https://pyenv.run | bash
1

Mac OS

首先安装 Xcode Command Line Tools（如果你之前没装过）：

xcode-select --install
1

然后安装 Mac OS 的包管理器 Homebrew（参考笔者关于 C++ 的那篇文章），最后安装 Pyenv：

brew update
brew install pyenv
1
2

2 配置 Pyenv 的 Shell 环境

Bash

首先，在终端运行以下命令，将相关内容添加到 ~/.bashrc 文件中：

echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc
echo 'command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(pyenv init -)"' >> ~/.bashrc
1
2
3

然后，如果你有 ~/.profile、~/.bash_profile 或 ~/.bash_login，也将相关内容添加到那里。如果没有这些文件，请添加到 ~/.profile 文件中。

添加到 ~/.profile：

echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.profile
echo 'command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.profile
echo 'eval "$(pyenv init -)"' >> ~/.profile
1
2
3

添加到 ~/.bash_profile：

echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bash_profile
echo '[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bash_profile
echo 'eval "$(pyenv init -)"' >> ~/.bash_profile
1
2
3

Zsh

echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.zshrc
echo '[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zshrc
echo 'eval "$(pyenv init -)"' >> ~/.zshrc
1
2
3

Fish

笔者使用 Fish Shell

对于 Fish 3.2.0 或更新版本，直接在终端执行以下命令：

set -Ux PYENV_ROOT $HOME/.pyenv
fish_add_path $PYENV_ROOT/bin
1
2

否则执行：

set -Ux PYENV_ROOT $HOME/.pyenv
set -U fish_user_paths $PYENV_ROOT/bin $fish_user_paths
1
2

最后将以下命令写进 ~/.config/fish/config.fish 文件中：

pyenv init - | source
1

3 安装 Python 构建依赖

在使用 Pyenv 安装任何 Python 版本之前，必须装好 Python 的构建依赖。

Mac OS

brew install openssl readline sqlite3 xz zlib tcl-tk
1

Ubuntu/Debian/Mint

sudo apt update; sudo apt install build-essential libssl-dev zlib1g-dev \
libbz2-dev libreadline-dev libsqlite3-dev curl \
libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev
1
2
3

如果你要从源代码构建 PyPy 或安装其他需要 Clang 的 Python 版本，还需要安装 llvm。

其它发行版请参考官方文档：