欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

5分钟 Pipenv 上手指南

程序员文章站 2023-09-07 18:05:48
现在就花5分钟,掌握这个工具的使用吧。 pipenv是requests作者的一个项目, 整合了virtualenv, pip, pipfile, 用于更方便地为项目建...

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

pipenv是requests作者的一个项目, 整合了virtualenv, pip, pipfile, 用于更方便地为项目建立虚拟环境并管理虚拟环境中的第三方模块。

安装 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\<yourname>\.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

更多操作指南,请参考官方文档:

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。