Mac配置Python开发环境之virtualenvwrapper

1、virtualenvwrapper简介

virtualenvwrapper,相较于使用virtualenv, 好处就是把所有环境都放在同一目录下管理,以便更好的管理及切换。

2、安装virtualenvwrapper

使用如下命令进行安装

$ pip install  virtualenvwrapper

有的博文使用了sudo命令,此时的安装命令变为

$ sudo pip install virtualenvwrapper

按下回车键后,需要输入用户密码才能安装。

3、配置virtualenvwrapper

首先创建两个文件夹,一个用来存放虚拟环境(.virtualenvs),另一个是工作空间(workspace)

$ mkdir $HOME/.virtualenvs
$ mkdir $HOME/workspace

需要说明的是,文件夹的名称自己可以随意更改,相应的代码就要进行更改。

然后在shell配置文件中添加如下几行代码(我使用的是zsh,所以在~/.zshrc中添加)

export WORKON_HOME=$HOME/.virtualenvs
export PROJECT_HOME=$HOME/workspace
source /usr/local/bin/virtualenvwrapper.sh

然后在当前终端(shell)中执行如下命令让更改之后的终端配置生效

$ source ~/.zshrc

如果成功则会出现类似如下信息

virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/premkproject
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/postmkproject
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/initialize
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/premkvirtualenv
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/postmkvirtualenv
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/prermvirtualenv
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/postrmvirtualenv
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/predeactivate
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/postdeactivate
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/preactivate
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/postactivate
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/get_env_details

如果遇到如下错误

/Users/wangkaiju/.pyenv/versions/3.7.0/bin/python: Error while finding module specification for 'virtualenvwrapper.hook_loader' (ModuleNotFoundError: No module named 'virtualenvwrapper')
virtualenvwrapper.sh: There was a problem running the initialization hooks.
If Python could not import the module virtualenvwrapper.hook_loader,
check that virtualenvwrapper has been installed for
VIRTUALENVWRAPPER_PYTHON=/Users/wangkaiju/.pyenv/shims/python and that PATH is
set properly.

解决方案:
首先在终端执行命令查看python的版本,后面要用到

$ python -V

其次要更改/usr/local/bin/virtual/virtualenvwrapper.sh,找到下面的代码位置

# Locate the global Python where virtualenvwrapper is installed.
if [ "$VIRTUALENVWRAPPER_PYTHON" = "" ] then
VIRTUALENVWRAPPER_PYTHON="$(command \which python)"
fi

若终端查看得到的python版本是python3,则将

VIRTUALENVWRAPPER_PYTHON="$(command \which python)"

这行命令更改为

VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3

如果终端查看得到的python版本是python2,则更改为

VIRTUALENVWRAPPER_PYTHON=/usr/bin/python2

说明:按照正常的安装步骤来讲,是不会出错的,出现这种错误是由于安装virtualenvwrapper是python3环境,而系统采用的是python2,反之亦然,也就是安装virtualenvwrapper的python环境和系统python环境不一致,此时我们手动将两者改为一致则问题解决。
参考: virtualenvwrapper配置报错

说明:本来按照上面的办法解决了我的问题,后来用mkvirtualenv命令创建了新的虚拟环境后,再打开了一个终端又报前面提到的错误,再找了一个解决方案,如下:
在~/.zshrc文件的最下方加入下面语句

if [ -f /usr/local/bin/virtualenvwrapper.sh ]; then
export WORKON_HOME=$HOME/.virtualenvs
export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python3
source /usr/local/bin/virtualenvwrapper.sh

fi

“加粗”的部分路径设置为python3(当py2和py3共存的时候),问题解决。需要注意的是,要根据自己的系统找到系统安装好的python3的路径,我的Mac是/usr/local/bin/python3,别的linux系统可能是/usr/bin/python3,相应的粗体部分python3的路径要作修改。
参考:pip安装virtualenvwrapper报错的解决办法

4、virtualenvwrapper的使用

4.1 创建虚拟环境

$ mkvirtualenv py37_test

其中py37_test是我创建的虚拟环境的名字,可以自行更改,而且创建完成后自动进入创建好的虚拟环境。mkvirtualenv也可以创建指定python版本的虚拟环境,此时要用到-p参数指出python的路径:

$ mkvirtualenv -p /usr/local/bin/python3 py37_test

4.2 查看创建的虚拟环境

$ lsvirtualenv
# 或者
$ workon

4.3 启动某虚拟环境

命令格式 workon VIRTUALENV_NAME
其中VIRTUALENV_NAME是虚拟环境的名称
为了查看效果,重新打开一个终端,再创建一个新的虚拟环境py27_test

$ mkvirtualenv py27_test

会出现如下的提示

Using base prefix '/Users/wangkaiju/.pyenv/versions/3.7.0'
New python executable in /Users/wangkaiju/.virtualenvs/py27_test/bin/python3.7
Not overwriting existing python script /Users/wangkaiju/.virtualenvs/py27_test/bin/python (you must use /Users/wangkaiju/.virtualenvs/py27_test/bin/python3.7)
Installing setuptools, pip, wheel...done.
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/py27_test/bin/predeactivate
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/py27_test/bin/postdeactivate
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/py27_test/bin/preactivate
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/py27_test/bin/postactivate
virtualenvwrapper.user_scripts creating /Users/wangkaiju/.virtualenvs/py27_test/bin/get_env_details

此时终端命令提示符前面会多了(py27_test),类似于

(py27_test) ╭──wangkaiju@wangkaijudeMBP

在该界面下使用命令 workon,则会显示出如下类容

py27_test
py37_test

也就是将创建好的两个虚拟环境都列举了出来,此时处于py27_test环境,要切换到py37_test环境,则执行命令

workon py37_test

4.4 删除虚拟环境

rmvirtualenv 【虚拟环境的名字】

$ rmvirtualenv py37_test

需要说明的是,无法在虚拟环境中删除虚拟环境,要先退出虚拟环境才行。

4.5 退出虚拟环境 deactivate

在虚拟环境中使用deactivate则退出了虚拟环境,只有就可以删除虚拟环境了。

deactivate

注意:pyenv virtualenv命令和mkvirtualenv命令创建的虚拟环境是无法互相使用的,也就是说pyenv virtualenv命令创建的虚拟环境无法被workon命令识别,同样的mkvirtualenv命令创建的虚拟环境也无法被pyenv versions等命令识别

5、总结

virtualenvwrapper这个插件很怪,Mac电脑直接使用如下命令安装virtualenvwrapper时并不能成功,会提示找不到,找到了一个名叫pyenv-virtualenvwrapper的类似的包,然后我就安装了pyenv-virtualenvwrapper这个包,然后在进行后续配置时出错,错误提示见第3节错误提示。

$ brew install virtualenvwrapper

后来才发现virtualenvwrapper和pyenv-virtualenvwrapper应该是两个不同的东西,之所以这里我会出错,是因为前面在安装virtualenv时,我是用brew install命令安装的,同样提示找不到virtualenv,但是有一个类似的包pyenv-virtualenv,然后我用brew install命令安装了pyenv-virtualenv,并且好用,所以此处我也想用同样的方式安装virtualenvwrapper,结果证明是不行的。