Python自动识别并生成requirements.txt依赖文件的命令与排错方法

自动化生成依赖清单的需求

在迁移历史 Python 项目或重构代码库时，手动核对并逐个安装第三方模块极易遗漏且效率低下。通过自动化扫描项目源码中的 import 语句，可以直接提取出当前使用的第三方包名称及对应版本，生成符合规范的 requirements.txt 文件，从而大幅降低环境搭建与协作成本。

准备工作

本方案基于 Python 3 环境，核心依赖为 pipreqs 第三方工具。该工具采用静态分析模式，会遍历指定目录下的 .py 文件，过滤掉标准库后输出外部依赖列表。

操作指南

第1步：安装 pipreqs 解析工具

目的：获取用于静态扫描 Python 项目的命令行工具。
入口：系统终端或集成开发环境的控制台。
动作：执行 Python 包管理器安装指令。

pip3 install pipreqs

重要参数：默认将软件拉取至当前激活的 Python 虚拟环境或系统环境中。安装完成后，可通过 `pipreqs --version` 确认是否生效。
可观察的完成状态：终端返回 Successfully installed xxx 字样即表示就绪。

第2步：执行目录扫描并生成文件

目的：读取项目结构，自动编写依赖清单。
入口：终端中使用 cd 命令切换至目标项目根目录。
动作：直接运行无参命令，或将绝对路径作为参数传入。

pipreqs /你的项目目录路径

重要参数：若不传路径，默认扫描当前工作目录。若需排除特定子文件夹（如 tests 或 docs），可在后续版本结合 exclude 参数使用。
可观察的完成状态：若未配置额外参数，工具会在执行位置自动生成名为 requirements.txt 的配置文件。生成内容格式为“包名==版本号”，仅包含该项目实际引用的外部库，例如：

elasticsearch==7.16.2
Flask==2.0.1
requests==2.27.1

网络连接超时排错

在完成基础扫描时，部分企业网段或个人路由可能会因拦截策略触发连接失败，控制台常抛出如下 traceback：

requests.exceptions.ConnectionError: HTTPSConnectionPool(host='pypi.python.org', port=443): Max retries exceeded with url: /pypi/elasticsearch/json (Caused by NewConnectionError(... : Failed to establish a new connection: [Errno 110] Connection timed out'))

该错误表明工具在尝试向官方 PyPI 仓库校验包元数据时发生阻断。此时无需重新安装，只需显式声明国内镜像服务器即可恢复。

修复操作

目的：绕过官方源直连限制，使用稳定镜像加速下载校验。
入口：同一终端界面。
动作：追加 --pypi-server 参数指向备用地址，并附带目标路径。

pipreqs --pypi-server https://pypi.tuna.tsinghua.edu.cn/simple /你的项目目录路径

关键配置说明：将上述 URL 替换为阿里云、中科大或其他国内 PyPI 镜像的地址均可。参数生效后，pipreqs 会在相同的解析逻辑下快速拉取包信息并完成写入，报错随之消失。

生成结果核验

命令执行完毕后，建议使用文本编辑器打开生成的 requirements.txt。重点核对以下两点：第一，列表中是否存在明显不属于业务功能的缓存包或残留库；第二，版本号（== 后的数字）是否与预期环境保持一致。确认后，即可配合 `pip install -r requirements.txt` 实现一键还原。

简要总结

以上就是 Python 自动生成 requirements.txt 依赖文件的详细内容，更多关于 Python 环境迁移与自动化配置的资料请关注本站其它相关文章！