從接觸Python以來，一直都是采用 virtualenv 和 virtualenvwrapper 來管理不同項目的依賴環境，通過 workon 、 mkvirtualenv 等命令進行虛擬環境切換，很是愉快。
然而，最近想讓項目能兼容更多的Python版本，例如至少同時兼容 Python2.7 和 Python3.3+ ，就發現采用之前的方式行不通了。
最大的問題在于，在本地計算機同時安裝 Python2.7 和 Python3 后，即使分別針對兩個Python版本安裝了 virtualenv 和 virtualenvwrapper ，也無法讓兩個Python版本的 workon 、 mkvirtualenv 命令同時生效。另外一方面，要想在本地計算機安裝多個Python版本，會發現安裝的成本都比較高，實現方式也不夠優雅。
幸運地是，針對該痛點，已經存在一個比較成熟的方案，那就是 pyenv 。
如下是官方的介紹。
|
1
2
3
|
pyenv lets you easily switch between multiple versions of Python. It's simple, unobtrusive, and follows the UNIX tradition of single-purpose tools that do one thing well.This project was forked from rbenv and ruby-build , and modified for Python. |
本文就針對 pyenv 最核心的功能進行介紹。
基本原理
如果要講解 pyenv 的工作原理，基本上采用一句話就可以概括，那就是：修改系統環境變量 PATH 。
對于系統環境變量 PATH ，相信大家都不陌生，里面包含了一串由冒號分隔的路徑，例如 /usr/local/bin:/usr/bin:/bin 。每當在系統中執行一個命令時，例如 python 或 pip ，操作系統就會在 PATH 的所有路徑中從左至右依次尋找對應的命令。因為是依次尋找，因此排在左邊的路徑具有更高的優先級。
而 pyenv 做的，就是在 PATH 最前面插入一個 $(pyenv root)/shims 目錄。這樣， pyenv 就可以通過控制 shims 目錄中的Python版本號，來靈活地切換至我們所需的Python版本。
如果還想了解更多細節，可以查看 pyenv 的文檔介紹及其源碼實現。
環境初始化
pyenv 的安裝方式包括多種，重點推薦采用 pyenv-installer 的方式，原因主要有兩點：
通過 pyenv-installer 可一鍵安裝 pyenv 全家桶，后續也可以很方便地實現一鍵升級；
pyenv-installer 的安裝方式基于 GitHub ，可保證總是使用到最新版本的 pyenv ，并且 Python 版本庫也是最新最全的。
install && config
通過如下命令安裝 pyenv 全家桶。
$ curl -L https://raw.githubusercontent.com/pyenv/pyenv-installer/master/bin/pyenv-installer | bash
內容除了包含 pyenv 以外，還包含如下插件：
- pyenv-doctor
- pyenv-installer
- pyenv-update
- pyenv-virtualenv
- pyenv-which-ext
安裝完成后， pyenv 命令還沒有加進系統的環境變量，需要將如下內容加到 ~/.zshrc 中，然后執行 source ~/.zshrc 。
|
1
2
3
|
export PATH=$HOME/.pyenv/bin:$PATHeval "$(pyenv init -)"eval "$(pyenv virtualenv-init -)" |
完成以上操作后， pyenv 就安裝完成了。
|
1
2
|
$ pyenv -vpyenv 1.0.8 |
如果不確定 pyenv 的環境是否安裝正常，可以通過 pyenv doctor 命令對環境進行檢測。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
$ pyenv doctorCloning /Users/Leo/.pyenv/plugins/pyenv-doctor/bin/.....Installing python-pyenv-doctor...BUILD FAILED (OS X 10.12.3 using python-build 20160602)Last 10 log lines:checking for memory.h... yeschecking for strings.h... yeschecking for inttypes.h... yeschecking for stdint.h... yeschecking for unistd.h... yeschecking openssl/ssl.h usability... nochecking openssl/ssl.h presence... nochecking for openssl/ssl.h... noconfigure: error: OpenSSL development header is not installed.make: *** No targets specified and no makefile found. Stop.Problem(s) detected while checking system. |
通過檢測，可以發現本地環境可能存在的問題，例如，從以上輸出可以看出，本地的 OpenSSL development header 還沒有安裝。根據提示的問題，逐一進行修復，直到檢測不再出現問題為止。
update
通過 pyenv update 命令，可以更新 pyenv 全家桶的所有內容。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
$ pyenv updateUpdating /Users/Leo/.pyenv...From https://github.com/yyuu/pyenv * branch master -> FETCH_HEADAlready up-to-date.Updating /Users/Leo/.pyenv/plugins/pyenv-doctor...From https://github.com/yyuu/pyenv-doctor * branch master -> FETCH_HEADAlready up-to-date.Updating /Users/Leo/.pyenv/plugins/pyenv-installer...From https://github.com/yyuu/pyenv-installer * branch master -> FETCH_HEADAlready up-to-date.Updating /Users/Leo/.pyenv/plugins/pyenv-update...From https://github.com/yyuu/pyenv-update * branch master -> FETCH_HEADAlready up-to-date.Updating /Users/Leo/.pyenv/plugins/pyenv-virtualenv...From https://github.com/yyuu/pyenv-virtualenv * branch master -> FETCH_HEADAlready up-to-date.Updating /Users/Leo/.pyenv/plugins/pyenv-which-ext...From https://github.com/yyuu/pyenv-which-ext * branch master -> FETCH_HEADAlready up-to-date. |
pyenv的核心使用方法
pyenv 的主要功能如下：
$ pyenv -h
Usage: pyenv <command> [<args>]
Some useful pyenv commands are:
commands List all available pyenv commands
local Set or show the local application-specific Python version
global Set or show the global Python version
shell Set or show the shell-specific Python version
install Install a Python version using python-build
uninstall Uninstall a specific Python version
rehash Rehash pyenv shims (run this after installing executables)
version Show the current Python version and its origin
versions List all Python versions available to pyenv
which Display the full path to an executable
whence List all Python versions that contain the given executable
See `pyenv help <command>' for information on a specific command.
For full documentation, see: https://github.com/yyuu/pyenv#readme
查看所有可安裝的 Python 版本
|
1
2
3
4
5
6
7
8
9
10
11
12
|
$ pyenv install --listAvailable versions: 2.1.3 ... 2.7.12 2.7.13 ... 3.5.3 3.6.0 3.6-dev 3.6.1 3.7-dev |
需要注意的是，如果是采用 brew 命令安裝的 pyenv ，可能會發現 Python 版本庫中沒有最新的 Python 版本。所以建議還是通過 GitHub 源碼方式安裝 pyenv 。
安裝指定版本的 Python 環境
|
1
2
3
4
5
|
$ pyenv install 3.6.0Downloading Python-3.6.0.tar.xz...-> https://www.python.org/ftp/python/3.6.0/Python-3.6.0.tar.xzInstalling Python-3.6.0...Installed Python-3.6.0 to /Users/Leo/.pyenv/versions/3.6.0 |
查看當前系統中所有可用的 Python 版本
|
1
2
3
4
|
$ pyenv versions* system (set by /Users/Leo/.pyenv/version) 2.7.13 3.6.0 |
切換 Python 版本
pyenv 可以從三個維度來管理 Python 環境，簡稱為： 當前系統 、 當前目錄 、 當前shell 。這三個維度的優先級從左到右依次升高，即 當前系統 的優先級最低、 當前shell 的優先級最高。
如果想修改系統全局的Python環境，可以采用 pyenv global PYTHON_VERSION 命令。該命令執行后會在 $(pyenv root) 目錄（默認為 ~/.pyenv ）中創建一個名為 version 的文件（如果該文件已存在，則修改該文件的內容），里面記錄著系統全局的Python版本號。
|
1
2
3
4
5
6
7
8
9
10
11
|
$ pyenv global 2.7.13$ cat ~/.pyenv/version2.7.13$ pyenv version2.7.13 (set by /Users/Leo/.pyenv/version)$ pyenv global 3.6.0$ cat ~/.pyenv/version3.6.0$ pyenv version3.6.0 (set by /Users/Leo/.pyenv/version) |
通常情況下，對于特定的項目，我們可能需要切換不同的Python環境，這個時候就可以通過 pyenv local PYTHON_VERSION 命令來修改 當前目錄 的Python環境。命令執行后，會在當前目錄中生成一個 .python-version 文件（如果該文件已存在，則修改該文件的內容），里面記錄著當前目錄使用的Python版本號。
|
1
2
3
4
5
6
7
8
9
10
11
|
$ cat ~/.pyenv/version2.7.13$ pyenv local 3.6.0$ cat .python-version3.6.0$ cat ~/.pyenv/version2.7.13$ pyenv version3.6.0 (set by /Users/Leo/MyProjects/.python-version)$ pip -Vpip 9.0.1 from /Users/Leo/.pyenv/versions/3.6.0/lib/python3.6/site-packages (python 3.6) |
可以看出，當前目錄中的 .python-version 配置優先于系統全局的 ~/.pyenv/version 配置。
另外一種情況，通過執行 pyenv shell PYTHON_VERSION 命令，可以修改 當前shell 的Python環境。執行該命令后，會在當前 shell session （Terminal窗口）中創建一個名為 PYENV_VERSION 的環境變量，然后在 當前shell 的任意目錄中都會采用該環境變量設定的Python版本。此時， 當前系統 和 當前目錄 中設定的Python版本均會被忽略。
|
1
2
3
4
5
6
7
8
9
|
$ echo $PYENV_VERSION$ pyenv shell 3.6.0$ echo $PYENV_VERSION3.6.0$ cat .python-version2.7.13$ pyenv version3.6.0 (set by PYENV_VERSION environment variable) |
顧名思義， 當前shell 的Python環境僅在當前shell中生效，重新打開一個新的shell后，該環境也就失效了。如果想在 當前shell 中取消shell級別的Python環境，采用 unset 命令重置 PYENV_VERSION 環境變量即可。
|
1
2
3
4
5
6
7
8
|
$ cat .python-version2.7.13$ pyenv version3.6.0 (set by PYENV_VERSION environment variable)$ unset PYENV_VERSION$ pyenv version2.7.13 (set by /Users/Leo/MyProjects/.python-version) |
管理多個依賴庫環境
經過以上操作，我們在本地計算機中就可以安裝多個版本的 Python 運行環境，并可以按照實際需求進行靈活地切換。然而，很多時候在同一個 Python 版本下，我們仍然希望能根據項目進行環境分離，就跟之前我們使用 virtualenv 一樣。
在 pyenv 中，也包含這么一個插件， pyenv-virtualenv ，可以實現同樣的功能。
使用方式如下：
$ pyenv virtualenv PYTHON_VERSION PROJECT_NAME
其中， PYTHON_VERSION 是具體的Python版本號，例如， 3.6.0 ， PROJECT_NAME 是我們自定義的項目名稱。比較好的實踐方式是，在 PROJECT_NAME 也帶上Python的版本號，以便于識別。
現假設我們有 XDiff 這么一個項目，想針對 Python 2.7.13 和 Python 3.6.0 分別創建一個虛擬環境，那就可以依次執行如下命令。
|
1
2
|
$ pyenv virtualenv 3.6.0 py36_XDiff$ pyenv virtualenv 2.7.13 py27_XDiff |
創建完成后，通過執行 pyenv virtualenvs 命令，就可以看到本地所有的項目環境。
|
1
2
3
4
5
|
$ pyenv virtualenvs 2.7.13/envs/py27_XDiff (created from /Users/Leo/.pyenv/versions/2.7.13)* 3.6.0/envs/py36_XDiff (created from /Users/Leo/.pyenv/versions/3.6.0) py27_XDiff (created from /Users/Leo/.pyenv/versions/2.7.13) py36_XDiff (created from /Users/Leo/.pyenv/versions/3.6.0) |
通過這種方式，在同一個Python版本下我們也可以創建多個虛擬環境，然后在各個虛擬環境中分別維護依賴庫環境。
例如， py36_XDiff 虛擬環境位于 /Users/Leo/.pyenv/versions/3.6.0/envs 目錄下，而其依賴庫位于 /Users/Leo/.pyenv/versions/3.6.0/lib/python3.6/site-packages 中。
|
1
2
|
$ pip -Vpip 9.0.1 from /Users/Leo/.pyenv/versions/3.6.0/lib/python3.6/site-packages (python 3.6) |
后續在項目開發過程中，我們就可以通過 pyenv local XXX 或 pyenv activate PROJECT_NAME 命令來切換項目的 Python 環境。
|
1
2
3
4
5
6
7
|
? MyProjects pyenv local py27_XDiff(py27_XDiff) ? MyProjects pyenv versionpy27_XDiff (set by /Users/Leo/MyProjects/.python-version)(py27_XDiff) ? MyProjects python -VPython 2.7.13(py27_XDiff) ? MyProjects pip -Vpip 9.0.1 from /Users/Leo/.pyenv/versions/2.7.13/envs/py27_XDiff/lib/python2.7/site-packages (python 2.7) |
可以看出，切換環境后， pip 命令對應的目錄也隨之改變，即始終對應著當前的Python虛擬環境。
對應的，采用 pyenv deactivate 命令退出當前項目的 Python 虛擬環境。
如果想移除某個項目環境，可以通過如下命令實現。
$ pyenv uninstall PROJECT_NAME
以上便是日常開發工作中常用的 pyenv 命令，基本可以滿足絕大多數依賴庫環境管理方面的需求。
