自动创建 Python 的 requirements.txt 文件

技术背景

在 Python 开发中，requirements.txt 文件用于记录项目所依赖的第三方库及其版本，方便在不同环境中部署项目。然而，当从 GitHub 下载 Python 源代码时，有时会缺少该文件，手动创建既耗时又容易出错。因此，自动生成 requirements.txt 文件显得尤为重要。

实现步骤

方法一：使用 pipreqs

1. 安装 pipreqs：

   pip install pipreqs

2. 生成 requirements.txt：

   pipreqs /path/to/project

   若项目路径为当前目录，可使用：

   pipreqs .

   若遇到编码问题，可指定编码：

   pipreqs --encoding utf-8 /path/to/project

方法二：使用 pip freeze

1. 创建虚拟环境（可选但推荐）：
   • Python 3：

     python3 -m venv .venv
     source .venv/bin/activate

   • Python 2：

     pip install virtualenv
     virtualenv <myenvname>
     source <myenvname>/bin/activate

2. 安装项目依赖：

   pip install <dependencies name>

3. 生成 requirements.txt：
   • Python 3：

     pip3 freeze > requirements.txt

   • Python 2：

     pip freeze > requirements.txt

方法三：结合 pipreqs 和 pip-tools

1. 安装工具：

   pip3 install pipreqs
   pip3 install pip-tools

2. 生成 requirements.in 和 requirements.txt：

   pipreqs --savepath=requirements.in && pip-compile

方法四：使用 Anaconda

1. 生成 requirements.txt：

   conda list -e > requirements.txt

2. 若遇到错误，使用 .yml 选项：

   conda env export > <environment-name>.yml

3. 创建新环境：

   conda env create -f <environment-name>.yml

核心代码

使用 pipreqs 生成 requirements.txt

pip install pipreqs
pipreqs /path/to/project

使用 pip freeze 生成 requirements.txt

python3 -m venv .venv
source .venv/bin/activate
pip install <dependencies name>
pip3 freeze > requirements.txt

结合 pipreqs 和 pip-tools 生成 requirements.txt

pip3 install pipreqs
pip3 install pip-tools
pipreqs --savepath=requirements.in && pip-compile

最佳实践

• 使用虚拟环境：避免全局环境中的无关依赖被包含在 requirements.txt 中。
• 定期更新 requirements.txt：在添加或删除依赖时，及时更新该文件。
• 使用固定版本号：确保项目在不同环境中的一致性。

常见问题

pipreqs 生成的文件不完整

可能是由于项目中存在编码问题或某些依赖未被正确识别。可尝试指定编码或手动检查并添加缺失的依赖。

pip freeze 包含了无关依赖

可使用虚拟环境，只在虚拟环境中安装项目所需的依赖，然后生成 requirements.txt。

pipreqs 和 pip-tools 结合使用时在 Windows PowerShell 中报错

可使用 ( pipreqs --savepath=requirements.in ) -and (pip-compile) 替代。