展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > Python中Pipreqs自动生成项目依赖清单的实现

Python中Pipreqs自动生成项目依赖清单的实现

pipreqs工具通过扫描项目源码中的import语句生成依赖清单,避免像pipfreeze那样导出无关包,确保环境纯净。适用于项目初始化、部署或交接,但无法识别动态导入及配置文件中的依赖,需手动核对并补充缺失项,建议仔细检查。

先聊一个很常见的场景:你写了一个Python项目,准备部署到服务器或者交给同事,需要一份依赖清单。很多人第一反应是 pip freeze > requirements.txt,但这样做往往会埋下隐患。更可靠的做法,其实是换用 pipreqs。

Python中Pipreqs自动生成项目依赖清单的实现

pipreqs 生成 requirements.txt 为什么比 pip freeze 更靠谱

简单来说,pipreqs 的核心理念就是——"只扫自己门前的雪"。它只盯着项目源码里那些实实在在用了 import 语句引入的包,绝不会把整个Python环境里装了一堆但你压根没用的包也塞进清单里。

而 pip freeze 则是典型的"一锅端"。它把当前虚拟环境(甚至全局环境)里所有已安装的包一股脑儿全导出来,不管这些包是项目真正需要的,还是你为了某个调试小工具临时装的。问题就出在这里:等你真正部署上线,或者把项目交接给同事时,经常会出现"这个包根本用不上却报错""那个必需的包又因为冲突卡住"的尴尬情况。这不是代码写错了,而是依赖清单里混了太多"无关人士"。

适用场景很清晰:新项目初始化、把代码交给别人、准备 Docker 镜像构建、提交代码前自查依赖。但也要注意,它不擅长处理那些纯粹的开发依赖,比如 pytest、black 这类工具——默认情况下是会被忽略的,除非你加了额外参数。另外,pipreqs 不解析 setup.py 或 pyproject.toml,它的眼里只有 Python 源文件里实实在在写着的 import 语句。

安装和基础命令怎么跑起来

安装没什么复杂的,但有个细节值得留意:确保安装的是最新版,避免老版本那种路径相关的 bug。直接跑一句:

pip install --upgrade pipreqs

然后,进到你的项目根目录(就是 src/ 目录或者 app.py 等源码所在的那一层),执行:

pipreqs ./

它就会自动扫描目录下所有 .py 文件,然后生成一份清爽的 requirements.txt。如果运行时报错说找不到 requirements.txt,那是因为文件已存在,且被锁住了——删掉再跑一次,或者加个 --force 参数强制覆盖就行。

几个实用的小参数值得记住:

  • --encoding=utf-8:如果你的项目里夹杂了中文注释或路径,不加这个很可能会遇到 UnicodeDecodeError,加它就对了。
  • --diff requirements.txt:想增量更新?用它对比现有的依赖文件,只输出新增的包,适合在持续迭代中精细管理。
  • --sa vepath ./reqs-dev.txt:如果你不想覆盖主文件,比如想把开发依赖单独放一份,就用这个指定输出路径。

怎么让 pipreqs 扫描子目录和识别动态导入

默认情况下,pipreqs 只扫描当前目录及其直接的子目录。如果你的项目结构是 src/mylib/、apps/api/ 这种多层嵌套,就可能漏掉关键依赖。这时候需要显式告诉它该去哪:

pipreqs ./src ./apps --force

但必须承认,pipreqs 在动态导入面前确实无能为力。比如你在代码里用了 __import__(f"{name}_plugin") 或者 importlib.import_module() 这样的字符串拼接式导入,它是完全"看不懂"的。这类依赖,只能老老实实手动补进 requirements.txt。

一些常见的坑点再强调一下:

  • Django 项目里,你在 INSTALLED_APPS 中配置的第三方 app(比如 django-crispy-forms),pipreqs 并不会自动识别过去。为什么?因为它只认 import 语句,不解析配置文件。这类依赖必须你人工核对添加。
  • 如果你用了 setuptools 的 entry_points 或插件机制,同样没戏。
  • 一个实用的建议:执行完 pipreqs 后,不妨再用 grep -r "import\|from.*import" . --include="*.py" 快速扫一遍,看看有没有可疑或遗漏的模块名。

生成结果不准?先检查 import 语句写法

pipreqs 的工作原理决定了它依赖的是"字面量"分析,而不是代码真正的运行时行为。所以某些写法会导致结果"对不上号":

  • 能识别的:import requests as req 没问题,它会认出 requests;import mypkg.utils 也能认出 mypkg。但要注意,它不会深挖 mypkg 内部又依赖了哪些包。
  • 没问题的:相对导入比如 from . import config 或 from ..models import User,只是影响模块查找,不会引入新的第三方包,所以不会有问题。
  • 容易被误解的:像 try: import ujson except ImportError: import json 这种写法,pipreqs 会把 ujson 也识别为依赖,哪怕实际运行走的可能是 json。它不管运行时的逻辑分支,只认代码里写着的 import。

真正容易让 pipreqs "失手"的,其实是那些条件导入加上第三方包的组合。举个例子:

if sys.version_info >= (3, 9):
    from importlib import resources
else:
    import importlib_resources as resources

这种情况下,pipreqs 会忠实地把 importlib_resources 也列进清单。但问题在于,如果你的运行环境已经是 Python 3.9 以上,importlib_resources 这个包根本不会生效。这时候就得你动动手指,把实际没用的那个依赖删掉。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
作者最新文章
编程开发 Python
相关文章 更多
精品专题 更多
装机必备

正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

Windows

正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

PDF教程

正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

macOS软件

正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

IOS软件

正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

AI

正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

Mac软件 更多
WPS Office macOS版
WPS Office macOS版

WPS Office是一款面向macOS用户的综合办公套件,将文字处理、电子表格、演示文稿、PDF工具、模板与云协作整合在同一应用中。它兼容常见Microsoft Office格式,支持Intel及Apple芯片Mac,基础功能可免费使用,

Shapr3D macOS版
Shapr3D macOS版

Shapr3D是一款面向工业设计、机械工程、建筑概念和三维打印工作流的CAD软件。Mac版采用Parasolid建模内核,支持草图约束、实体建模、工程图、可视化渲染及常见CAD格式交换,并可通过账户在多台设备之间同步项目。

REAPER macOS版
REAPER macOS版

REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

Ableton Live macOS版
Ableton Live macOS版

Ableton Live 是面向音乐制作人与现场表演者的数字音频工作站,提供编曲视图、独具特色的现场视图、音频录制、MIDI创作、实时变速、乐器及效果器。Mac版原生支持Apple芯片,并可连接音频接口、MIDI控制器和第三方插件。

Adobe After Effects macOS版
Adobe After Effects macOS版

Adobe After Effects 是面向动态图形、影视特效与视频合成的专业创作软件。它提供关键帧动画、遮罩抠像、运动跟踪、三维空间、文字动画和表达式等工具,并可与 Premiere Pro、Photoshop、Illustrator

Adobe Audition macOS版
Adobe Audition macOS版

Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

Adobe Bridge macOS版
Adobe Bridge macOS版

Adobe Bridge 是面向摄影师、设计师及内容团队的免费数字资产管理工具,可集中预览照片、视频和 Adobe 项目文件,并利用评级、标签、关键词、元数据、筛选与收藏集完成分类检索。它还支持批量重命名、格式导出、相机导入及 Camera

Adobe Illustrator macOS版
Adobe Illustrator macOS版

Adobe Illustrator 是 Adobe 推出的专业矢量图形设计软件,适合在 Mac 上制作标志、图标、插画、包装、信息图及印刷版面。它以路径和锚点构建可无损缩放的图形,并提供钢笔、形状、文字、图像描摹、渐变、画板及生成式功能。

Adobe InDesign macOS版
Adobe InDesign macOS版

Adobe InDesign 是面向印刷品与数字出版物的专业版面设计软件,可在 Mac 上制作书籍、杂志、宣传册、海报、报告及交互式文档。它提供精细的文字样式、网格、母版、长文档管理和印前输出能力。

Adobe Lightroom Classic macOS版
Adobe Lightroom Classic macOS版

Adobe Lightroom Classic 是面向桌面摄影工作流的照片管理与后期处理软件,可将原始照片保存在本地硬盘,通过目录、关键词、评分和收藏夹高效整理图库,并提供 RAW 冲印、蒙版、镜头校正、批量同步及多格式导出等功能。

Adobe Media Encoder macOS版
Adobe Media Encoder macOS版

Adobe Media Encoder 是 Adobe 推出的专业音视频编码与转码工具,可通过队列、预设和监视文件夹批量完成格式转换、代理文件创建及多平台成片输出,并与 Premiere Pro、After Effects 等软件紧密协作。

Adobe Photoshop macOS版
Adobe Photoshop macOS版

Adobe Photoshop 是面向摄影师、设计师和内容创作者的专业图像处理软件,提供图层、蒙版、选区、修复、调色、文字排版、智能对象及生成式编辑等能力。Mac 版支持 Intel 与 Apple Silicon 处理器。

WINDOWS 更多
Adobe InDesign Windows版
Adobe InDesign Windows版

Adobe InDesign 是面向印刷与数字出版的专业页面排版工具,可制作书籍、杂志、宣传册、海报、交互式 PDF 和电子书。它提供精细的文字样式、多页面管理、印前检查及多格式输出能力,并能与 Photoshop、Illustrator

Adobe Illustrator Windows版
Adobe Illustrator Windows版

Adobe Illustrator 是用于绘制矢量图形、插画、图标、徽标和版式的专业设计工具。它以路径和锚点为核心,作品放大后仍能保持清晰,并提供画板、文字、渐变、图像描摹及精确变换等功能,适合品牌视觉、印刷物料、数字界面和商业插画创作。

Adobe Bridge Windows版
Adobe Bridge Windows版

Adobe Bridge 是 Adobe 推出的创意资产管理工具,可集中预览、分类和查找照片、视频、PDF及多种设计文件,并支持元数据、关键词、评级、批量重命名和格式导出。它可与 Photoshop、Illustrator 等应用衔接,

Affinity Photo Windows版
Affinity Photo Windows版

Affinity Photo 是一款面向摄影师、修图师和视觉设计人员的桌面图像编辑工具,提供 RAW 显影、多图层合成、蒙版、实时滤镜、批处理和色彩管理等功能。原独立产品已停止销售,其照片编辑能力已延续至免费的新 Affinity 应用;

Adobe Lightroom Classic Windows版
Adobe Lightroom Classic Windows版

Adobe Lightroom Classic 是面向 Windows 桌面摄影工作流的照片管理与无损编辑工具,可通过目录集中整理大型图库,并完成 RAW 显影、局部蒙版、批量调整、打印和多格式导出。它强调本地文件管理与精细控制,

Figma Windows版
Figma Windows版

Figma 是面向产品设计与开发团队的云端协作平台,可在 Windows 桌面客户端中完成界面绘制、组件管理、交互原型、评论评审和开发交付。文件保存在云端,多名成员能够同步编辑并共享设计系统;官方同时提供免费 Starter 方案及按席位计

Affinity Designer Windows版
Affinity Designer Windows版

Affinity Designer 是面向矢量图形、数字插画和界面设计的专业创作工具,可在矢量、像素与导出工作区之间快速切换。它提供曲线编辑、形状构建、画板、排版、图层和专业色彩管理,并支持常见设计文件的导入及多种印刷、网页格式输出。

Capture One Pro Windows版
Capture One Pro Windows版

Capture One Pro 是面向摄影师和影像团队的专业桌面照片处理工具,提供相机定制色彩配置、RAW转换、图层与蒙版、联机拍摄、目录及会话管理等功能。它适合棚拍、人像、商业产品、婚礼和风光摄影,

Adobe Acrobat Pro Windows版
Adobe Acrobat Pro Windows版

Adobe Acrobat Pro 是面向专业 PDF 工作的综合解决方案,可在 Windows 中创建、编辑、转换、比较、整理和保护文档,并支持表单、电子签名、扫描件文字识别及敏感信息永久遮盖。订阅还包含网页、移动服务和云端协作能力,

Adobe After Effects Windows版
Adobe After Effects Windows版

Adobe After Effects 是面向动态图形、动画与影视视觉特效制作的专业工具,可完成关键帧动画、图层合成、遮罩跟踪、抠像、文字动画和二维三维元素整合。Windows 版通过 Adobe Creative Cloud 安装及更新,

DaVinci Resolve Windows版
DaVinci Resolve Windows版

DaVinci Resolve是Blackmagic Design推出的一体化影视后期工具,将素材管理、非线性剪辑、专业调色、Fusion视觉特效、Fairlight音频处理和成片交付整合在统一工程中。免费版已覆盖多数个人创作需求,

Adobe Media Encoder Windows版
Adobe Media Encoder Windows版

Adobe Media Encoder 是 Adobe 面向视频与音频制作流程提供的专业编码和转码工具,可批量处理媒体文件、创建代理、套用输出预设并监控文件夹自动执行任务。它与 Premiere、After Effects、Audition