在 Python 开发中，requirements.txt 文件是 pip 用于管理和安装项目依赖的核心文件。本文将详细讲解 requirements.txt 文件的格式、生成、使用方法及相关功能，帮助你更好地理解如何利用这一工具进行高效的依赖管理。

什么是 requirements.txt 文件？

requirements.txt 文件用于列出项目所需的 Python 包及其版本。当你使用 pip install -r requirements.txt 命令时，pip 会根据文件中的内容自动安装相应的依赖包。这个文件通常命名为 requirements.txt，但文件名不是强制要求。

requirements.txt 文件格式详细说明

requirements.txt 文件的基本格式包括包名、版本要求、来源、路径等：

• 普通包名：例如 requests
• 版本规范：例如 requests==2.25.1，requests>=2.25.1, <3.0.0
• 引用 URL：例如 urllib3 @ https://github.com/urllib3/urllib3/archive/refs/tags/1.26.8.zip
• 引用本地路径：例如 ./downloads/numpy-1.9.2-cp34-none-win32.whl
• 引用其他要求文件或约束文件：例如 -r other-requirements.txt

以下是常见的格式示例：

# 这是一个注释，表示以 # 开头的行会被忽略。
# 可以指定普通的包名。
pytest
pytest-cov
beautifulsoup4

# 支持的语法与要求规范相同。
docopt == 0.6.1
requests [security] >= 2.8.1, == 2.8.* ; python_version < "2.7"
urllib3 @ https://github.com/urllib3/urllib3/archive/refs/tags/1.26.8.zip

# 可以引用其他要求文件或约束文件。
-r other-requirements.txt
-c constraints.txt

# 可以引用本地分发路径。
./downloads/numpy-1.9.2-cp34-none-win32.whl

# 可以引用 URL。
http://wxpython.org/Phoenix/snapshot-builds/wxPython_Phoenix-3.0.3.dev1820+49a8884-cp34-none-win_amd64.whl

requirements.txt 中的 ~= 符号是什么意思

在 requirements.txt 文件中，~= 符号用于表示“兼容”版本。例如：

这表示安装版本为 2.25.1 或兼容的版本，即 2.25.x，但不包括 2.26.0 或更高版本。这个符号可以确保在允许的版本范围内使用最新的兼容版本。

如何生成 requirements.txt 文件

你可以使用 pip freeze 命令来生成 requirements.txt 文件。pip freeze 命令可以将当前环境中的所有包及其版本列出，并输出到 requirements.txt 文件中。这在共享项目时非常有用，因为它可以确保其他开发者安装的是完全相同的包和版本。例如：

pip freeze > requirements.txt

生成的 requirements.txt 文件将包含所有当前安装的包及其版本号。这对于确保团队成员或部署环境中一致的包版本非常有用。

生成 requirements.txt 文件还有一些其他方式，相关阅读：

• 如何使用 pipreqs 生成 Python 项目的 requirements.txt 文件
• 如何使用 pigar 自动生成 Python 项目的 requirements.txt
• Pipenv 用法详解：如何使用 Pipenv 管理现代 Python 项目的虚拟环境和 requirements.txt 文件

如何安装 requirements.txt 文件中的依赖？

要从 requirements.txt 文件中安装依赖包，使用以下命令：

pip install -r requirements.txt

这条命令会读取 requirements.txt 文件中的内容，并安装文件中列出的所有包和版本。

pip 安装 requirements.txt 如何指定源？

如果需要指定源，可以通过-i, --index-url 命令：

pip install -r requirements.txt --index-url <source-url>

其中 <source-url> 是你指定的源 URL。

在 requirements.txt 中也能直接使用 -i 指定源，比如：

-i http://dist.repoze.org/zope2/2.10/simple
zopelib

相关阅读：pip 源设置指南：在 Windows、macOS 和 Linux 上配置腾讯云源

结语

通过了解 requirements.txt 文件的格式和使用方法，你可以更好地管理 Python 项目的依赖，确保开发环境的一致性和可重复性。希望这篇文章能帮助你更好地理解和使用 requirements.txt 文件。如果你有更多问题或需要进一步的帮助，欢迎在评论区留言讨论。