requirements.txt 文件是 Python 项目管理的一个关键组成部分。掌握如何生成和使用这个文件,将大大提高在不同开发环境中工作的效率。无论是个人项目还是团队协作,正确使用 requirements.txt 都是确保项目顺利运行的有效途径。

简介

​ 在 Python 项目开发中,requirements.txt 文件扮演着至关重要的角色,它记录了项目所需的所有依赖包及其精确版本号。这确保了代码在不同环境中都能以预期的方式运行。本文将深入探讨如何生成和使用 requirements.txt 文件,帮助您在 Python 项目管理中更加得心应手。
requirements.txt 是一个文本文件,列出了所有必须安装的库,以便于在新环境中复制相同的设置。它通常包括库的名称和版本号,格式如下:

flask==1.1.2
requests==2.24.0

如何生成

方法一

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

​ 在命令行中运行:

pip freeze > requirements.txt

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

方法二

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

​ 首先安装 pipreqs

pip install pipreqs

​ 然后在项目根目录下运行:

pipreqs . --encoding=utf8   
# 或者
pipreqs ./ --encoding utf-8

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

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

如何使用

​ 在新环境部署项目时,可以使用 requirements.txt 文件轻松安装所有依赖项。只需运行:

pip install -r requirements.txt

​ 项目开发过程中,依赖包可能会更新。应定期更新 requirements.txt 文件,以确保使用最新的依赖版本。更新后,使用相同的安装命令应用更改。