python requirements.txt 文件详细说明,一篇就够了

9,155 阅读2分钟

“Offer 驾到,掘友接招!我正在参与2022春招打卡活动,点击查看活动详情。”

📆 最近更新:2022年3月28日,橡皮擦的第 600 篇原创博客

⛳️ 实战场景

在部署Python应用时,需要把第三方库进行安装,这里可以使用 requirements.txt 文件,其中记录了所有依赖包以及精确的版本号。

requirements.txt 文件在我们访问开源 Python项目的时候,极常见。

简单使用流程概述

使用 pip freeze 命令生成 requirements.txt 文件,如下所示

pip freeze > requirements.txt

在这里插入图片描述

请注意,每包都独占一行,然后是版本号。

生成的文件默认在控制台执行目录,也可以自定义目录,创建文件的时候增加文件目录即可

pip freeze > d:/requirements.txt

其中 > 表示重定向,即 freeze 输出的内容送到 requirements.txt 文件中。

迁移环境的时候,注意打包该文件,然后使用如下命令部署

pip install -r requirements.txt

⛳️ 生成 requirements.txt 文件潜在问题

如果生成该文件出现的时候出现 warning,建议使用 python -m 去执行 pip freeze 命令。

如果你创建 Python 程序,或者安装模块时,未使用虚拟环境,那在生成 requirements.txt 文件的时候,会将你本地所有的包都进行打包提取,部署前,需要人工进行筛选。

语法格式requirements.txt 文件中,可以只写第三方模块名称,不指定版本号,默认安装最新版本。

如果使用注释,使用 # 加文字内容。

模块名称与版本号之间可以使用如下符号

  1. ==:等于
  2. >:大于版本
  3. >=:大于等于
  4. <:小于版本
  5. <=:小于等于版本
  6. ~=:兼容版本,使用任何大于或等于指定版本,但不大于当前发行系列的版本,例如 ~=1.4.3 可以匹配 1.4.31.4.9,但是不能匹配 1.5.0

在可选范围内,安装最新版本,当前最优先的依旧是等于的版本号。

可以使用逗号 , 分隔两个条件,例如下述代码

package_name >= 1.0, <=2.0

⛳️ 使用 requirements.txt 文件的好处

  1. 不需要每个包都使用 pip 进行安装
  2. 不需要确定第三方模块的版本号

⛳️ 备注

上文提及如果希望 requirements.txt 文件变得精简,可以使用虚拟环境实现隔离,它将用户的软件包和系统的软件包进行区分,允许我们为每个单独的程序安装模块。

常见的虚拟环境包如下所示

  • virtualenv

  • pipenv