python 程序打包之 pyInstaller

工具

pyinstaller: windows 上打包python程序为 exe 的工具

安装

1. 支持 python 版本
   python3.5

2. pip install pyinstaller

3. 验证安装结果
   pyinstaller main.py

pyinstaller 如何工作的

1. 单命令
   PyInstaller analyzes myscript.py
   Writes myscript.spec in the same folder as the script.
   Creates a folder build in the same folder as the script if it does not exist.
   Writes some log files and working files in the build folder.
   Creates a folder dist in the same folder as the script if it does not exist.
   Writes the myscript executable folder in the dist folder.

2. 生成的文件目录

• main.spec

!(使用 .spec)(https://pythonhosted.org/PyInstaller/spec-files.html#using-spec-files)

• build/
  放着过程文件

• dist/
  存放生成的可执行文件

使用

常用命令选项

1. 指定dist 路径
   --distpath DIR

2. 指定工作路径
   --workpath WORKPATH

3. 无询问覆盖
   -y

4. 清除缓存文件
   --clean

5. 日志等级
   --log-level LEVEL

DEBUG, INFO, WARN, ERROR, CRITICAL (default: INFO).

生成选项

1. 目录输出
   -D, --onedir Create a one-folder bundle containing an executable (default)

2. 单文件输出： 打包把依赖打包进可执行文件
   -F, --onefile Create a one-file bundled executable.

3. .spec 文件输出路径
   --specpath DIR Folder to store the generated spec file (default: current directory)

4. 命名输出文件名，默认为第一个文件名
   -n NAME, --name NAME
   Name to assign to the bundled app and spec file (default: first script’s basename)

指定输入相关

1. 指定搜索路径，用 :分割多个路径
   -p DIR, --paths DIR
   A path to search for imports (like using PYTHONPATH). Multiple paths are allowed, separated by ‘:’, or use this option multiple times

2. 指定未在代码中线性import 的模块
   --hidden-import MODULENAME, --hiddenimport MODULENAME
   Name an import not visible in the code of the script(s). This option can be used multiple times.

3. hook 搜索路径
   --additional-hooks-dir HOOKSPATH
   An additional path to search for hooks. This option can be used multiple times.
   --runtime-hook RUNTIME_HOOKS
   Path to a custom runtime hook file. A runtime hook is code that is bundled with the executable and is executed before any other code or module to set up special features of the runtime environment. This option can be used multiple times.

4. 指定不打包的模块
   --exclude-module EXCLUDES
   Optional module or package (his Python names, not path names) that will be ignored (as though it was not found). This option can be used multiple times.

5. 加密，密钥
   --key KEY The key used to encrypt Python bytecode.

windows 独有命令

1. 打开一个命令行窗口接收 输入输出，是默认选项
   -c, --console, --nowindowed
   Open a console window for standard i/o (default)

2. 不显示命令行窗口 —— 一般 gui 程序选择 -w ，则不显示 命令行窗口
   -w, --windowed, --noconsole

3. 指定应用图标
   -i , --icon

4. 添加exe 资源文件
   --version-file FILE
   add a version resource from FILE to the exe
   -m , --manifest
   add manifest FILE or XML to the exe
   -r RESOURCE, --resource RESOURCE
   Add or update a resource to a Windows executable. The RESOURCE is one to four items, FILE[,TYPE[,NAME[,LANGUAGE]]]. FILE can be a data file or an exe/dll. For data files, at least TYPE and NAME must be specified. LANGUAGE defaults to 0 or may be specified as wildcard * to update all resources of the given TYPE and NAME. For exe/dll files, all resources from FILE will be added/updated to the final executable if TYPE, NAME and LANGUAGE are omitted or specified as wildcard *.This option can be used multiple times.

5. 要求 uac 权限
   --uac-admin Using this option creates a Manifest which will request elevation upon application restart.
   --uac-uiaccess Using this option allows an elevated application to work with Remote Desktop.

打包脚本, 保存未 .bat 文件

pyinstaller -F ^
-n ilifeparser --distpath output -y --clean main.py
或
pyinstaller -F ^
-n ilifeparser --distpath output -y --clean main.spec

spec 文件

TODO

坑与解决方法

1. 打包 pyqt 遇到的插件缺失，运行错误

WARNING: lib not found: Qt5Svg.dll...
WARNING: lib not found: xxx.dll...
运行打包后的程序，提示 “缺少 pyi_rth_qt5plugins ”
问题原因是：pyinstaller 找不到程序依赖的 pyqt dll
解决方法： 1. 用 --path 指定pyqt bin路径。 或者 2. 把路径添加 系统环境变量

pyinstaller -F ^
    --dist output ^
    --windowed ^
    -n pyqt5_demo ^
    --path "C:\Program Files\Python35\Lib\site-packages\PyQt5\Qt\bin"  ^
    .\src\main.py