pyinstaller 打包包含数据的程序

前言

pyinstaller 是用于将python脚本打包成可执行文件的工具.支持linux和windows等各种平台.
然而使用的时候,难免会遇到脚本直接运行正常,打包运行各种路径报错或者找不到文件的情况.

这篇文章主要讨论当工程需要用到非python文件数据时,如何进行打包的问题.

问题场景的例子1:

工程下有main.py和table.json.
当main.py运行时,首先读取自己所在目录下的table.json文件,然后进行相应动作.
将main.py使用pyinstaller默认指令直接打包,会得到一个main.exe文件.
则当main.exe文件运行时,仍然需要读取所在目录下的table.json文件.
导致程序发布时,需要main.exe和table.json同时发给用户.

例子1有一个比较粗暴的解决方案,即将table.json中的json格式转换成python的dict格式,保存为table.py,在main.py运行时import进行使用.

问题场景例子2:

PyQt5的工程,使用到MainWindow.ui
工程下有main.py和MainWindow.ui.
.ui文件是QtDesigner生成的XML格式的界面描述文件
同样在程序运行开始时需要找到MainWindow.ui文件后,作为参数传给相应的API.

例子2相对与例子1便无法很快捷地用粗暴的方法解决.

Pyinstaller : Add File to Bundle

好在pyinstaller官网给出了相应的高效解决方案.
a. 修改.spec文件
b. 追加命令

这里只说明方式b. 对方式a感兴趣的可以自己去看官网.
对于例子2,打包命令为:

pyinstaller -F --add-data "MainWindow.ui:." main.py

pyinstaller 对 --add-data 的命令的解释为:

–add-data < SRC;DEST or SRC:DEST >
Additional non-binary files or folders to be added to the executable. The path separator is platform specific, os.pathsep (which is ; on Windows and : on most unix systems) is used. This option can be used multiple times.

即第一个参数SRC是要导入的数据,第二个参数DEST是导入的参数在运行时相对主程序的路径.
在windows下用; 分割,在linux下用: 分割.

实际案例

一个PyQt5的网络调试助手工程
包含三个主要文件:
- main.py
- netassistant.py
- netassistant.ui

用pyinstaller打包后,一直报错,找不到/tmp/xxxx/netassistant.uic文件.
用加入上述参数后打包,仍然无法找到.

查看源码:

uiname = uiname.replace('.py', '.ui')

原作者的意思应该是想搜索和netassistant.py同名的,以.ui为后缀的ui文件.
在该操作前加入

print(uiname)

直接跑脚本输出的是: netassistant.py
打包后输出的是: netassistant.pyc
而netassistant.pyc经过上面的函数操作后,就变成了netassistant.uic,所以找不到对应的文件.
将函数改成:

uiname = uiname.split('.')[0] + '.ui'

加入--add-data参数,打包后成功运行.