[Python进阶] 程序打包之Pyinstaller参数介绍

5.4 Pyinstaller参数介绍

5.4.1 选项参数

参数名 说明
-h、–help 查看Pyinstaller所有命令的用法和帮助
-v、–version 查看当前Pyinstaller版本
–distpath DIR 设置dist位置，默认当前目录
–workpath WORKPATH 设置build位置，默认当前目录
-y、–noconfirm 当存在dist时，不询问，直接覆盖
–upx-dir UPX_DIR 指定upx工具的目录，默认执行路径
-a、–ascii 不包含unicode支持
–clean 打包前先清理缓存和临时文件，重新打包建议加上该命令
–log-level LEVEL 限制打包时在控制台中输出的日志等级。一共有6个等级，由低到高分别为TRACE、DEBUG、INFO(默认)、WARN、ERROR、CRITICAL

5.4.2 生成有关参数

参数名 说明
-D 单文件夹模式，即生成结果是一个目录，各种第三方依赖、资源和可执行程序同时存储在该目录。默认；
-F 单文件模式，即生成结果是一个可执行文件，所有的第三方依赖、资源和代码均被打包进该可执行文件内
–specpath DIR 指定spec文件的生成路径，默认当前目录。
-n、–name NAME 修改生成的可执行文件和spec的文件名。

5.4.3 资源有关参数

参数名 说明
–add-data SRC 要添加到可执行文件中的其他非二进制文件或文件夹。可多次使用。
–add-binary SRC 要添加到可执行文件中的其他二进制文件。可多次使用
-p、–paths DIR 用于搜索导入的路径(如使用PYTHONPATH)。
–hidden-import MODULENAME 显示打包额外的py库
–collect-submodules MODULENAME 从指定的包或模块收集所有子模块。
–collect-data MODULENAME 从指定的包或模块收集所有数据。
–collect-binaries MODULENAME 从指定的包或模块收集所有二进制文件。
–collect-all MODULENAME 收集指定包或模块中的所有子模块、数据文件和二进制文件
–copy-metadata PACKAGENAME 复制指定包的元数据。
–recursive-copy-metadata PACKAGENAME 复制指定包及其所有依赖项的元数据。
–additional-hooks-dir HOOKSPATH 指定用户的hook目录。系统hook在Pyinstaller\hooks目录下
–runtime-hook RUNTIME_HOOKS 如果设置了此参数，则runtime-hook会在运行main.py之前被运行
–exclude-module EXCLUDES 需要排除的module，有助于减少生成文件的大小
–key KEY 用于加密Python字节码的密钥。
–splash IMAGE_FILE (实验性的)添加一个带有图像IMAGE_FILE的启动屏幕到应用程序。可以在拆包时显示进度更新。

5.4.4 如何生成有关参数

参数名 说明
-d 打包时，会输出一些log，有助于查错
–python-option PYTHON_OPTION 指定一个命令行选项，在运行时传递给Python解释器。
-s、–strip 优化符号表，不建议在windows上使用
–noupx 不要使用UPX，即使它可用
–upx-exclude FILE 使用upx时防止二进制文件被压缩。

5.4.5 Windows和Mac特有的参数

参数名 说明
-c、–console、–nowindowed 显示命令行窗口
-w、–windowed、–noconsole 不显示命令行窗口
-i、–icon ICO 为最后的可执行程序指定图标
–disable-windowed-traceback 在window (noconsole)模式下禁用未处理异常的回溯转储

5.4.6 Windows特有的参数

参数名 说明
–version-file FILE 添加版本信息文件
-m、–manifest FILE 添加manifest文件
–no-embed-manifest 生成外部.exe文件。
-r、–resource RESOURCE 向Windows可执行文件添加或更新资源。
–uac-admin 使用此选项将创建一个清单，该清单将在应用程序启动时请求提升
–uac-uiaccess 使用此选项允许提升的应用程序与远程桌面一起工作。

5.4.7 常用参数

-h、–help 查看Pyinstaller所有命令的用法和帮助
-y、–noconfirm 当存在dist时，不询问，直接覆盖
–clean 打包前先清理缓存和临时文件，重新打包建议加上该命令
–log-level LEVEL 限制打包时在控制台中输出的日志等级。一共有6个等级，由低到高分别为TRACE、DEBUG、INFO(默认)、WARN、ERROR、CRITICAL
-D 单文件夹模式，即生成结果是一个目录，各种第三方依赖、资源和可执行程序同时存储在该目录。默认；
-F 单文件模式，即生成结果是一个可执行文件，所有的第三方依赖、资源和代码均被打包进该可执行文件内
–hidden-import MODULENAME 显示打包额外的py库
-c、–console、–nowindowed 显示命令行窗口
-w、–windowed、–noconsole 不显示命令行窗口
-i、–icon ICO 为最后的可执行程序指定图标