PyQt5：pyinstaller发布过程中的一些问题

问题：当我们使用PyQt5编写好界面程序后，需要发布该程序，使其成为可执行文件，此时我们可以借用pyinstaller来完成，本文记述这个过程中笔者所遇到的一些问题，希望能对他人有一定的借鉴意义。

 
 

1、程序发布

 这里，我有一个使用QtDesigner设计的.ui文件（myMainWindow.ui）和一个在此基础上进行逻辑设计的.py文件（mainWindow.py），在.py文件中使用“uic.loadUi()”来对.ui文件动态调用；另外，界面程序中使用的图片文件在“icon/”文件夹中。如下图：

 我们需要使用pyinstaller对该程序进行发布，方法如下：
  pyinstaller …/GUI_for_distribution/mainWindow.py --hidden-import PyQt5.QtXml
 注意，这里使用–hidden-import来导入PyQt5.QtXml，是因为这个库需要动态导入，pyinstaller无法解析出来需要动态导入的内容，因此这里额外添加一下；这里可以参考白夜黑羽的教程，关于为何需要用到这个库，是因为我们的.ui文件是利用uic.loadUi()来动态导入的，.ui文件本质上就是XML文件。
 类似地，如果在发布程序后出现无法找到部分库的现象，也可以使用–hidden-import来额外添加（该命令可以多次使用）；另外，程序中的资源文件（ui文件、图片、视频等）由于也是动态导入的，所以需要在程序发布后，讲对应资源文件与可执行文件放到同一目录下。
 运行后，我们得到了如下内容，其中build中是了一些日志文件、工作文件等，包括.txt的warn文件；dist是发布后的程序，里面有可执行文件（.exe）；xxx.spec是打包时的相关命令和信息，我们可以通过对其内容进行修改，并使用pyinstaller xxx.spec命令来进行新一次的打包（而不需再使用上面长长的命令）

 此时，打开dist下新发布程序的文件夹，里面可以看到我们的可执行程序，如下：

 
 

2、ImportError: DLL load failed: 找不到指定的程序

 理论上，我们只需要把资源文件放到上述.exe目录下，就可以正常运行程序。但是我实际操作时遇到了Bug，双击.exe程序打开之后出现了闪退现象。这时，我们通过将该.exe程序拖动到cmd中，可以查看报错信息：

 关于这种报错的排查，可以去看build中的warn.txt文件，以及运行pyinstaller命令时的WARNING信息，不过也不一定适用于所有情况。我这里报错的原因，经过排查，是因为使用了第三方库“qdarkstyle”（该库是用于PyQt/PySide的样式库，提供Dark风格）。若不使用该库，则程序不报错。另外，奇怪的是，使用该库后，报错的“line 1”并不是调用该库的地方，而是调用PyQt5相关库函数的位置：

 经过漫长的试错和排查，终于找到了解决办法。在这篇博客中指出：“在使用QDarkStyleSheet后，PyInstaller生成exe时会将PyQt4的相关文件打包，导致exe文件不能正常运行，故需要在spec文件中添加excludes=[‘PyQt4’]”。
 而我通过试验，发现我这里需要排除掉“PySide2”包，具体方式可以按上述所说更改.spec文件，然后pyinstaller .spec：

 也可以通过–exclude-module命令完成。

 经过上述操作，就解决了DLL缺失的报错问题。讲真，这个错误真的有点棘手,
 
 

3、FileNotFoundError: [Errno 2] No such file or directory: ‘xxx.ui’

 解决上述问题后，还有一个新的问题：

 奇怪的是，我已经把“myMainWindow.ui”放到该目录下了，如下：

 关于这个问题，我现在并不知道原因，不过我目前有两种办法来解决这个问题。

3.1 PyUIC

 也就是 “不动态调用.ui文件，而把.ui转换为.py文件并调用”
 具体方法是，使用PyUIC工具把.ui文件转换为.py文件，然后在主程序中对其调用（代替之前的动态调用）即可：



 这里也可以不使用继承的方式，而是在类中定义新对象：（如果采用这种方式，类中对应控件的调用格式应为"self.ui.xxx”，也就是多个".ui”。）

    self.ui = Ui_MainWindow()
    self.ui.setupUi(self)

 另外，由于使用这个方法后，.ui文件不再是动态导入方式了，所以不需要“–hidden-import PyQt5.QtXml"命令了。
 

3.2、–add-data

 另一种方法是，在pyinstaller时使用”–add-data"参数来添加.ui文件，这种策略更为简单，不需要转换.ui文件为.py文件，不需要“–hidden-import PyQt5.QtXml"命令，也不需要再将.ui文件复制到exe文件所在目录，只需要添加命令“–add-data="…/GUI_for_distribution/myMainWindow.ui;."”即可。（此外，一些博客中还根据Run-time Information添加了额外程序，经过测试我这里不需要该步骤，所以不再介绍）

 而且，类似地，可以把资源文件一次性导入进来，导入后所有图片等文件会和.exe在同一目录下（不过这样会有点乱哈）：


 
 

4、最终效果

 完成上述的debug工作后，终于实现了界面程序的发布，讲图片等资源文件复制到.exe所在目录下，打开.exe即可运行。另外，为了不显示命令行，需要在pyinstaller中加入"–noconsole”参数：
 pyinstaller …/GUI_for_distribution/mainWindow.py --exclude-module PySide2 --noconsole

 
 

5、添加程序图标

 pyinstaller可以方便地为所发布的程序添加图标，方法是使用 -i 参数来添加.ico文件：

 关于ico文件，可以用python中的PythonMagick库来制作（https://www.lfd.uci.edu/~gohlke/pythonlibs/#pythonmagick），但为了制作多尺寸ico文件（若ico为单尺寸，将程序图标放大或缩小时将无法显示），建议使用专业的网站工具，如：https://www.aconvert.com/icon/：

 最终结果如下，可以看到使用多尺寸ico文件后，图标大小可以进行变化：

欢迎交流~