使用PyInstaller打包项目生成exe文件

Python 开发程序往往需要在其他电脑进行测试，如果在每一台测试的电脑上都安装测试环境就显得十分麻烦，因此就需要PyInstaller打包工具将开发程序及其测试环境一起打包，就可以放在任何一台电脑上运行，以下针对PyInstaller打包工具的安装、使用和测试进行总结。

一、PyInstaller打包工具的安装

安装前确认开发项目的环境搭建是否完成：
Python 3.7 +PyQt5+Anaconda3
笔者是在Anaconda搭建的虚拟环境下开发程序的，因此需要先激活虚拟环境，再进行安装：

conda activate pyqt  # 环境名
pip install pyinstaller  

安装成功后在如下目录找到pyinstaller.exe

D:\Anaconda3\env\pyqt\Scripts\pyinstaller.exe

pip install pywin32  # pyinstaller的依赖

二、PyInstaller使用

pyinstaller [opts] yourprogram.py

可选的参数有：

原文连接：https://pyinstaller.readthedocs.io/en/v3.3.1/usage.html

通用参数

参数名	描述	说明
-h	显示帮助	无
-v	显示版本号	无
–distpath	生成文件放在哪里	默认：当前目录的dist文件夹内
–workpath	生成过程中的中间文件放在哪里	默认：当前目录的build文件夹内
-y	如果dist文件夹内已经存在生成文件，则不询问用户，直接覆盖	默认：询问是否覆盖
–upx-dir UPX_DIR	指定upx工具的目录	默认：execution path
-a	不包含unicode支持	默认：尽可能支持unicode
–clean	在本次编译开始时，清空上一次编译生成的各种文件	默认：不清除
–log-level LEVEL	控制编译时pyi打印的信息	一共有6个等级，由低到高分别为TRACE DEBUG INFO(默认) WARN ERROR CRITICAL。也就是默认清空下，不打印TRACE和DEBUG信息

与生成结果有关的参数

参数名	描述	说明
-D	生成one-folder的程序（默认）	生成结果是一个目录，各种第三方依赖、资源和exe同时存储在该目录
-F	生成one-file的程序 生成结果是一个exe文件，所有的第三方依赖、资源和代码均被打包进该exe内
–specpath	指定.spec文件的存储路径 默认：当前目录
-n	生成的.exe文件和.spec的文件名 默认：用户脚本的名称，即main.py和main.spec

指定打包哪些资源代码

参数名	描述	说明
–add-data	打包额外资源	用法：pyinstaller main.py --add-data=src;dest。windows以;分割，linux以:分割
–add-binary	打包额外的代码	用法：同–add-data。与–add-data不同的是，用binary添加的文件，pyi会分析它引用的文件并把它们一同添加进来
-p	指定额外的import路径，类似于使用PYTHONPATH	参见PYTHONPATH
–hidden-import	打包额外py库	pyi在分析过程中，有些import没有正确分析出来，运行时会报import error，这时可以使用该参数
–additional-hooks-dir	指定用户的hook目录	hook用法参见其他，系统hook在PyInstaller\hooks目录下
–runtime-hook	指定用户runtime-hook	如果设置了此参数，则runtime-hook会在运行main.py之前被运行
–exclude-module	需要排除的module	pyi会分析出很多相互关联的库，但是某些库对用户来说是没用的，可以用这个参数排除这些库，有助于减少生成文件的大小
–key	pyi会存储字节码，指定加密字节码的key	16位的字符串

生成参数

参数名	描述	说明
-d	执行生成的main.exe时，会输出pyi的一些log，有助于查错	默认：不输出pyi的log
-s	优化符号表	原文明确表示不建议在windows上使用
–noupx	强制不使用upx	默认：尽可能使用。

其他

参数名	描述	说明
–runtime-tmpdir	指定运行时的临时目录	默认：使用系统临时目录

Windows和Mac特有的参数

参数名	描述	说明
-c	显示命令行窗口	与-w相反，默认含有此参数
-w	不显示命令行窗口	编写GUI程序时使用此参数有用。
-i	为main.exe指定图标	pyinstaller -i beauty.ico main.py

Windows特有的参数

参数名	描述	说明
–version-file	添加版本信息文件	pyinstaller --version-file ver.txt
-m, --manifest	添加manifest文件	pyinstaller -m main.manifest
-r RESOURCE	请参考原文
–uac-admin	请参考原文
–uac-uiaccess	请参考原文

在打包的过程中经常会遇到很多问题，为了能显示问题所在，在测试结束前一般选用以下命令：

Pyinstaller -D -i Myico.ico railway.py

打包过程如下：

打包完毕后，还需把railway.py(项目代码) import的外部文件放到 .\dis\trailway 文件夹下面
下图是笔者项目需导入的文件

遇到的问题：

1. 解决pyinstaller 打包后运行exe程序出现的"ModuleNotFindError"

缺少模块，需要添加hidden-import

pyinstaller -D -i myicon.ico --hidden-import=keras --hidden-import=tensorflow railway.py

2. 解决python PermissionError: [WinError 5]拒绝访问的情况

（1）关闭跟python相关的所有程序，如jupyter，pycharm，Anaconda等等

（2）赋予用户对python的“完全控制”的权限，步骤如下：
找到按照python的位置，本文用的是Anaconda，安装在D盘，位置为：D:\Anaconda3\env\pyqt\python.exe。找到python->右键->属性->安全->点击“组或用户名”中的Users->编辑->点击点击“组或用户名”中的Users->把“完全控制”打钩->应用->OK

三、PyInstaller测试

方法一：

找到.\dist\railway 的railway.exe 文件（以上railway全部为笔者的项目名）双击执行

方法二：

打开终端，cd 进入railway.exe所在的文件夹 直接在终端输入项目名即可（该方法便于查看错误）