目录

Python项目生成requirements.txt的多种方式,用于类库迁移必备

Python项目生成requirements.txt的多种方式,用于类库迁移必备

Published on: 2018-03-09

Tags: pip freeze pipreqs python

我相信任何软件程序都会有依赖的类库,尤其现在开源如此的火爆,很多轮子可以拿来直接使用不再需要自己再去开发(拿来主义者),这样大大的提高开发效率。NPM就是轮子最多的地方,哈哈!开个玩笑!

我们做开发时为何需要对依赖库进行管理?当依赖类库过多时,如何管理类库的版本?

我相信大家都知道怎么回答这个问题,为了更加规范管理项目结构,提高开发效率所以我们需要对依赖库进行管理,不管使用任何开发语言,如今都有依赖库的管理工具。

例如:JavaMavenGradleJSNPMPythonpipeasy_installLinuxapt-getyun 等。

我们这里就对Python的依赖库管理来进一步说一说。

Python提供通过requirements.txt文件来进行项目中依赖的三方库进行整体安装导入。

那首先让我们看一下requirements.txt的格式

requests==1.2.0
Flask==0.10.1

Python安装依赖库使用pip可以很方便的安装,如果我们需要迁移一个项目,那我们就需要导出项目中依赖的所有三方类库的版本、名称等信息。

接下来就看Python项目如何根据requirements.txt文件来安装三方类库

方法一:pip freeze

pip freeze > requirements.txt

pip freeze命令输出的格式和requirements.txt文件内容格式完全一样,因此我们可以将pip freeze的内容输出到文件requirements.txt中。在其他机器上可以根据导出的requirements.txt进行包安装。

如果要安装requirements.txt中的类库内容,那么你可以执行

pip install -r requirements.txt

注意:pip freeze输出的是本地环境中所有三方包信息,但是会比pip list少几个包,因为pipwheelsetuptools等包,是自带的而无法(un)install的,如果要显示所有包可以加上参数-all,即pip freeze -all

方法二:pipreqs

使用pipreqs生成requirements.txt

首先先安装pipreqs

pip install pipreqs

使用pipreqs生成requirements.txt

pipreqs <项目文件夹名>

注意:pipreqs生成指定目录下的依赖类库

上面两个方法的区别?

使用pip freeze保存的是当前Python环境下所有的类库,如果你没有用virtualenv来对Python环境做虚拟化的话,类库就会很杂很多,在对项目进行迁移的时候我们只需关注项目中使用的类库,没有必要导出所有安装过的类库,因此我们一般迁移项目不会使用pipreqspip freeze更加适合迁移整个python环境下安装过的类库时使用。

不知道virtualenv是什么或者不会使用它的可以查看:《构建Python多个虚拟环境来进行不同版本开发之神器-virtualenv》

使用pipreqs它会根据当前目录下的项目的依赖来导出三方类库,因此常用与项目的迁移中。

这就是pip freezepipreqs的区别,前者是导出Python环境下所有安装的类库,后者导出项目中使用的类库。