labelImg二次开发、打包exe

        笔者由于工作需要，对labelImg标注工具进行二次开发，加入视频格式转换、视频分帧等功能，并打包为exe可执行文件，过程记录如下。

 

一、二次开发过程记录

（一）labelImg开发环境搭建 Win10+Anaconda3

1. github上下载labelImg：https://github.com/tzutalin/labelImg

2. 命令提示符下创建虚机环境并激活

conda create -n labelimg python=3.6
activate labelimg

若命令提示符创建虚拟环境失败，可在 Anaconda Navigator 中 创建虚拟环境

3. 安装 PyQt5 和 lxml

百度搜索 PyQt5 pypi，下载 whl

 

命令提示符下 激活 labelimg 虚拟环境，pip 安装PyQt5:

pip install PyQt5-5.15.1-5.15.1-cp35.cp36.cp37.cp38.cp39-none-win_amd64.whl

lxml 安装同理。

编译生成 resources.py 

pyrcc5 -o libs/resources.py resources.qrc

4. 安装 opencv-python 

labelImg 只需要安装 PyQt5 和 lxml 两个依赖包，但是笔者二次开发加入的功能还需要 opencv-python。

命令提示符下 激活 labelimg 虚拟环境，pip 在线安装opencv-python。

pip install opencv-python -i https://mirrors.ustc.edu.cn/pypi/web/simple

 

（二）加入视频分帧功能

笔者对PyQt5并没有学习经验，项目催得紧，只能边摸索边二次开发。

labelImg软件上部有菜单栏，左侧有常用工具栏，右侧有信息显示，软件复杂度相对于笔者而言确实很高。

因此考虑最简单的办法就是在菜单栏新加一个“Trans”菜单，该菜单包含“Separate Frame”和“Transform Video”等功能。新增功能和labelImg原始功能没有任何交互，各自独立运行。

经过对代码的初步分析，发现代码最主要的功能函数都在 labelImg.py 中，其依赖函数在 libs 文件夹下。

菜单栏的四个菜单分别为“File”、“Edit”、“View”、“Help”，则代码中必有对应。通过查找发现在 labelImg.py 273行附近

菜单栏使用结构体定义的，笔者抱着试试的态度，在结构体中加入了一行如下：

运行 labelImg.py ，菜单栏中果然多出了一个“Trans”菜单，笔者顿时信心大增。

有了菜单，那菜单怎么和菜单里的功能按键联系在一起的呢？

通过“Help”菜单的研究，发现“Help”菜单和菜单内的“Tutorial”、“Information”两个功能是通过  labelImg.py 401行的代码实现的。

笔者试着给菜单“Trans”也加入和“Help”菜单一样的功能

运行 labelImg.py ，Trans”菜单下果然多出了两个和“Help”菜单一样的按钮，笔者内心狂喜。

接下来就要看看，addActions(self.menus.trans, (help, showInfo)) 中的“help”与“showInfo”是如何定义的了，通过查找发现 “help”与“showInfo”定义如下：

通过对 action 的查找，发现 action 是由 partial 定义的偏函数，而被 partial 扩展的函数 newAction 定义在 libs/utils.py 中

通过分析大概能了解到，addActions(self.menus.trans, (help, showInfo)) 中的“help”与“showInfo” 是通过 action 定义的，其关联 labelImg.py 中的 showTutorialDialog 函数 与 showInfoDialog 函数。

到目前为止，labelImg菜单运行的内部逻辑大致捋清楚了，

• 菜单栏定义在  self.menus 结构体中，
• 菜单栏中的某个菜单如“Help”与其下的功能按钮通过 addActions() 关联到“help”与“ showInfo”两个功能，
• “ showInfo”这种具体的功能按键通过 action() 定义，
• action() 定义按钮显示在软件中的字符串，并指向功能按钮最终的功能实现子函数，如“ showInfo”指向  showInfoDialog 函数

通过上述逻辑，虽然笔者对 self.menus 为什么这样定义，以及 addActions()、 action() 的具体构成并不清楚，但是并不影响笔者对 labelImg 的二次开发。

笔者先定义 分帧功能实现的子函数：separateFrameDialog() 

再通过 action() 定义功能按键 separateFrame，显示字符串为：“Separate Frame”，并指向函数 separateFrameDialog() 

将功能按键 separateFrame 关联到 “Trans” 菜单。

同理加入视频格式转换按钮“transformVideo”

最后界面运行结果如下

 

二、打包为exe可执行软件

1. 安装 pyinstaller 包

命令提示符下 激活 labelimg 虚拟环境，pip 在线安装 pyinstaller。

pip install pyinstaller

2. pyinstaller 打包

命令提示符下 使用cd进入 labelImg.py 文件所在目录

打包

pyinstaller -F -w labelImg.py

完成后会在 dist 文件夹下生成 exe 文件

第一次运行exe报错，提示缺少 mkl 依赖，同样在 pypi 中下载 mkl 离线安装包，pip安装即可

删除 build 和 dist 两个文件夹，重新打包，即可正常运行.

 

20210106更新：使用 pyinstaller 将依赖文件打包到exe的处理方法

参考连接：https://www.cnblogs.com/stigerzergold/p/9601319.html

笔者在后续往软件中添加功能的时候，需要一个命名为 Empty.xml 的依赖文件，再直接用 pyinstaller -F -w labelImg.py 命令打包就不好使了，解决办法如下：

首先将使用 Empty.xml 的代码段由

Label2 = xml.dom.minidom.parse("Empty.xml")

改为

path = os.path.dirname(os.path.abspath(__file__))
Label2 = xml.dom.minidom.parse(os.path.join(path, "Empty.xml"))

加入的一行代码是获取此python文件的目录（打包前是此文件目录，打包后就是程序运行时的临时目录）

命令提示符下 使用cd进入 labelImg.py 文件所在目录，打包

pyinstaller -F -w labelImg.py

编辑打包生成的spec文件（labelImg.spec）

在 datas 中添加信息如下：

datas=[("libs/Empty.xml", "libs")],

将要打包到exe中的依赖文件按照如图的元组格式放入到datas结构中，元组内的第一个字符串表示此文件相对于labelImg.py的位置，同目录的话就“Empty.xml”即可，如果Empty.xml是在libs文件夹内，那么这个字符串就是“libs/Empty.xml"(斜杠应该不分方向，自己试一下）,第二个字符串就是程序实际运行时你要找这个文件的位置，程序在运行时会在系统内部生成一个临时目录，"."表示就在此临时目录下找这个文件，如果要在临时目录下的libs文件夹内找，则第二个字符串就是"libs"即可。

.spec 打包

pyinstaller -F -w labelImg.spec

大功告成！