pipreqs能精准生成requirements.txt,仅基于源码import语句提取依赖,避免pip freeze引入冗余包;支持编码指定、目录忽略、本地包处理及版本约束优化。

用 pipreqs 生成更精准的 requirements.txt
直接 pip freeze > requirements.txt 会把所有全局或虚拟环境中已安装的包都写进去,包括开发依赖、临时调试包,甚至系统工具包。结果是文件臃肿、部署失败率高。
pipreqs 是更靠谱的选择——它只扫描项目源码里的 import 语句,按实际引用关系生成依赖列表。
- 先装:
pip install pipreqs - 在项目根目录运行:
pipreqs . --encoding=utf8 --force -
--encoding=utf8防止中文路径或注释报错;--force覆盖已有requirements.txt - 如果提示
UnicodeDecodeError,说明某 py 文件编码不是 UTF-8,可加--encoding=gbk尝试(Windows 下常见)
排除测试/开发用包:用 --ignore 参数
默认情况下 pipreqs 会扫描所有 .py 文件,包括 tests/ 或 scripts/ 目录下的脚本,可能误引入 pytest、black 这类非运行时依赖。
- 跳过指定目录:
pipreqs . --ignore=tests,scripts,examples - 也可以忽略单个文件:
--ignore=test_main.py - 注意:路径名必须和文件系统中完全一致(区分大小写,不带斜杠结尾)
处理相对导入和本地包:--include-local 和 --use-local
如果你的项目结构含本地子包(比如 from mylib.utils import helper),pipreqs 默认不会识别这种相对导入,也不会把 mylib 写进 requirements.txt——因为它不是 PyPI 包。
立即学习“Python免费学习笔记(深入)”;
- 想让
pipreqs把本地包也列出来(供后续pip install -e .使用):--include-local - 想跳过本地包、只保留第三方包:
--use-local(但需确保当前环境已安装对应本地包,否则会漏依赖) - 更稳妥的做法是:先用
pipreqs生成基础列表,再手动补上-e ./mylib这类行
生成后别直接上线:检查版本约束是否合理
pipreqs 默认只写包名,不带版本号(如 requests),这看似灵活,实则埋雷——下次重装可能拉到不兼容新版。
- 加
--save-all可强制写死当前环境中的版本号(类似pip freeze的行为,但范围仍限于扫描到的包) - 更推荐手动加约束:比如把
requests改成requests>=2.25.0,,兼顾兼容性与可控性 - 特别注意
numpy、pandas、torch这类底层库,小版本升级也可能破坏 ABI
真正难的不是生成文件,而是判断哪些包该锁死、哪些该放宽、哪些根本不该出现在 runtime 依赖里——得看代码里到底怎么用的。


















