在 Python 开发的世界中，管理依赖项是确保项目在不同环境中顺利运行的关键任务。requirements.txt 文件是 Python 依赖管理的基石，它列出了项目所需的所有包。

本文提供了创建和使用 requirements.txt 文件的综合指南，确保您的 Python 项目既可移植又可复制。

理解 Python 中的依赖管理

依赖管理是指跟踪项目所依赖的外部库和模块的实践。需要在特定版本上安装和维护这些依赖项，以防止冲突并确保兼容性。requirements.txt 文件作为这些依赖项的清单，允许开发人员轻松地共享和复制环境。

requirements.txt 的重要性

Consistency

它确保在一个项目和部署环境中工作的所有开发人员使用相同版本的库，避免了 "它在我的机器上是正常工作" 的问题。

Simplicity

它允许使用单个命令安装依赖项，从而简化了新开发人员或部署到新环境时的设置过程。

Documentation

它作为文档的一种形式，列出了项目所依赖的所有外部包。

如何创建 requirements.txt

创建一个 requirements.txt 文件非常简单，下面是如何创建的基本步骤：

Step 1: Identify Your Dependencies

列出项目所依赖的所有 Python 包，这包括使用 pip 安装的包。

Step 2: Use pip freeze

最简单方法是使用 pip freeze 命令，该命令列出环境中安装的所有 Python 包及其版本。执行如下命令，将该列表保存为 requirements.txt 文件。

pip freeze > requirements.txt

Step 3: Manual Editing (Optional)

在某些情况下，您可能希望手动编辑 requirements.txt 文件。这可能是删除不必要的包 (例如，仅用于测试的包) 或指定版本范围而不是固定版本以获得更大的灵活性。

requirements.txt 文件看起来如下所示：

Flask==3.0.2
Flask-Cors==4.0.0
jsonschema==4.21.1
mysql-connector==2.2.9
mysql-connector-python==8.3.0
numpy==1.26.4
opencv-python-headless==4.9.0.80
packaging==23.2
pillow==10.2.0
python-dotenv==1.0.1
referencing==0.33.0
requests==2.31.0
scipy==1.12.0
urllib3==2.2.0

使用 requirements.txt 安装依赖包

要安装 requirements.txt 文件中列出的所有依赖项，请使用以下 pip 命令：

pip install -r requirements.txt

该命令读取 requirements.txt 文件，并以指定的版本安装列出的所有包。

最佳实践

(1) Use Virtual Environments

始终为项目创建虚拟环境，以避免项目依赖项之间的冲突。

(2) Specify Versions

在可能的情况下，指定包版本以确保一致性。使用版本范围约束条件进行更新。

(3) Regularly Update

保持您的依赖项是最新的，但在更新之前要进行彻底的测试，以避免破坏性的更改。

(4) Comment Your Dependencies

如果一个包需要一个特定的版本，或者如果依赖关系不明显，添加注释来解释原因。

我的开源项目

• course-tencent-cloud（酷瓜云课堂 - gitee 仓库）
• course-tencent-cloud（酷瓜云课堂 - github 仓库）