datetime:2022/04/16 17:10

author:nzb

pyinstaller

官方文档

常用参数

• -F, –onefile：打包一个单个文件，如果你的代码都写在一个.py文件的话，可以用这个，如果是多个.py文件就别用
• -D, –onedir：打包多个文件，在dist中生成很多依赖文件，适合以框架形式编写工具代码，我个人比较推荐这样，代码易于维护
• -K, –tk：在部署时包含 TCL/TK
• -a, –ascii：不包含编码.在支持Unicode的python版本上默认包含所有的编码.
• -d, –debug：产生debug版本的可执行文件
• -w,–windowed,–noconsole：使用Windows子系统执行.当程序启动的时候不会打开命令行(只对Windows有效)
• -c,–nowindowed,–console：使用控制台子系统执行(默认)(只对Windows有效)
  • pyinstaller -c xxxx.py - pyinstaller xxxx.py --console
• -s,–strip： 可执行文件和共享库将run through strip.注意Cygwin的strip往往使普通的win32 Dll无法使用.
• -X, –upx：如果有UPX安装(执行Configure.py时检测),会压缩执行文件(Windows系统中的DLL也会)(参见note)
• -o DIR, –out=DIR：指定spec文件的生成目录,如果没有指定,而且当前目录是PyInstaller的根目录,会自动创建一个用于输出(spec和生成的可执行文件) 的目录.如果没有指定,而当前目录不是PyInstaller的根目录,则会输出到当前的目录下.
• -p DIR, –path=DIR：设置导入路径(和使用PYTHONPATH效果相似).可以用路径分割符(Windows使用分号,Linux使用冒号) 分割,指定多个目录.也可以使用多个-p参数来设置多个导入路径，让pyinstaller自己去找程序需要的资源
• –icon=<FILE.ICO>：将file.ico添加为可执行文件的资源(只对Windows系统有效)，改变程序的图标 pyinstaller -i ico路径 xxxxx.py
• –icon=<FILE.EXE,N>：将file.exe的第n个图标添加为可执行文件的资源(只对Windows系统有效)
• -v FILE, –version=FILE：将verfile作为可执行文件的版本资源(只对Windows系统有效)
• -n NAME, –name=NAME：可选的项目(产生的spec的)名字.如果省略,第一个脚本的主文件名将作为spec的名字

通用参数

与生成结果有关的参数

指定打包哪些资源、代码

• 为什么要使用 --add-data？程序里文件格式有很多种：
  • 源代码 .py
  • 图片格式 .png .jpg .ico 等
  • 配置文件 .ini .json .xml等
  • 其他可执行文件 .bin .exe等
  • 模型文件 .pth 等
  • 说明文档 .txt .md等

• 注意：

  • 除了.py之外，其他格式不会编译。
  • 除了.py之外，其他格式若要打包进去，需要使用 --add-data 处理，或者手动拷贝(嫌麻烦，你每次都能记住？)

• 如何使用 --add-data?

  • 用法：pyinstaller x.py --add-data="源地址;目标地址"。 windows以;分割，linux以:分割
  • 例如：将 config 目录的所有文件打包到目标的 config 文件夹（不存在会自动创建）下

 pyinstaller x.py --add-data ".\\config\\*;.\\config"

• 可使用多次 --add-data

pyinstaller x.py  -n Demo2.0.3 --key !@)v -i "res\logo.ico"  
--add-data=".\*.txt;." --add-data=".\*.json;." --add-data="res\*.*;.\res" 
--add-data="dist\models\*.*;.\models"

生成参数

其他

Windows和Mac特有的参数

Windows特有的参数

.spec文件打包

• 生成 .spec 文件：pyinstaller -F xxx.py
• 编写 .spec 内容
• 打包：pyinstaller xxx.py

# -*- mode: python ; coding: utf-8 -*-

block_cipher = None

a = Analysis(
    ['run.py'],  # 此列表存放项目设计的所有Python脚本文件
    pathex=["/upper_computer/src/upper_computer_ui/script/qs_apis"], # 此列表为项目的绝对路径
    binaries=[],
    datas=[('./dist/*', './dist')],
    hiddenimports=['redis', 'paramiko', 'aioredis', 'gevent', 'requests', 'zmq', 'run'],  # fastapi的打包示例，run 也要加进来，否则启动不了
    hookspath=[],
    hooksconfig={},
    runtime_hooks=[],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)
pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)

exe = EXE(
    pyz,
    a.scripts,
    a.binaries,
    a.zipfiles,
    a.datas,
    [],
    name='run',  # 打包程序的名字
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    upx_exclude=[],
    runtime_tmpdir=None,
    console=True,  # 程序运行时是否打开控制台
    disable_windowed_traceback=False,
    argv_emulation=False,
    target_arch=None,
    codesign_identity=None,
    entitlements_file=None,
)

常见打包错误及解决办法

1、在用pyinstaller打包（-F 选项），如果用到的第三方库含有data文件，而pyinstaller又没有自带该第三方库文件的hook的时候，执行打包后的exe一般会报以下错误

友情链接

FileNotFoundError: [Errno 2] No such file or directory: ‘C:\Users\ADMINI~1\AppData\Local\Temp\1\_MEI54762\jieba\dict.txt’
[20784] Failed to execute script bat_server

上面就是没把python库jieba的dict.txt打包进来，导致了错误。

那么，解决问题也很简单，自己写个hook，然后放进pyinstaller的hooks里面即可。

hook文件的命名规范为: hook-【库名】.py，以结巴分词为例，即为hook-jieba.py，然后简单敲入以下两行：

from PyInstaller.utils.hooks import copy_metadata, collect_data_files

datas = copy_metadata('jieba')  # 解决 `pkg_resources` 错误
datas.extend(collect_data_files("jieba"))  # 解决静态文件不存在错误

接下来，找到pyinstaller的hooks文件夹，大概位于： python根目录\Lib\site-packages\PyInstaller\hooks下，然后把hook-jieba.py丢进去

注意是\Lib\site-packages\PyInstaller\hooks 不是 \Lib\site-packages\PyInstaller\utils\hooks

或者可以使用参数 --additional-hooks-dir HOOKSPATH 指定用户自定义的 hook 文件夹目录

最后，回到项目根目录，用pyinstaller打包即可。（注意需要把build目录删了，使pyinstaller从头开始打包）

当看到pyinstaller的日志里使用了我们自定义的hook后，就万事大吉了。

ok

打包tushare 或 akshare 的时候也有类似问题，下次可以直接用此法解决。