【Python基础】一文搞懂：Python 中 “requirements.txt“ 文件生成和使用

文章目录

- 1 引言
- 2 什么是 `requirements.txt`？
- 3 如何生成 `requirements.txt`？
- - 3.1 方法一：使用 pip freeze
  - 3.2 方法二：使用 pipreqs
- 3.3 使用 pip freeze 和 pipreqs 的对比
- 4 如何使用 `requirements.txt`？
- - 4.1 安装依赖
  - 4.2 更新依赖
- 5 总结

1 引言

在 Python 项目开发中，requirements.txt 文件扮演着至关重要的角色，它记录了项目所需的所有依赖包及其精确版本号。这确保了代码在不同环境中都能以预期的方式运行。本文将深入探讨如何生成和使用 requirements.txt 文件，帮助您在 Python 项目管理中更加得心应手。

2 什么是 `requirements.txt`？

requirements.txt 是一个文本文件，列出了所有必须安装的库，以便于在新环境中复制相同的设置。它通常包括库的名称和版本号，格式如下：

flask==1.1.2
requests==2.24.0

3 如何生成 `requirements.txt`？

3.1 方法一：使用 pip freeze

最简单的生成方法是使用 pip freeze 命令。这个命令会列出当前环境中所有已安装的包及其版本号。

在命令行中运行：

pip freeze > requirements.txt

这将会创建一个包含所有依赖项的 requirements.txt 文件。

3.2 方法二：使用 pipreqs

pipreqs 是一个更智能的工具，它根据项目文件中的实际导入来生成依赖列表。

首先安装 pipreqs：

pip install pipreqs

然后在项目根目录下运行：

pipreqs . --encoding=utf8

或者

pipreqs ./ --encoding utf-8

pipreqs 会在项目文件夹中创建一个 requirements.txt 文件，只包含项目实际使用的依赖。

3.3 使用 pip freeze 和 pipreqs 的对比

在生成 requirements.txt 文件时，pip freeze 和 pipreqs 是两种常用的方法，但它们在使用上有着显著的差异。以下是这两种方法的对比，帮助您根据项目需求选择最合适的工具。

pip freeze

pip freeze 生成的 requirements.txt 包含了当前环境中所有已安装的库及其版本号。这种方法的主要特点是：

简单直接：只需一个命令，即可列出所有安装的包。
全面性：生成的文件包括所有包，无论它们是否直接用于项目。
适用场景：最适合小型项目或在虚拟环境中工作时使用。

优点

快速且易于操作。
确保了环境一致性，因为它列出了所有包。

缺点

可能包含不必要的依赖，导致项目膨胀。
如果不是在虚拟环境中运行，可能会包含全局安装的包，与项目无关。

pipreqs

与 pip freeze 不同，pipreqs 会分析项目文件，仅列出项目实际使用的依赖。它的特点包括：

智能分析：基于项目代码分析依赖项。
轻量结果：仅包含项目需要的依赖，避免不必要的包。
适用场景：适合较大的项目或需要精确依赖管理的情况。

优点

生成的 requirements.txt 更准确，不包含冗余依赖。
减少了项目大小，提高了安装速度。

缺点

分析过程可能需要更多时间。
某些情况下可能无法检测到间接依赖。

小结:
选择 pip freeze 还是 pipreqs 取决于您的具体需求。对于在干净的虚拟环境中开发的小型项目，pip freeze 可能是最好的选择。而对于更大的项目，或当您需要更准确地控制依赖时，pipreqs 可能更适合。无论选择哪种方法，定期更新 requirements.txt 以反映最新的依赖状态始终是一个好习惯。