Python 如何创建 requirements.txt 文件

在本文中，我们将介绍如何使用 Python 创建一个 requirements.txt 文件。requirements.txt 文件是一个文本文件，用于记录项目的所有依赖包及其版本。通过使用 requirements.txt 文件，我们可以方便地共享项目的依赖信息，以便在不同的环境中轻松地安装相同的依赖。

阅读更多：Python 教程

1. 什么是 requirements.txt 文件

requirements.txt 文件是一个常用的 Python 项目工具，它用于列出项目需要的所有依赖包及其版本。这些依赖包可以是 Python 模块、框架、库或其他软件包。通过 requirements.txt 文件，我们可以实现项目依赖的统一管理和版本控制。

一个基本的 requirements.txt 文件如下所示：

numpy==1.21.0
pandas==1.3.0
matplotlib==3.4.3

在上面的例子中，我们列出了三个依赖包及其版本。每行一个依赖包，并使用双等号（）指定具体的版本号。这样，在执行依赖安装时，可以确保安装的是指定版本的依赖包。

2. 如何手动创建 requirements.txt 文件

手动创建 requirements.txt 文件的方法比较简单，可以按照以下步骤进行操作：

步骤 1：打开一个文本编辑器或集成开发环境（IDE）。

步骤 2：创建一个新的文本文件，并将文件保存为 requirements.txt。

步骤 3：按照上述格式，逐行列出项目的依赖包及其版本。

步骤 4：保存文件，并将其添加到项目的根目录下。

例如，我们有一个项目，依赖于 Flask、SQLAlchemy 和 requests 库，对应的 requirements.txt 文件可以如下所示：

Flask==2.0.1
SQLAlchemy==1.4.22
requests==2.26.0

3. 如何使用工具自动生成 requirements.txt 文件

手动创建 requirements.txt 文件虽然简单，但对于大型项目来说，管理依赖包的过程可能会变得复杂且容易出错。为了简化这个过程，我们可以使用一些工具来自动生成 requirements.txt 文件。

3.1 使用 pipreqs

pipreqs 是一个流行的 Python 工具，它可以自动扫描项目的源代码，并生成一个符合要求的 requirements.txt 文件。要使用 pipreqs，我们首先需要安装它：

pip install pipreqs

安装完成后，进入项目的根目录，执行以下命令即可生成 requirements.txt 文件：

pipreqs .

上述命令中的 . 表示当前目录，即项目的根目录。执行完上述命令后，pipreqs 将扫描项目代码，并将项目中所有第三方库及其版本写入 requirements.txt 文件。

3.2 使用 pip freeze

除了使用第三方工具，我们还可以使用 Python 自带的 pip 工具结合 freeze 命令来生成 requirements.txt 文件。freeze 命令会列出当前环境中已安装的所有库及其版本。

要生成 requirements.txt 文件，可以执行以下命令：

pip freeze > requirements.txt

上述命令将会把当前环境中的所有第三方库及其版本输出到 requirements.txt 文件中。

4. 如何使用 requirements.txt 安装项目依赖

通过创建和维护 requirements.txt 文件，我们可以方便地安装项目的依赖包。要安装项目的依赖，可以执行以下命令：

pip install -r requirements.txt

上述命令会根据 requirements.txt 文件中的依赖信息，从 PyPI（Python Package Index）上下载并安装对应的依赖包。使用 -r 参数指定 requirements.txt 文件。

如果运行成功，说明所有的依赖包都已正确安装。

总结

本文介绍了如何使用 Python 创建 requirements.txt 文件。通过手动创建或使用工具自动生成 requirements.txt 文件，我们可以方便地管理项目的依赖包及其版本。同时，通过使用 requirements.txt 文件，我们还可以轻松地在不同的环境中复现相同的项目依赖。

希望本文对你理解和使用 requirements.txt 文件有所帮助！