python多版本管理

python多版本管理

背景

python2.x 已经停止维护，日常开发中一般都使用 python3.x 的版本，然而考虑到部分旧的脚本是用 python2.x 写的，因此同时在机器上维护多份不同的 python 版本是非常常见的现象。那么如何更好地管理和切换不同的 python 版本便成了一个有待解决的问题？

经常被多个版本困扰的我，今天好好查阅了一番，发现 pyenv 是一个不错的选择，现将相关内容记录如下，以供查阅。

备注： 笔者使用的是MacOS，所以后续操作均基于MacOS。

安装pyenv

pyenv 是一个 python 版本管理工具，具备方便、快捷地安装、管理多个 python 版本，并在不同 python 版本间进行切换的能力。

安装pyenv

使用 homebrew 安装 pyenv，在终端中输入如下命令，该命令会自动下载最新版本的 pyenv，并自动下载依赖包。

brew install pyenv

安装完成后，可运行which pyenv命令查看pyenv是否存在。

pyenv工作原理

pyenv 会在系统环境变量 PATH 前面插入一个垫片目录 (pyenv root)/shims，这样每当运行 python 命令时，pyenv 便会拦截到该命令，并调用当前环境下使用的 python 版本对应的该命令。

通过重新哈希，pyenv 会在目录中维护一个 shims，从而将每一个 python 命令映射为不同 python 版本下的相应命令。

shim 是一个轻量级的可执行文件，它的主要任务是将终端输入的 python 命令传递给 pyenv。

在安装有 pyenv 的机器上，输入 python 命令时（如pip），操作系统会执行如下操作：

1. 在 PATH 指向的目录中查找名为 pip 的可执行文件；
2. 在 PATH 起始位置找到名为 pip 的 pyenv shim；
3. 运行名为 pip 的 shim，以告知 pyenv 运行的 python 命令；
4. pyenv 查找当前环境对应的 python 版本中的 pip 命令，并运行。

为了在每次启动 shell 的时候都能自动将 python 垫片目录添加到 PATH 前面，可在_{/.bash_profile（或}/.zshrc）末尾添加如下命令，在终端执行如下命令即可：

# 检测 pyenv 是否存在，若存在，则执行 pyenv init 命令
echo -e 'if command -v pyenv 1>/dev/null 2>&1; then\n  eval "$(pyenv init -)"\nfi' >> ~/.bash_profile

更新pyenv

brew upgrade pyenv

卸载pyenv

如果只是暂时不想使用 pyenv 的话，可考虑将_{/.bash_profile（或}/.zshrc）文件中的pyenv init命令注释掉，这样可随时通过取消注释开启 pyenv 功能。

如果想完全卸载 pyenv，则可按如下步骤操作：

# 删除 pyenv 根目录，同时会将所有安装在$(pyenv root)/versions/目录下的 python 版本删除
rm -rf $(pyenv root)

# 卸载 pyenv
brew uninstall pyenv

pyenv常用命令

pyenv 常用命令可在Command Reference查询。

pyenv commands

列出所有可用的pyenv命令。

$ pyenv commands
--version
commands
completions
exec
global
help
hooks
init
install
local

pyenv install

安装指定 python 版本，通过 python-build命令安装。

# 列出所有可用的版本
pyenv install -l
pyenv install --list

$ pyenv install -l
Available versions:
  2.1.3
  2.2.3
  2.3.7
  2.4.0
  2.4.1
  2.4.2
  2.4.3

# 安装指定 python 版本
pyenv install [-f] [-kvp] 

# 选项说明
-f/--force: 强制安装，即使该版本已经安装过了
-v/--verbose: 输出安装过程中的详细信息
-g/--debug: 构建 debug 版本
-s/--skip-existing: 跳过已安装的版本

# 安装 python 3.8.2
$ pyenv install 3.8.2
python-build: use [email protected] from homebrew
python-build: use readline from homebrew
Downloading Python-3.8.2.tar.xz...
-> https://www.python.org/ftp/python/3.8.2/Python-3.8.2.tar.xz
Installing Python-3.8.2...
python-build: use readline from homebrew
python-build: use zlib from xcode sdk
Installed Python-3.8.2 to /Users/Lilac/.pyenv/versions/3.8.2

pyenv uninstall

卸载指定 python 版本。

# 卸载指定 python 版本
pyenv uninstall [-f|--force] 

# 选项说明
-f/--force: 强制卸载，当待卸载版本存在时，无需确认，当待卸载版本不存在时，不显示错误信息

# 卸载 python 3.8.2
$ pyenv uninstall 3.8.2
pyenv: remove /Users/Lilac/.pyenv/versions/3.8.2? y

$ pyenv versions
  system
  3.7.0

pyenv local

设置当前工作目录下的 python 版本。

pyenv local命令执行后会在当前工作目录下的.python-version文件中写入设入的 python 版本。

在当前工作目录执行 python 命令时，会优先使用pyenv local命令指定的 python 版本。

# 设置当前工作目录下用 python3.8.2
$ pyenv local 3.8.2

# 重置当前目录的 python 版本
$ pyenv local --unset

# 同时设置多个当前工作目录可用的 python 版本，如 python2.7.16 和 python3.8.2
# 注意：此时会优先使用 python2.7.16
$ pyenv local 2.7.16 3.8.2

# 显示当前 pyenv 支持的 python 版本，该命令后文会介绍
$ pyenv versions
  system
* 2.7.16 (set by /Users/Lilac/.python-version)
* 3.8.2 (set by /Users/Lilac/.python-version)

$ python --version
Python 2.7.16
$ python2.7 --version
Python 2.7.16
$ python3.8 --version
Python 3.8.2

pyenv global

设置全局 python 版本。

pyenv global命令执行后会在~/.python-version文件中写入设入的 python 版本。

# 示例
# 设置全局 python 版本为 python3.8.2
$ pyenv global 3.8.2

# 示例
# 同时设置多个全局 python 版本，如 python2.7.16 和 python3.8.2
# 注意：此时会优先使用 python2.7.16
$ pyenv global 2.7.16 3.8.2         
$ pyenv versions
  system
* 2.7.16 (set by /Users/Lilac/.python-version)
* 3.8.2 (set by /Users/Lilac/.python-version)
$ python --version
Python 2.7.16
$ python2.7 --version
Python 2.7.16
$ python3.8 --version
Python 3.8.2

pyenv shell

设置当前 shell 窗口使用的 python 版本。

实现方式：通过设置当前 shell 窗口的 PYENV_VERSION 环境变量实现。

python版本设置优先级：pyenv shell > pyenv local > pyenv global

即 pyenv 会优先使用当前 shell 窗口设置的 python 版本(pyenv shell)，如果当前窗口未设置的话，则使用当前工作目录设置的 python 版本(pyenv local)，如果当前工作目录也未设置，则使用全局 python 版本(pyenv global)。

# 设置当前 shell 窗口 python 版本为2.7.16
$ pyenv shell 2.7.16

# 显示当前 shell 窗口使用的 python 版本
$ pyenv shell
2.7.16

# 重置当前 shell 窗口的 python 版本
$ pyenv shell --unset

# 同时设置多个当前 shell 窗口可用的 python 版本，如 python2.7.16 和 python3.8.2
# 注意：此时会优先使用 python2.7.16
$ pyenv shell 2.7.16 3.8.2      
$ pyenv versions
  system
* 2.7.16 (set by PYENV_VERSION environment variable)
* 3.8.2 (set by PYENV_VERSION environment variable)
$ python --version
Python 2.7.16
$ python2.7 --version
Python 2.7.16
$ python3.8 --version
Python 3.8.2

pyenv version

显示当前使用的 python 版本，同时会显示该版本是如何设置进来的(pyenv global/pyenv local/pyenv shell)。

pyenv version

$ pyenv version
3.8.2 (set by PYENV_VERSION environment variable)

pyenv versions

列出所有 pyenv 已知的 python 版本，当前使用的版本会在前面用*号标明

pyenv versions

$ pyenv versions
    system
  3.7.0
* 3.8.2 (set by PYENV_VERSION environment variable)

pyenv rehash

更新垫片目录 shims 内容，以使 pyenv 知道它所管理的 python 版本信息，一般在安装完一个新版本的 python 后，需运行一次该命令。

$ pyenv rehash

pyenv which

显示当前命令的可执行文件所在的完整路径。

pyenv which

$ pyenv which python3
/Users/Lilac/.pyenv/versions/3.8.2/bin/python3

参考文章

• pyenv官方地址
• Command Reference
• pyenv 和 pyenv-virtualenv 的安装、配置和使用