自动生成 Python 项目依赖文件 requirements.txt

自动生成 Python 项目依赖文件 requirements.txt 的方法详解

在开发 Python 项目时，管理项目的依赖项是非常重要的。通常我们会使用 pip freeze > requirements.txt 来导出当前环境的所有依赖包及其版本。但如果你希望更精确地生成只包含项目实际使用的依赖，或者希望通过 Web 接口动态生成该文件，本文将为你详细介绍几种实用的方法。

📦 方法一：使用 pip freeze 导出所有已安装包

这是最基础也是最常见的方法，适用于快速导出当前 Python 环境中所有已安装的包及其版本信息。

pip freeze > requirements.txt

这行命令会将当前环境中所有的依赖包写入到 requirements.txt 文件中。

⚠️ 注意：这种方法会包含所有已安装的包，可能包含项目并未实际使用的库。

🧹 方法二：使用 pipreqs 只导出项目实际使用的依赖

如果你希望只导出项目中实际用到的依赖包，推荐使用 pipreqs 工具。

安装 pipreqs：

pip install pipreqs

在项目根目录下运行：

pipreqs . --encoding=utf8 --force

• . 表示当前目录。
• --encoding=utf8 设置编码格式。
• --force 强制覆盖已存在的 requirements.txt 文件。

✅ 优点：只包含项目中实际 import 的模块，避免冗余依赖。

🌐 方法三：在 Flask 应用中添加接口自动生成 requirements.txt

如果你正在开发一个 Flask 项目，并希望提供一个 API 接口供用户下载最新的依赖文件，可以如下实现：

示例代码：

from flask import Flask, send_file, jsonify
import subprocess

app = Flask(__name__)

@app.route('/generate_requirements')
def generate_requirements():
    try:
        # 生成 requirements.txt 文件
        with open('requirements.txt', 'w') as f:
            subprocess.run(['pip', 'freeze'], stdout=f)
        # 返回文件给用户
        return send_file('requirements.txt', as_attachment=True)
    except Exception as e:
        return jsonify({'error': str(e)}), 500

if __name__ == '__main__':
    app.run(debug=True)

访问 /generate_requirements 路由后，系统会自动生成并返回当前环境下的 requirements.txt 文件。

🔒 提示：建议在生产环境中关闭 debug 模式，并增加权限校验逻辑以确保安全性。

✅ 总结

根据你的项目需求选择合适的方式来生成 requirements.txt，可以有效提升依赖管理的准确性和可维护性。