python虚拟环境最佳实践
众所周知,python的开发环境有点乱。随着python2的逐渐退出,这种情况有所改善。当时仍然存在了各种库的版本不同导致的依赖问题。解决这一问题的利器就是虚拟环境。在虚拟环境中,可以放心大胆的安装各种库,而不用担心会对系统的库产生影响。因此,在python中也有创建、管理虚拟环境的各种工具。其中最鼎鼎大名的就是virtualenv了。
在本文中,我们也主要介绍virtualenv的使用最佳实践。
安装 pipx
pipx用于安装python编写的有“命令行入口(console script entry points)”的程序,例如virtualenv等,也就是直接在命令行下执行的程序。使用pipx安装的好处在于,pipx会自动创建一个虚拟环境,将软件安装到这个环境中。后续可以方便的升级、管理等。
安装pipx通过pip安装:python3 -m pip install --user pipx
安装完成后,通过python3 -m pipx ensurepath
将pipx添加到环境变量中。
然后重新进入终端,之后就可以直接使用pipx命令了。
安装virtualenv
推荐使用pipx安装virtualenv到一个独立的环境中。这样后续可以单独升级virtualenv而不影响其他部分
安装命令:pipx install virtualenv
virtualenv 使用
virtualenv的使用主要包括创建、激活虚拟环境
创建
创建很简单:virtualenv venv
就创建了名为venv的虚拟环境。默认的python版本跟随当前环境的版本。
如果要指定python版本,就需要通过-p
参数指定python的绝对路径。
virtualenv -p /path/to/python3.7 venv
激活和退出
windows: venv\scripts\activate
linux: source venv/bin/activate
或 . venv/bin/activate
使用相应的deactivate
可以退出环境
删除
直接删除venv文件夹即可
在生产环境下使用
当我们将虚拟环境部署到生产环境下,启动程序之前要写一个启动脚本,在启动脚本中,需要先激活虚拟环境,然后再运行程序即可。例如有一个flaks程序,安装了虚拟环境venv,在虚拟环境中安装gunicorn,通过gunicorn拉起flask程序,可以写如下启动脚本:
#!/bin/bash
source /home/dev/myflaks/venv/bin/activate
cd /home/dev/myflaks/myapp
#项目的启动脚本叫 start.py ,其中的app是一个wsgi应用
gunicorn -w 4 start:app -b host:port
使用pip-tools管理依赖
pip-tools包括2个工具:pip-compile和pip-sync,用于创建和管理python依赖。
安装
需要注意,必须在对应的虚拟环境中安装,安装命令如下:
pip install pip-tools
pip-compile
pip-compile命令用于根据setup.py
或requirements.in
文件编译得到requirements.txt
文件。pip-compile可以自动判断不同包的依赖关系,从而将相关的包都自动写进requirements.txt中。
注意:如果从新编译,最好删除之前的requirements.txt
文件,以免冲突。
用法:pip-compile
: 默认读取setup.py
或requirements.in
生成对应的requirements.txt
文件
也可以指定输入文件:pip-compile dev.in --output-file requirements-dev.txt
pip的参数也可以用于pip-compile
requirement.in写法
requirement.in的写法和requirement.txt写法类似,可以通过==
,<
,>
等指定版本号。
也可以有层级依赖关系,
例如,在Django项目中,在生产环境,你想使用2.1版本,可以写出下面这个:
# requirements.in
django<2.2
在开发环境,你想使用一个包,可以这样写进行引用
# dev-requirements.in
-c requirements.txt
django-debug-toolbar
然后,先编译出requrements.txt, 使用命令pip-compile
在开发环境,使用pip-compile dev-requirements.in
在生产环境下,安装依赖: pip-sync
这个只安装requirements.txt中的
要安装开发环境下的,运行pip-sync requirements.txt dev-requirements.txt
安装依赖
pip-sync命令可以用于在生产下安装依赖。
通过pip-sync
自动安装requirements.txt。注意,pip-sync只能用于由pip-compile产生的requirements文件。
也可以指定文件,例如上面的例子:pip-sync requirements.txt dev-requirements.txt
配合版本控制
需要将requirements.in, requirements.txt提交,如果你使用的是多版本的python,推荐以下命名方式:
{env}-requirements.txt
例如 win32-py2.7-requirements.txt, macos-py3.6-requirements.txt.
需要注意,不同python环境下包的依赖不同,python环境指:操作系统,python版本,python解析器(CPython,PyPy,等等)
如果要产生不同环境的requirements.txt,用户应该在不同环境下运行pip-compile。
requirements.in则可以通用。
所以最好是,将requirement.in提交到git中,在生产环境下运行pip-compile, pip-sync。