(本文4000字左右,阅读时间约为13min,已经过AI润色,排版由wechat-publisher工具自动生成)
上一篇我们完成了工具 GUI 界面的从0到1开发,解决了多线程防卡死、待办任务管理、自动化流程封装等核心问题,工具在我的开发环境里已经能稳定流畅运行。但想要让这个工具真正落地,让全部门不懂代码的同事都能用上,还有最后一公里的路要走 —— 把 Python 脚本变成一个双击就能打开、开箱即用、无任何环境依赖的可执行文件
一、第一次尝试:用 bat 脚本实现免 IDE 启动
最开始,我甚至不知道 Python 代码可以打包成 exe 文件。我和 AI 沟通的需求是「如何不打开 IDE 也能运行 py 脚本」,AI 给我的第一个方案是用 Windows 批处理脚本(.bat),通过脚本激活虚拟环境、执行 Python 文件。
我写的 bat 脚本核心逻辑是这样的:
@echo off:: 关闭命令回显,只输出程序运行结果,避免黑窗口里满屏代码d::: 切换到项目所在的D盘cd D:\Programming\project\gky_tool:: 进入项目根目录call D:\Programming\project\gky_tool\.venv\Scripts\activate.bat:: 调用虚拟环境激活脚本,进入项目专属虚拟环境:: 避免使用系统Python环境(大概率没有安装项目依赖,会直接运行失败)python GUI.py:: 用虚拟环境的Python解释器,执行GUI主程序
写完之后,我给 bat 文件创建了桌面快捷方式,双击就能启动程序,看起来好像成功了。但好景不长,这个方案在公司电脑上频繁出现运行失败的情况,一开始我完全摸不着头脑,后来复盘才找到了几个核心的失败原因:
问题 1:路径与权限 公司办公电脑的用户目录、磁盘权限有严格管控,部分电脑的 D 盘可能无法直接访问 |
问题 2:环境依赖无法迁移 每台电脑都要完整拷贝项目文件夹、配置好虚拟环境,换一台电脑就要重新配置一遍 |
而且这种方式始终不够优雅,不符合 Python 的"教义"
二、转向 exe 打包:用 PyInstaller 实现单文件分发
就在我一筹莫展的时候,我突然反应过来,平时用的很多小工具都是.exe 后缀的可执行文件,能不能把我的 Python 代码也打包成这样的文件?我立刻和 AI 沟通,终于找到了 Python 项目打包的核心工具:PyInstaller
打包的第一步,是先准备一个专属的程序图标。我用 nano banana 画了工具的专属图标,再通过在线图标转换网站,生成了.ico 格式的图标文件,这也是 Windows 可执行文件原生支持的图标格式
最基础的打包命令非常简单,一行就能搞定:
pyinstaller -F GUI.py --noconsole --icon="./ico_image/桌面图标.ico"
这里的每一个参数,都对应着实际的使用需求:
-F:生成单文件可执行程序,会把 Python 解释器、所有第三方依赖、项目代码全部压缩打包到一个 exe 文件里,分发起来最方便,只需要发一个文件就行GUI.py:需要被打包的python脚本文件--noconsole:打包后的程序运行时,不显示控制台黑窗口。对于带 GUI 界面的程序来说,这个参数是必要的,否则每次打开程序都会弹出一个多余的 cmd 黑窗口,非常影响使用体验--icon:指定 exe 文件的专属图标,让工具从默认的 Python 图标,变成有专属标识的正式程序
命令执行完成后,项目目录会生成 3 个核心内容:
- 同名的
.spec配置文件:PyInstaller 的高级打包配置文件 build文件夹:打包过程中的临时文件,打包完成后可以直接删除dist文件夹:里面就是我们打包好的 exe 可执行文件
我拿着打包好的 exe 文件,满心欢喜地双击运行,结果直接给我泼了一盆冷水:程序毫无反应,直接闪退,明明在 IDE 里运行得好好的,打包后就完全不能用了。
三、打包踩坑实录:遇到一个问题,解决一个问题
整个打包过程,就是一个不断踩坑、不断解决问题的过程,每一个坑都是 IDE 里完全不会暴露的,也让我对 Python 程序的运行逻辑有了更深的理解。
坑 1:路径兼容问题,源码正常、exe 直接失效
exe无法打开,我完全不知道程序哪里出了错,然后我才反应过来,打包时加的--noconsole参数,不仅隐藏了黑窗口,也把所有的报错信息都藏起来了
我立刻删掉了之前的打包文件,去掉--noconsole参数重新打包,这次程序运行时,黑窗口里的报错信息终于让我找到了问题根源:路径获取逻辑完全失效了
我之前在代码里,用的是 os.path.dirname(os.path.abspath(__file__)) 来获取项目根路径,这个写法在 IDE 里运行源码时完全没问题,但打包成 exe 后就彻底失效了
核心原因 PyInstaller 打包后的单文件 exe 运行时,会先把所有内容解压到 Windows 的临时目录,再执行程序。此时 __file__ 变量指向的是临时目录里的解压路径,而不是 exe 所在的目录,配置文件、图片资源都在 exe 所在目录,自然就全部找不到了 |
针对这个问题,我和 AI 一起梳理出了兼容源码运行与 exe 打包的通用路径获取方案,通过判断程序的运行模式,自动选择对应的路径获取方式,核心代码如下:
import osimport sysdef get_base_path(): """ 通用获取项目根路径,兼容源码运行与exe打包两种模式 :return: 项目根路径的绝对路径 """ # 判断是否是exe打包运行模式 if getattr(sys, 'frozen', False): # exe模式:获取exe文件所在的目录 return os.path.dirname(sys.executable) # 源码模式:获取当前脚本所在的目录 return os.path.dirname(os.path.abspath(__file__))# 全局基础路径,项目内所有路径都基于这个变量生成BASE_PATH = get_base_path()# 示例:获取配置文件路径,再也不会出现找不到文件的问题CONFIG_PATH = os.path.join(BASE_PATH, 'config', 'config_constant.yaml')IMAGE_PATH = os.path.join(BASE_PATH, 'image')
这个方案彻底解决了路径兼容的问题,不管是在 IDE 里调试源码,还是打包成 exe 后运行,都能精准找到对应的资源文件。如果不是通过打包调试暴露了这个问题,我根本不会意识到这里还有这么深的一个坑
坑 2:静态配置文件不会被自动打包
路径问题解决后,程序终于能正常启动了,但新的问题又来了:程序里的飞机基础信息模块全是空的,所有 yaml、json 格式的配置文件都读取失败
我很快就找到了问题的核心:PyInstaller 只会自动打包 Python 相关的依赖文件,不会主动打包我们自己写的 json、yaml 配置文件、图片资源等静态文件
我用了最简单的解决方案:打包完成后,把项目里的 config、image、data 这些静态资源文件夹,手动完整拷贝到 exe 文件所在的目录里,程序就能正常读取到配置文件了
坑 3:ddddocr 模型文件缺失,验证码识别完全失效
解决了配置文件的问题,程序的界面、待办功能都能正常使用了,可就在测试自动登录的核心功能时,又出了致命问题:验证码识别完全失效,程序报错提示找不到 onnx 模型文件
这就是我们之前埋下的那个隐藏坑,终于在打包环节彻底暴露了。我们用的 ddddocr 验证码识别库,自带 3 个预训练好的 onnx 格式深度学习模型文件,这些模型文件是验证码识别的核心,但它们属于第三方库的静态资源,PyInstaller 同样不会自动把它们打包进 exe 里
这个问题没法靠拷贝文件解决,因为模型文件在 Python 第三方库的安装目录里,普通用户根本找不到,也不会配置。想要彻底解决这个问题,必须用到 PyInstaller 的高级打包配置,也就是我们第一次打包时生成的.spec文件
spec 文件是 PyInstaller 的完整打包配置清单,我们可以在里面手动指定需要打包的额外资源、隐藏导入、打包参数等。针对 ddddocr 的模型文件,我们需要修改 spec 文件里Analysis模块的datas参数,把 3 个模型文件手动添加进去
修改后的完整 spec 文件如下:
a = Analysis( ['GUI.py'], # 项目主程序入口文件 pathex=[], binaries=[], # 核心修改:手动添加需要打包的额外资源文件 datas=[ # 格式:(模型文件在本地的绝对路径, 打包后存放的文件夹名) # 把ddddocr的3个模型文件,打包到exe里的ddddocr文件夹中 (r"D:\Programming\python\my_projects\t\.venv\Lib\site-packages\ddddocr\common.onnx", "ddddocr"), (r"D:\Programming\python\my_projects\t\.venv\Lib\site-packages\ddddocr\common_det.onnx", "ddddocr"), (r"D:\Programming\python\my_projects\t\.venv\Lib\site-packages\ddddocr\common_old.onnx", "ddddocr"), ], hiddenimports=[], hookspath=[], hooksconfig={}, runtime_hooks=[], excludes=[], win_no_prefer_redirects=False, win_private_assemblies=False, noarchive=False,)pyz = PYZ(a.pure)exe = EXE( pyz, a.scripts, a.binaries, a.datas, [], name='工卡员工具箱', # 修改打包后exe文件的名称 debug=False, bootloader_ignore_signals=False, strip=False, upx=True, upx_exclude=[], runtime_tmpdir=None, console=False, # 最终正式版关闭控制台黑窗口 disable_windowed_traceback=False, argv_emulation=False, target_arch=None, codesign_identity=None, entitlements_file=None, icon=['ico_image\\桌面图标.ico'], # 程序图标路径)
这里的datas参数的格式是(本地文件路径, 打包后的文件夹名),PyInstaller 在打包时,会把我们指定的文件完整打包进 exe 里,运行时会自动解压到对应的目录,程序就能正常找到这些模型文件了
配置好 spec 文件后,我们就要用 spec 文件执行打包了:
当控制台里出现completed字样的那一刻,我预感,这次是真的成功了
双击运行 exe 文件,程序正常启动,界面完整加载,配置信息全部读取成功,自动登录、验证码识别的核心功能一次跑通,没有任何报错
就这样,我的工卡员工具箱,终于从一行行代码,变成了一个真正意义上、可分发、可落地的桌面软件 |
四、从能用,到人人能用:落地的最后一步
回顾整个开发过程,有过被代码逻辑绕进去的大脑宕机;有过被环境问题卡好几天的挫败;有过太累干脆好几天不碰代码的摆烂;甚至在最后打包环节,被一个接一个意料之外的坑搞得差点功败垂成
但当我双击 exe,看到程序正常启动的那一刻,没有想象中的狂喜,只有一种「轻舟已过万重山」的释然。这个工具从需求分析、环境搭建、核心逻辑开发、GUI 界面设计,到最后的打包落地,99% 的代码都是我自己一行行敲出来的。AI 从来不是我的代笔,只是我的老师 —— 它给我例子、讲清原理,我自己理解、消化,再把它变成我自己的代码,融入到我的工具里
为了让大家真正用起来,我决定写一篇工具说明书。最开始我想着,要有点程序员的仪式感,写一个正式的 README.md 说明文档,放在项目目录里。但马上我就反应过来,我又脱离实际了:对不懂代码的同事们来说,markdown 格式的文档看着就头大,更别说主动去项目文件夹里找这个文件了
我平时习惯用飞书文档写东西,但公司里飞书被封禁了。我试了一圈工具,惊喜地发现腾讯文档没有被封禁,它的智能文档功能和飞书几乎一模一样,基本能满足我的需求
于是我在腾讯文档里,写了一篇超详细的《工卡员工具箱使用说明书》,从功能介绍、常见问题,到每一个按钮的用法,都配了截图一步步讲清楚。顺带还写了篇工卡员日常工作的操作指南、注意事项,把工具和日常工作完全结合起来,帮助新手/老手快速上手并提高效率
最后,我在工具的 GUI 界面里,加了一个「使用指南」的按钮,点击就能一键打开腾讯文档的链接。后续不管是功能更新,还是操作指南修改,我只需要更新腾讯文档就能全网同步
(点击下方原文链接可查看工卡员工具箱说明书展示版本)