Pipenv 上手指南

By liuzhijun, 2018-12-19, 分类: Python技术

Pipenv

你可能听说Pipenv,如果还没使用过,那么恭喜你,这个工具可以让你的开发工作省心不少。同一时间段内我们有可能负责多个项目的开发,保证每个项目的环境独立,互不影响非常有必要的,virtualenv 就是干这个事的,Pip 主要负责安装第三方包,而 Pipenv 就是两者的结合体,给我们的开发带来了更多的便利性。 所有的命令都可以通过 pipenv 完成。

现在就花5分钟,掌握这个工具的使用吧。

安装 Pipenv

pipenv 的安装和普通的第三方库没什么区别,可以直接使用 pip 命令安装。

pip install  pipenv

在 Mac 上可以使用 brew 命令来安装

brew install pipenv

接下来介绍如何使用 Pipenv,我们开启新项目后,首先要做的就是为其单独创建一个虚拟环境(确保你的电脑里面只安装一个Python版本,否则总会出现不可预知的问题)

创建虚拟环境

虚拟环境是每个项目独立使用的 Python 执行环境。

# 进入项目所在目录
cd your_project

pipenv install

严格来说,pipenv 没有直接提供创建虚拟环境的命令,而是在背后默默帮你创建,install 其实是安装第三方包的命令,对新项目来说,它会先创建虚拟环境,同时,在项目目录下创建名为 Pipfile 的空文件。

虚拟环境的名字和项目名相关,默认情况下,Pipenv 会自动为你选择虚拟环境的存储位置,在 Windows 下通常为 C:\Users\.virtualenvs

安装第三方包

以前安装包使用 pip 命令,现在你可以用 pipenv 命令来安装,例如我安装 requests 包:

pipenv install requests

使用 pipenv 安装第三方包有什么好处呢?安装前你不需要激活虚拟环境,就直接下载到了虚拟环境中,如果用 pip 安装,你还要先激活该环境。(我经常忘记给虚拟环境取了什么名字)

安装完包之后,Pipfile 文件会被更新,同时新增了 Pipfile.lock 文件

Pipfile 文件中的结构:

[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true

[dev-packages]

[packages]
requests = "*"

[requires]
python_version = "3.7"

Pipfile 文件中记录了3件事情:

  1. 包从哪里下载的
  2. 需要下载哪些包, * 表示始终下载最新版本, dev-packages 表示专用于开发阶段使用的包。
  3. Python 版本是多少

Pipfile.lock 文件详细记录了这些包的信息,包括这个包的hash值多少,还有包所依赖的其他包有哪些。

把这些信息写在 Pipfile 文件中的好处是,当我们把项目部署到正式环境时,不再需要一个一个去安装了,直接执行 pipenv install 就会自动创建虚拟环境的同时,把 Pipfile 中包都安装好。

激活虚拟环境

运行程序前我们还是要激活虚拟环境,我们可以使用 pipenv shell 来激活,不需要指定名字,只要你在当前项目下执行该命令就行。

pipenv shell

Launching subshell in virtual environment
Microsoft Windows [Version 10.0.18290.1000]
(c) 2018 Microsoft Corporation. All rights reserved.

(weihub-flask-j3rUnHkH) D:\my\weihub-flask>

注意到了吗? 目录前面多了一对括号括起来的字符串,它就是我们刚刚创建的虚拟环境名字。 激活虚拟环境后,你就可以开始运行你的程序了。

(weihub-flask-j3rUnHkH) D:\my\weihub-flask> python

>>> import requests
>>> requests.get("http://baidu.com").text
'<html>\n<meta http-equiv="refresh" content="0;url=http://www.baidu.com/">\n</html>\n'
>>>

退出虚拟环境使用 exit 命令, 这时候那对括号就消失了。

pipenv run

另外,pipenv 还准备了一个 run 命令,它可以在你不必显示激活虚拟环境的情况下,用虚拟环境执行命令,例如:

pipenv run python -m http.server
pipenv run python main.py

以上就是你要掌握的 Pipenv 基础知识,如果有兴趣,你还可以了解下面的内容

从 requirements.txt 导入

如果是老项目,你把依赖包全部放在 requirements.txt 中,pipenv 很贴心,它支持从 requirements.txt 文件中安装,方便使用 pip 的用户平滑迁移过来。

pipenv install -r requirements.txt

只安装到开发环境

在开发环境下我们要安装 django-debug-toolbar, pytest 这样的包,这些在生产环境其实是用不上的,所以没必要安装,那么我们在安装某个包的时候可以在 isntall 后面加个参数 --dev,表示只安装在开发环境,例如:

pipenv install pytest --dev
 ```

在生产环境执行:
```python
# 生产环境
pipenv install

开发环境执行:

# 开发环境
pipenv install --dev

卸载包

pipenv uninstall requests

删除虚拟环境

pipenv --rm 

删除虚拟环境后,会把虚拟环境目录和里面的所有依赖包删除掉,但是 Pipfile 和 Pipfile.lock 文件还会保留。

常见问题:

如果你在使用 pipenv 创建虚拟环境失败了,出现类似这样的错误:

pipenv install
Creating a virtualenv for this project…
Pipfile: D:\my\weihub-flask\Pipfile
Using c:\users\lzjun\appdata\local\programs\python\python37-32\python.exe (3.7.1) to create virtualenv…
[ ===] Creating virtual environment...Already using interpreter c:\users\lzjun\appdata\local\programs\python\python37-32\python.exe
Using base prefix 'c:\\users\\lzjun\\appdata\\local\\programs\\python\\python37-32'
New python executable in C:\Users\lzjun\.virtualenvs\weihub-flask-j3rUnHkH\Scripts\python.exe
ERROR: The executable C:\Users\lzjun\.virtualenvs\weihub-flask-j3rUnHkH\Scripts\python.exe is not functioning
ERROR: It thinks sys.prefix is 'd:\\my\\weihub-flask' (should be 'c:\\users\\lzjun\\.virtualenvs\\weihub-flask-j3runhkh')
ERROR: virtualenv is not compatible with this system or executable
Note: some Windows users have reported this error when they installed Python for "Only this user" or have multiple versions of Python installed. Copying the appropriate PythonXX.dll to the virtualenv Scripts/ directory may fix this problem.

Failed creating virtual environment
[pipenv.exceptions.VirtualenvCreationException]:   File "c:\users\lzjun\appdata\local\programs\python\python37-32\lib\site-packages\pipenv\cli\command.py", line 254, in install
[pipenv.exceptions.VirtualenvCreationException]:       editable_packages=state.installstate.editables,
[pipenv.exceptions.VirtualenvCreationException]:   File "c:\users\lzjun\appdata\local\programs\python\python37-32\lib\site-packages\pipenv\core.py", line 1741, in do_install
[pipenv.exceptions.VirtualenvCreationException]:       pypi_mirror=pypi_mirror,
[pipenv.exceptions.VirtualenvCreationException]:   File "c:\users\lzjun\appdata\local\programs\python\python37-32\lib\site-packages\pipenv\core.py", line 574, in ensure_project
[pipenv.exceptions.VirtualenvCreationException]:       pypi_mirror=pypi_mirror,
[pipenv.exceptions.VirtualenvCreationException]:   File "c:\users\lzjun\appdata\local\programs\python\python37-32\lib\site-packages\pipenv\core.py", line 506, in ensure_virtualenv
[pipenv.exceptions.VirtualenvCreationException]:       python=python, site_packages=site_packages, pypi_mirror=pypi_mirror
[pipenv.exceptions.VirtualenvCreationException]:   File "c:\users\lzjun\appdata\local\programs\python\python37-32\lib\site-packages\pipenv\core.py", line 935, in do_create_virtualenv
[pipenv.exceptions.VirtualenvCreationException]:       extra=[crayons.blue("{0}".format(c.err)),]
[pipenv.exceptions.VirtualenvCreationException]: Fatal Python error: initfsencoding: unable to load the file system codec
Traceback (most recent call last):
  File "C:\Users\lzjun\.virtualenvs\weihub-flask-j3rUnHkH\lib\encodings\__init__.py", line 31, in <module>
  File "C:\Users\lzjun\.virtualenvs\weihub-flask-j3rUnHkH\lib\codecs.py", line 481
    except UnicodeDecodeError, exc:
                             ^
SyntaxError: invalid syntax

很有可能就是你的系统中安装多有个版本的Python,可以模糊搜索 Python*.dll ,把那些不相关的全部删除,重新试试。

如何提高下载速度

修改 Pipfile 文件中的URL,将下载源指定为阿里云或者豆瓣等国内更快的源

[[source]]
name = "pypi"
url = "https://mirrors.aliyun.com/pypi/simple"
#或者使用豆瓣源
url = "http://pypi.douban.com/simple"
verify_ssl = true

Pipenv 有什么缺点

慢,有时候感觉特别慢,就一直卡在 Locking 过程中,你在安装的时候跳过 lock 环节,使用命令

pipenv install --skip-lock

更多操作指南,请参考官方文档: https://pipenv.readthedocs.io/en/latest/basics/


关注公众号「Python之禅」(id:vttalk)获取最新文章 python之禅