python打包文件之pyinstaller

发表于 2019-09-27 更新于 2022-06-16 分类于 rd ， python Changyan：本文字数： 1.6k 阅读时长 ≈ 6 分钟

桌面应用想要使用就要先进行打包，python扩展包pyinstaller帮我们提供了打包功能，使用过程中你会发现很多坑，后面解释。

`pyinstaller`常用参数

说明

以下介绍假设用户脚本为main.py，生成结果为main.exe。
有些参数实在很少用到，只列出简单介绍，具体请参阅原文。

1
2
3

以下介绍假设用户脚本为main.py，生成结果为main.exe。
有些参数实在很少用到，只列出简单介绍，具体请参阅原文。
原文(英文): 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`时，会输出`py`i的一些`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`	请参考原文

常见问题

`Failed to execute script main`

这个问题解决这个问题的方法很多，主要看你对应的报错信息，本人报错提示为：ImportError: unable to find Qt5Core.dll on PATH。

https://stackoverflow.com/questions/56949297/how-to-fix-importerror-unable-to-find-qt5core-dll-on-path-after-pyinstaller-b

https://github.com/pyinstaller/pyinstaller/issues/4293

里面描述的比较详细，具体就不详说了。总的来说呢，就是有的版本pyqt5库对系统变量的加载存在bug，具体原因只有官方才能解释了，咱也没法管了，对有bug的版本库提供一种办法就是，在主程序中pyqt5库import之前就对系统变量进行手动设置，import代码如下：

import sys, os
if hasattr(sys, 'frozen'):
    os.environ['PATH'] = sys._MEIPASS + ";" + os.environ['PATH']
from PyQt5 import QtCore, QtWidgets, QtGui
from PyQt5.QtWidgets import *
from untitled import Ui_MainWindow

这样就解决了该问题。

加入打包文件信息

1	pyinstaller -w -D --icon=icon.ico --version-file=file_version_info.txt main.py

file_version_info.txt保存的是文件信息

其格式大概如下：

# UTF-8
#
# For more details about fixed file info 'ffi' see:
# http://msdn.microsoft.com/en-us/library/ms646997.aspx
VSVersionInfo(
  ffi=FixedFileInfo(
    # filevers and prodvers should be always a tuple with four items: (1, 2, 3, 4)
    # Set not needed items to zero 0.
    filevers=(10, 5, 3819, 400),
    prodvers=(10, 5, 3819, 400),
    # Contains a bitmask that specifies the valid bits 'flags'r
    mask=0x17,
    # Contains a bitmask that specifies the Boolean attributes of the file.
    flags=0x0,
    # The operating system for which this file was designed.
    # 0x4 - NT and there is no need to change it.
    OS=0x4,
    # The general type of file.
    # 0x1 - the file is an application.
    fileType=0x1,
    # The function of the file.
    # 0x0 - the function is not defined for this fileType
    subtype=0x0,
    # Creation date and time stamp.
    date=(0, 0)
    ),
  kids=[
    StringFileInfo(
      [
      StringTable(
        u'040904b0',
        [StringStruct(u'CompanyName', u'Tony'),
        StringStruct(u'FileDescription', u'作者托小尼646547989@qq.com'),
        StringStruct(u'FileVersion', u'1.0'),
        StringStruct(u'InternalName', u'cutImg'),
        StringStruct(u'LegalCopyright', u'Copyright 2019 Tony. All rights reserved.'),
        StringStruct(u'OriginalFilename', u'cutimg.exe'),
        StringStruct(u'ProductName', u'图片剪切'),
        StringStruct(u'ProductVersion', u'1.0'),
        StringStruct(u'CompanyShortName', u'Tony'),
        StringStruct(u'ProductShortName', u'图片剪切'),
        StringStruct(u'LastChange', u'b4ce371876a3dcbfef2affeee4ea9c9163d4628c-refs/branch-heads/3538@{#516}'),
        StringStruct(u'Official Build', u'1'),
        StringStruct(u'SpecialBuild', u'1023'),
        StringStruct(u'PrivateBuild', u'10016'),
        StringStruct(u'KernelBuild', u'129'),
        StringStruct(u'ExpressBuild', u'1'),
        StringStruct(u'KernelVersion', u'70.0.3538.25')])
      ]), 
    VarFileInfo([VarStruct(u'Translation', [1033, 1200])])
  ]
)

使用时可以复制以上代码，也可以参考别的exe文件生成一份

若之後版本更新不能使用的話

打開CMD，CD到Python安裝目錄下cd Lib/site-packages/PyInstaller-3.3.1-py3.6.egg/PyInstaller/utils/cliutils/
輸入python grab_version.py {拖曳任一安裝或免安裝的exe檔到CMD}
按下ENTER，會自動產生file_version_info.txt，再將內容修改成自己要的資訊就可以使用了！

pyinstaller常用参数

说明