1 簡介

python提供了多種方法用于將普通的*.py程序文件打包成exe文件。exe文件即可執(zhí)行文件，打包后的*.exe應(yīng)用不用依賴python，可以在他人的電腦上運(yùn)行。

pyinstaller是一個(gè)第三方模塊，專用于python程序的exe打包。此外python還有一些別的方法進(jìn)行打包，但是pyinstaller打包最強(qiáng)大而且好用。

pyinstaller的官網(wǎng)是：https://pyinstaller.org/

2 安裝

可以通過pip進(jìn)行安裝。首先啟動(dòng)cmd，輸入以下內(nèi)容后回車：

pip install pyinstaller

安裝完成后，驗(yàn)證是否成功安裝：

pyinstaller --version

如果顯示找不到“pyinstaller”，請(qǐng)轉(zhuǎn)到最后一章“常見問題”

3 原理和打包效果

3.1 原理概述

在開始打包前，讀者有必要先了解pyinstaller的打包原理。

如果你只在乎打包結(jié)果而不在乎細(xì)節(jié)，你可以跳過第3章，直接進(jìn)入下面的打包環(huán)節(jié)。但是，當(dāng)你打包時(shí)遇到問題時(shí)，還是建議你先把打包原理看完，可能你的問題會(huì)得到解決。

pyinstaller先讀取你需要打包的python文件，然后搜索其中使用的模塊，然后將所需的模塊以及Python解釋器放到一起，并通過一些操作構(gòu)建exe，最終形成你的應(yīng)用程序。

3.2 搜索模塊

當(dāng)然，在搜索模塊的時(shí)候必然會(huì)遇到一些問題。

pyinstaller只會(huì)搜索import語句，然后根據(jù)import得到的模塊再進(jìn)行搜索。如果編程者使用了一些特殊的導(dǎo)入方式，比如使用__import__()函數(shù)，使用importlib里面的導(dǎo)入函數(shù)，那么pyinstaller很可能找不到你所需要的模塊。

這時(shí)，你可以通過參數(shù)來指定你所需要的模塊，也可以使用“鉤子”等等（這是后話）。

3.3 打包效果概述

pyinstaller打包后會(huì)形成一個(gè)文件夾或單個(gè)的exe（可以用參數(shù)指定）。但不論是哪一種情況，都會(huì)包含一個(gè)exe文件，用戶可以雙擊它運(yùn)行該應(yīng)用程序。

假如你要打包myscript.py，那么打包完成后運(yùn)行這個(gè)myscript.exe，效果就是運(yùn)行myscript.py后的效果。

默認(rèn)情況下，打包會(huì)形成一個(gè)黑色的控制臺(tái)（cmd的樣子），也可以設(shè)置隱藏這個(gè)控制臺(tái)。

這個(gè)控制臺(tái)用于為python提供標(biāo)準(zhǔn)輸入(stdin)，標(biāo)準(zhǔn)輸出(stdout)，標(biāo)準(zhǔn)錯(cuò)誤(stderr)。也就是說，這個(gè)控制臺(tái)上顯示了print函數(shù)的輸出，用于接收input函數(shù)的輸入，還會(huì)輸出python的異常。

如果你隱藏了這個(gè)控制臺(tái)，程序中的print就無法顯示（但是不會(huì)報(bào)錯(cuò)），報(bào)錯(cuò)信息也無法被用戶直接看到（pyinstaller有一些選項(xiàng)來控制顯示異常，后文詳解）；需要注意的是，此時(shí)不能使用input，否則會(huì)報(bào)錯(cuò)：

RuntimeError: input(): lost sys.stdin

python文件有一種后綴名*.pyw，這樣的程序執(zhí)行時(shí)默認(rèn)會(huì)隱藏控制臺(tái)。如果將文件后綴命名為pyw，那么pyinstaller也會(huì)認(rèn)為它隱藏了控制臺(tái)，不需要通過額外的選項(xiàng)來指定。

當(dāng)你制作GUI程序的時(shí)候，最好選擇隱藏控制臺(tái)，來提升用戶體驗(yàn)。 

打包后的文件可能會(huì)被反編譯（即通過exe文件得到原來的代碼），可以通過一些方法進(jìn)行加密（后文詳解）。

3.4 打包成單個(gè)文件夾

下面介紹一下打包完成后形成的文件夾。

這個(gè)文件夾的名字是你提供的，一般是你要求打包的python文件的名稱。文件夾中包含一個(gè)exe文件，以及其他一些依賴文件（比如一些dll文件，可能還有你的應(yīng)用所需要的圖片等素材）。你只需要將該文件夾壓縮就能發(fā)給別人運(yùn)行了。

當(dāng)你運(yùn)行里面的exe文件后，pyinstaller其實(shí)只是啟動(dòng)了解釋器，然后通過解釋器運(yùn)行你的主程序。

優(yōu)點(diǎn)

打包成單個(gè)文件夾的形式便于調(diào)試，因?yàn)槟憧梢郧宄乜吹絧yinstaller將哪些模塊文件放到了文件夾中。

當(dāng)你更改代碼，需要用戶更新應(yīng)用時(shí)，只需要讓用戶對(duì)于部分內(nèi)容進(jìn)行修改。如果你只修改了主程序，沒有使用多余的模塊，那么就只需要讓用戶替換里面的exe文件，而不用全部替換（因?yàn)楦虑昂笫褂玫哪K是一致的，它們都以多文件的形式放到了文件夾中）。

單個(gè)文件夾的狀態(tài)下，程序的啟動(dòng)速度和打包前差不多。

缺點(diǎn)

打包成單個(gè)的文件夾后，里面有大量的依賴文件，比如*.dll，還有一些文件夾。用戶從里面找出主程序exe可能需要一點(diǎn)時(shí)間。

3.5 打包成單個(gè)exe

單個(gè)exe模式下，pyinstaller只會(huì)生成一個(gè)單獨(dú)的exe文件，所有的依賴文件都會(huì)被壓縮到exe文件中。

和上面的文件夾模式類似，exe啟動(dòng)后，pyinstaller也是通過調(diào)用python解釋器來運(yùn)行主程序的。

優(yōu)點(diǎn)

打包成單個(gè)exe非常簡單，用戶只需要點(diǎn)擊exe文件就能運(yùn)行，而無需在一大堆的依賴文件中找到exe文件。并且在經(jīng)過壓縮后，這個(gè)exe文件的文件大小會(huì)大大減小。

缺點(diǎn)

單個(gè)exe的啟動(dòng)速度比較慢（通常會(huì)慢幾秒，且只是啟動(dòng)時(shí)的速度，不是運(yùn)行后的速度），這是因?yàn)閜yinstaller會(huì)在這一段時(shí)間中將一些依賴文件寫入到一個(gè)臨時(shí)的文件夾（后文介紹該文件夾的調(diào)用方式）。

如果你希望添加一些附帶文件（比如使用說明README），你還需要額外新建文件夾并將其放進(jìn)去。

4 打包

在了解相關(guān)原理后，下面正式進(jìn)入打包環(huán)節(jié)。

本章介紹通過命令行參數(shù)進(jìn)行打包，這種方式比較初級(jí)，適用于一般的打包方式。

4.1 基本語法

打包需要通過cmd進(jìn)行，語法和大多數(shù)工具一樣。pyinstaller最簡單的打包方式是：

pyinstaller myscript.py

其中myscript.py是你想要打包的程序。

如果這一步提示找不到myscript.py，請(qǐng)檢查路徑是否正確；如這一步提示找不到pyinstaller工具，請(qǐng)參考最后一章“常見問題”。

如果直接傳遞文件名，pyinstaller會(huì)生成一個(gè)spec文件將一些打包參數(shù)放到里面，然后進(jìn)行打包。打包完成后，你會(huì)在你的目錄下找到一個(gè)dist文件夾，里面存儲(chǔ)了打包后的結(jié)果。pyinstaller還會(huì)生成一個(gè)build文件夾并寫入一些日志信息。

當(dāng)然，你也可以自己構(gòu)建一個(gè)*.spec文件（后文介紹），然后交給pyinstaller進(jìn)行處理。

4.2 參數(shù)總覽

本節(jié)只是列舉并簡要介紹常用的參數(shù)，并不過多展開，將在下面的部分對(duì)于一些重點(diǎn)參數(shù)舉例介紹。

如有不熟悉命令行參數(shù)的讀者可自行搜索，或者參考下面的介紹：

pyinstaller -D -i "icon.ico" myscript.py

調(diào)用命令時(shí)，首先給出工具名稱（比如上面的 pyinstaller ），然后提供相關(guān)參數(shù)，有一些參數(shù)是可選的但不需要附帶任何值（比如上面的 -D ），有一些參數(shù)是必選的（比如上面的 myscript.py ），有一些參數(shù)需要附帶一個(gè)值（比如上面的 -i "icon.ico" ）。其中有一些參數(shù)可以簡寫（比如 -i 就是 --icon 的簡寫）。

4.3 隱藏控制臺(tái)窗口

下面是一個(gè)程序示例，將創(chuàng)建一個(gè)窗口并顯示一張圖片image.gif和一段提示。讀者無需了解其代碼細(xì)節(jié)。接下來將以這個(gè)程序?yàn)槔M(jìn)行一個(gè)簡單的打包示范。

import tkinter as tk
 
root = tk.Tk()
root.title("我的應(yīng)用程序")
 
image = tk.PhotoImage(file="assets/image.gif")
label = tk.Label(root, text="你好，用戶！", image=image, compound="top")
label.pack()
 
root.mainloop()

下面是這個(gè)應(yīng)用文件夾的文件層級(jí)結(jié)構(gòu)：

- my_app
    - assets
        - image.gif
    - my_app_name.py

由于這是一個(gè)GUI應(yīng)用，所以我選擇隱藏控制臺(tái)。打開cmd并進(jìn)入程序文件所在的文件夾my_app，執(zhí)行：

pyinstaller -w my_app_name.py

接下來會(huì)出現(xiàn)若干個(gè)INFO提示，如果沒有錯(cuò)誤，那么打包就成功了。

完成打包后，生成了build和dist文件夾，以及一個(gè)spec文件；dist文件夾包含打包的結(jié)果，build文件夾中是一些日志信息，spec文件里面是用于打包的配置信息。

接下來是重要的一步。由于打包時(shí)沒有綁定任何的資源文件，所以此時(shí)運(yùn)行時(shí)會(huì)報(bào)錯(cuò)，提示找不到image.gif。此時(shí)，應(yīng)該把程序文件夾下的assets文件夾（參見上方的文件夾層級(jí)）復(fù)制到dist文件夾中的程序文件夾，和exe文件位于同一位置。

接下來，再試一下單文件模式的打包：

pyinstaller -w -F my_app_name.py

打包后，生成了一個(gè)單個(gè)的my_app_name.exe，而沒有其他文件。同樣也需要將assets文件夾復(fù)制到與該exe文件的同一位置。 

4.4 資源嵌入exe

經(jīng)常需要復(fù)制文件夾不僅麻煩，而且還無法防止里面的內(nèi)容被用戶修改。此時(shí)，我們可以使用pyinstaller的--add-data參數(shù)，將assets文件夾里面的資源嵌入到exe文件中。

資源嵌入exe只在單文件模式下使用。文件夾模式下，資源文件夾不會(huì)嵌入到exe中，但是會(huì)被復(fù)制到exe所在的文件夾。

使用資源嵌入后，資源文件夾的路徑發(fā)生了變化，我們不能使用一般的相對(duì)路徑來調(diào)用assets這樣的內(nèi)嵌資源文件夾。

前面已經(jīng)講過，pyinstaller單文件模式下的exe啟動(dòng)后，會(huì)將嵌入的資源文件放到一個(gè)臨時(shí)的文件夾中，這個(gè)文件夾的名字不是固定的，叫做_MEIxxxxx，其中xxxxx是隨機(jī)數(shù)。這個(gè)文件夾的路徑在打包后會(huì)被放到sys._MEIPASS這個(gè)變量里面，只需要調(diào)用sys._MEIPASS就可以獲得這個(gè)路徑文件夾。

于是，我們通過以下函數(shù)返回正確的路徑：

def get_path(relative_path):
    try:
        base_path = sys._MEIPASS # pyinstaller打包后的路徑
    except AttributeError:
        base_path = os.path.abspath(".") # 當(dāng)前工作目錄的路徑
    return os.path.normpath(os.path.join(base_path, relative_path)) # 返回實(shí)際路徑

這個(gè)函數(shù)通過一個(gè)相對(duì)的路徑返回實(shí)際的絕對(duì)路徑。

需要注意：sys._MEIPASS這個(gè)屬性只有在打包成exe后才被創(chuàng)建，以py代碼執(zhí)行的時(shí)候這個(gè)屬性是不存在的，所以要通過try...except...代碼塊捕獲異常。如果不是pyinstaller模式，那么就使用py文件所在的文件夾的路徑作為基本路徑。這個(gè)函數(shù)可以直接拿來用（是一位叫做davidpendergast的大佬寫的）。

于是，我們將代碼改成這樣（省略了部分內(nèi)容）：

...
import sys
import os
def get_path(relative_path):
    try:
        base_path = sys._MEIPASS
    except AttributeError:
        base_path = os.path.abspath(".")
    return os.path.normpath(os.path.join(base_path, relative_path))
...
image = tk.PhotoImage(file=get_path("assets/image.gif"))
...

接下來進(jìn)行打包：

pyinstaller -w -F --add-data assets;assets my_app_name.py

打包完成后會(huì)生成一個(gè)包含嵌入資源的單獨(dú)的exe，無需將資源文件放到同一文件夾下也能正常運(yùn)行。

--add-data的參數(shù)由源文件名src和目標(biāo)文件名dest組成。路徑的源文件名和目標(biāo)文件名用文件分隔符進(jìn)行分隔，源文件名是該文件或文件夾的原本的路徑，目標(biāo)文件名是該文件夾嵌入到exe后的放入的文件夾名。

文件分隔符：在Windows系統(tǒng)上是分號(hào)，大部分unix系統(tǒng)上是冒號(hào)，可以通過os.pathsep來查看當(dāng)前系統(tǒng)上的文件分隔符。例如：

>>> import os
>>> os.pathsep
';'

比如--add-data "assets;assets"就表示將原本assets里面的所有文件，放入打包后的assets文件夾。再比如--add-data "assets/*.mp3;music"表示將原本assets里面的所有mp3文件，放入打包后的music文件夾。 

4.5 更改圖標(biāo)

打包完成后，默認(rèn)的程序圖標(biāo)是一個(gè)“蛇”形，但我們也可以進(jìn)行更改。（根據(jù)官方文檔，該功能只能在Windows和macOS上使用）

--icon或-i參數(shù)用于設(shè)置圖標(biāo)，該參數(shù)的值默認(rèn)為"NONE"，表示使用默認(rèn)的圖標(biāo)；也可以指定為一個(gè)*.ico格式的Windows圖標(biāo)文件路徑；*.icns的Mac圖標(biāo)文件路徑；或者一個(gè)其他圖片文件（需安裝pillow模塊，會(huì)通過pillow模塊將其轉(zhuǎn)換成標(biāo)準(zhǔn)的ico/icns格式）。

首先添加一個(gè)圖標(biāo)文件。圖標(biāo)文件在Windows上格式為*.ico，Mac上是*.icns。

- my_app
    - assets
        - image.gif
    - my_app_name.py
    - icon.ico

這個(gè)圖標(biāo)文件其實(shí)放在哪里都可以，因?yàn)榇虬瓿珊笃鋵?shí)它也相當(dāng)于嵌入了exe。但為了方便，還是把它放到同一文件夾下比較好。

pyinstaller -i icon.ico my_app_name.py

為了方便看，之前設(shè)置的-w, -F這些選項(xiàng)都省略了。最后生成了一個(gè)圖標(biāo)與icon.ico相一致的exe。

4.6 啟動(dòng)畫面（閃屏）

pyinstaller單文件模式啟動(dòng)速度較慢，所以可能需要一個(gè)啟動(dòng)畫面（閃屏）進(jìn)行過渡，提示用戶正在進(jìn)行加載。這個(gè)啟動(dòng)畫面可以是單張圖片，也可以是文本（默認(rèn)情況下文本禁用，使用方式參見第5章）。

這個(gè)啟動(dòng)畫面的實(shí)現(xiàn)基于Tcl/Tk（和python tkinter模塊一樣），打包時(shí)會(huì)附帶約1.5MB的額外文件來支持這個(gè)功能。

支持閃屏，需要先準(zhǔn)備一張圖片，必須是PNG格式（如果你安裝了pillow模塊，可以用pillow模塊支持的其他格式）。然后，在打包時(shí)加上--splash參數(shù)，并傳入圖片路徑。

pyinstaller --splash splash.png my_app_name.py

控制閃屏可以通過pyi_splash模塊，這個(gè)模塊和上一節(jié)的sys._MEIPASS屬性一樣，在沒有通過pyinstaller打包成exe后是不起作用的，所以必須帶上try...except...代碼。

pyi_splash.close()方法用于關(guān)閉閃屏。一般放在程序開頭即可，因?yàn)橹灰\(yùn)行到程序開頭，說明pyinstaller的加載就基本完成了。

于是，在程序開頭部分添加以下代碼：

try:
    import pyi_splash
    pyi_splash.close()
except ImportError:
    pass

如果不進(jìn)行關(guān)閉，那么閃屏將一直顯示。

打包后，閃屏效果如下。

至于pyi_splash還有一個(gè)update_text方法，用于顯示加載文本，將在第5章介紹。 

4.7 禁用異常提示

--disable-windowed-traceback參數(shù)用于禁用異常提示。如果不添加這個(gè)參數(shù)，將會(huì)在非控制臺(tái)程序出錯(cuò)時(shí)彈出一個(gè)窗口報(bào)告異常信息（注意：僅在隱藏控制臺(tái)模式下彈出異常報(bào)告窗口）。為了測試，我在代碼第一行添加了raise Exception，運(yùn)行打包后的exe后效果如圖所示。

5 使用Spec文件

當(dāng)你調(diào)用以上的打包方式時(shí)，會(huì)在腳本的文件夾下生成一個(gè)*.spec文件。

*.spec文件包含了打包需要使用的所有配置信息。直接在命令行中將*.spec文件路徑傳給pyinstaller，也可以進(jìn)行打包。比如：

pyinstaller my_app_name.spec

（其中my_app_name.spec是根據(jù)my_app_name.py生成的Spec文件） 

這樣，當(dāng)你多次打包同一個(gè)項(xiàng)目時(shí)，就無需每次都傳入那么多參數(shù)，只需要傳入*.spec文件的路徑即可。

*.spec文件也比較好處理，直接使用python編輯器或記事本就能編輯。

5.1 生成Spec文件

使用pyi-makespec工具可以根據(jù)pyinstaller的命令行參數(shù)生成Spec文件。用法很簡單，在原先使用pyinstaller的打包命令中，把"pyinstaller"換成"pyi-makespec"就可以生成一個(gè)Spec文件。例如：

pyi-makespec -w -F --add-data assets;assets my_app_name.py

要更改Spec文件的生成路徑，可以指定參數(shù)--specpath。

如果報(bào)錯(cuò)提示找不到pyi-makespec，轉(zhuǎn)到最后一章：常見問題。

當(dāng)你使用*.spec文件進(jìn)行pyinstaller打包時(shí)，大部分的打包參數(shù)都不可用，需要預(yù)先在*.spec文件中預(yù)先設(shè)定。

pyinstaller會(huì)將*.spec里面的內(nèi)容當(dāng)做代碼執(zhí)行。單文件模式和文件夾模式的*.spec文件略有不同。

下面是一個(gè)*.spec文件（單文件模式打包）的例子。

# -*- mode: python ; coding: utf-8 -*-
 
block_cipher = None
 
a = Analysis(
    ['my_app_name.py'],
    pathex=[],
    binaries=[],
    datas=[('assets', 'assets')],
    hiddenimports=[],
    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='my_app_name',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    upx_exclude=[],
    runtime_tmpdir=None,
    console=False,
    disable_windowed_traceback=False,
    argv_emulation=False,
    target_arch=None,
    codesign_identity=None,
    entitlements_file=None,
)

下面是一個(gè)文件夾模式的*.spec文件的例子：

# -*- mode: python ; coding: utf-8 -*-
 
block_cipher = None
 
a = Analysis(
    ['my_app_name.py'],
    pathex=[],
    binaries=[],
    datas=[('assets', 'assets')],
    hiddenimports=[],
    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,
    [],
    exclude_binaries=True,
    name='my_app_name',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    console=False,
    disable_windowed_traceback=False,
    argv_emulation=False,
    target_arch=None,
    codesign_identity=None,
    entitlements_file=None,
)
coll = COLLECT(
    exe,
    a.binaries,
    a.zipfiles,
    a.datas,
    strip=False,
    upx=True,
    upx_exclude=[],
    name='my_app_name',
)

這里面包含一些特殊的類，比如Analysis, PYZ, EXE等，文件夾模式下還多了一個(gè)COLLECT類。只有當(dāng)pyinstaller運(yùn)行時(shí)才會(huì)被定義，很顯然你不能在python解釋器中直接調(diào)用它們。 這些類的參數(shù)與pyinstaller的命令行參數(shù)并不一樣。

接下來將針對(duì)Spec文件中的這些對(duì)象進(jìn)行介紹

5.2 Analysis對(duì)象

Analysis類包含一些分析信息，它分析模塊的導(dǎo)入以及一些依賴文件。

這個(gè)類的常用參數(shù)介紹如下。

在完成分析后，需要將一些屬性傳遞給PYZ類。Analysis對(duì)象包含了以下屬性，你可以不必了解它們：

5.3 PYZ對(duì)象

完成分析后，將Analysis對(duì)象的一些屬性傳遞給PYZ類。PYZ相當(dāng)于一個(gè)壓縮包，里面儲(chǔ)存了所有的依賴文件。

pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)

5.4 EXE對(duì)象

定義PYZ對(duì)象后，接下來需要定義EXE對(duì)象，也就是可執(zhí)行文件對(duì)象。

不同打包模式（單文件或文件夾）的EXE對(duì)象參數(shù)略有不同。其中常用參數(shù)如下：

使用文件夾模式打包時(shí)還會(huì)有一個(gè)COLLECT對(duì)象，該對(duì)象用于創(chuàng)建文件夾。它有一個(gè)常用的關(guān)鍵字參數(shù)name，表示文件夾的名稱。

5.5 COLLECT對(duì)象（僅-D文件夾模式）

使用文件夾模式打包時(shí)還會(huì)有一個(gè)COLLECT對(duì)象，該對(duì)象用于創(chuàng)建文件夾。它有一個(gè)常用的關(guān)鍵字參數(shù)name，表示文件夾的名稱。

5.6 Bundle對(duì)象（僅macOS系統(tǒng)）

如果你要在macOS上創(chuàng)建應(yīng)用程序，且你的應(yīng)用程序是無控制臺(tái)的，那么在exe構(gòu)建完成之后還需要添加一些代碼。

app = BUNDLE(exe,
             name='my_app_name.app',
             icon="icon.ico",
             bundle_identifier=None)

5.7 Splash對(duì)象

如果你想要在應(yīng)用中添加啟動(dòng)畫面（圖片和文本都可以），需要在Spec文件中額外添加一個(gè)Splash對(duì)象進(jìn)行控制。

在分析完代碼后，創(chuàng)建Splash對(duì)象：

a = Analysis(...)
 
splash = Splash('splash.png',
                binaries=a.binaries,
                datas=a.datas,
                text_pos=(10, 50),
                text_size=12,
                text_color='black')

然后在EXE中綁定splash對(duì)象。注意：單文件模式和文件夾模式方式略有不同。

以下是單文件模式綁定splash對(duì)象的方法。

splash = Splash(...)
 
exe = EXE(pyz,
          a.scripts,
          splash,                   # <-- both, splash target
          splash.binaries,          # <-- and splash binaries
          ...)

以下是文件夾模式的方法。

splash = Splash(...)
 
exe = EXE(pyz,
          splash,                   # <-- splash target
          a.scripts,
          ...)
coll = COLLECT(exe,
               splash.binaries,     # <-- splash binaries
               ...)

下面介紹Splash對(duì)象的一些參數(shù)。注意：由于Splash窗口基于Tcl/Tk（和python tkinter一樣），所以里面有一些用法與Tcl/Tk(tkinter)的用法很像，但不重要。

下面就以一個(gè)示例來演示Splash的文本顯示。使用的代碼還是上一章節(jié)使用的。

在開頭添加以下代碼：

a = Analysis(...)
 
splash = Splash('splash.png',
                binaries=a.binaries,
                datas=a.datas,
                text_pos=(10, 50),
                text_size=12,
                text_color='black')

然后通過pyi-makespec生成對(duì)應(yīng)的Spec文件：

pyi-makespec -w -F --add-data assets;assets --splash splash.png my_app_name.py

由于Splash的文本顯示只能在Spec文件中進(jìn)行配置，所以我們先打開my_app_name.spec，將Splash對(duì)象的代碼進(jìn)行修改，如下所示：

splash = Splash(
    'splash.png',
    binaries=a.binaries,
    datas=a.datas,
    text_pos=(30, 270),
    text_size=12,
    minify_script=True,
    always_on_top=True,
)

然后進(jìn)行打包：

pyinstaller my_app_name.spec

運(yùn)行效果如下：

可以看到，首先顯示文本被設(shè)定為加載的各個(gè)依賴文件，然后變成update_text中自己設(shè)定的加載內(nèi)容。

5.8 多包捆綁（打包多個(gè)exe）

有些產(chǎn)品由幾個(gè)不同的應(yīng)用程序組成，每個(gè)應(yīng)用程序可能依賴于一組通用的第三方庫，或者以其他方式共享一部分代碼。在打包這樣的產(chǎn)品時(shí)，如果單獨(dú)對(duì)待每個(gè)應(yīng)用程序，將其與所有依賴項(xiàng)捆綁在一起，那就太可惜了，因?yàn)檫@意味著要存儲(chǔ)代碼和庫的副本。

此時(shí)，我們可以使用多包特性來捆綁一組可執(zhí)行應(yīng)用程序，以便它們共享庫的單個(gè)副本。我們可以在單文件或單文件夾應(yīng)用程序中做到這一點(diǎn)。

文件夾模式的多包捆綁

如果采用文件夾模式，想要捆綁多個(gè)應(yīng)用程序，那么只需要共享一個(gè)COLLECT對(duì)象。假如有hello1.py, hello2.py，將這兩個(gè)應(yīng)用進(jìn)行捆綁，可以將它們的Spec文件進(jìn)行一些組合。

首先通過pyi-makespec分別生成hello1.py, hello2.py的Spec文件。

然后將其中的Analysis, PYZ, EXE, Splash等對(duì)象分別以不同的變量名放入同一個(gè)Spec文件，然后將它們的COLLECT對(duì)象組合起來。

hello1_a = Analysis(['hello1.py'], ...)
hello1_pyz = PYZ(hello1_a.pure, hello1_a.zipped_data, ...)
hello1_exe = EXE(hello1_pyz,
          hello1_a.scripts, 
          ...)
 
hello2_a = Analysis(['hello2.py'], ...)
hello2_pyz = PYZ(hello2_a.pure, hello2_a.zipped_data, ...)
hello2_exe = EXE(hello2_pyz,
          hello2_a.scripts, 
          ...)
 
coll = COLLECT(hello1_exe,
               hello1_a.binaries,
               hello1_a.zipfiles,
               hello1_a.datas,
 
               hello2_exe,
               hello2_a.binaries,
               hello2_a.zipfiles,
               hello2_a.datas,
               ...
               name='hello')

這樣，將會(huì)生成同一個(gè)文件夾，該文件夾下包含兩個(gè)文件hello1.exe, hello2.exe。 它們共享一部分的依賴文件。

單文件模式的多包捆綁

單文件模式下，多包捆綁會(huì)生成多個(gè)單獨(dú)的exe，其中一個(gè)exe包含它們共有的依賴文件。

比如打包hello1.py和hello2.py，設(shè)置hello1包含共有的依賴文件，最后生成hello1.exe, hello2.exe。生成的hello1.exe由于包含兩個(gè)exe共有的依賴文件，其文件大小會(huì)大于hello2.exe。

運(yùn)行hello1.exe時(shí)與單獨(dú)打包效果相同。但是運(yùn)行hello2.exe時(shí)，它會(huì)在hello1.exe中搜索它需要的依賴文件，速度會(huì)稍慢。

如果將hello2.exe移動(dòng)到別的地方，或者將hello1.exe改名，那么hello2.exe將無法運(yùn)行，因?yàn)樗也坏絟ello1.exe，從而無法找到所需的依賴文件。

以下是hello1.py和hello2.py兩個(gè)程序文件，將以它們?yōu)槔M(jìn)行打包。

# hello1.py
while True:
    input("hello1")
 
# hello2.py
while True:
    input("hello2")

首先通過pyi-makespec生成對(duì)應(yīng)的Spec文件。完成后，將兩個(gè)Spec文件的Analysis類匯總到一個(gè)文件中，并進(jìn)行改名。

a1 = Analysis(
    ['hello1.py'],
    ...
)
 
a2 = Analysis(
    ['hello2.py'],
    ...
)

接下來在下面調(diào)用MERGE函數(shù)。這個(gè)函數(shù)會(huì)分析兩個(gè)文件中重復(fù)的依賴項(xiàng)，將結(jié)果放到分析類的dependencies屬性中。MERGE中位于第一個(gè)的程序?qū)?huì)包含共有的依賴項(xiàng)。

MERGE((a1, "hello1", "hello1"), (a2, "hello2", "hello2"))

然后將兩個(gè)文件的ZIP和EXE進(jìn)行匯總。匯總時(shí)需要額外向EXE類傳遞一個(gè)參數(shù)Analysis.dependencies。

pyz1 = PYZ(...)
exe1 = EXE(pyz1,
 
    a1.dependencies, ####
 
    a1.scripts, 
    a1.binaries,
    a1.zipfiles,
    a1.datas, ...)
 
pyz2 = PYZ(...)
exe2 = EXE(
    pyz2,
 
    a2.dependencies, ####
 
    a2.scripts,
    a2.binaries,
    a2.zipfiles,
    a2.datas, ...)

 保存文件，然后通過pyinstaller打包。

最后生成兩個(gè)文件，可以看到hello1.exe的文件大小比hello2.exe大了很多，這是由于hello1.exe中包含了它們共有的依賴庫。如果不使用多包捆綁，而是分別單獨(dú)進(jìn)行打包，那么兩個(gè)文件的大小將都會(huì)超過5000KB。

6 鉤子

有一些特殊的模塊，它們存在一些特殊的依賴文件（比如ico, json等等）。而pyinstaller的導(dǎo)入分析無法檢測到這些特殊的依賴文件，這就導(dǎo)致運(yùn)行后出現(xiàn)問題。于是，pyinstaller引入了“鉤子”。鉤子文件其實(shí)就是一種python文件，后綴名為*.py即可（和Spec文件的實(shí)質(zhì)是一樣的）。鉤子文件中指定了某個(gè)特殊模塊所需要的所有依賴文件。通過傳遞鉤子文件，pyinstaller就能找到那些“隱藏”的依賴文件。

雖然鉤子文件的作用也可以被--hiddenimport, --datas這些命令行參數(shù)替代，但是使用鉤子顯然更加方便。

pyinstaller有一些內(nèi)置的“鉤子”，提供了一些常用模塊的鉤子文件，它們包含Django, pickle, pyqt, scipy等等。

鉤子文件的常用命名格式是：hook-module.py（其中module是模塊名）。（當(dāng)然你也可以按自己喜好命名）

6.1 鉤子文件中的全局變量

鉤子文件中可以包含以下全局變量（有一些變量可以不被寫在文件中）：

以下是一個(gè)鉤子文件的示例：

hiddenimports = ["re", "os"]
datas = [("assets", "assets)]

6.2 PyInstaller.utils.hooks

pyinstaller提供了一些方法用于鉤子文件的制作。這些方法位于PyInstaller.utils.hooks模塊。首先需要在鉤子文件導(dǎo)入該模塊。（注意pyinstaller的P和I是大寫的，這是pyinstaller作為模塊時(shí)的名稱）

import PyInstaller.utils.hooks as hooks

下面介紹該模塊中的常用函數(shù)。

is_module_satisfies(requirements, version=None, version_attr='__version__')

檢驗(yàn)?zāi)K版本是否達(dá)到requirements的要求，返回一個(gè)布爾值。關(guān)于requirements的相關(guān)格式，詳見PEP 440。version_attr參數(shù)指定該模塊中版本屬性的名稱，默認(rèn)是"__version__"。

下面是一些requirements的例子：

"pygame >= 2.2.1dev1" # 大于2.1.1dev1版本的pygame模塊
"PIL == 2.9.*"    # 版本以2.9.開頭的PIL模塊
"sphinx >= 1.3.1; sqlalchemy != 0.6" # 同時(shí)滿足兩個(gè)要求

collect_submodules(package, filter=<function <lambda>>, on_error='warn once')

返回一個(gè)模塊的所有子模塊。filter是一個(gè)篩選函數(shù)，接收模塊名作為參數(shù)，返回一個(gè)布爾值表示是否要加入這個(gè)模塊到返回值中。on_error表示篩選出現(xiàn)異常時(shí)的處理，可以是："raise"（拋出異常并停止pyinstaller構(gòu)建），"warn"（只拋出警告，不停止pyinstaller構(gòu)建），"warn once"（只警告一次，后續(xù)與之相同的警告被忽略），"ignore"（忽略，不拋出任何警告或異常）

例如：

# 收集Sphinx的所有子模塊（名字中不包含test）
hiddenimports = collect_submodules(
    "Sphinx", filter=lambda name: 'test' not in name)

collect_data_files(package, include_py_files=False, subdir=None, excludes=None, includes=None) 

返回一個(gè)模塊使用的所有非二進(jìn)制文件。include_py_files表示返回的文件列表中是否應(yīng)該含有*.py格式的文件。subdir是相對(duì)于要搜索的包的子目錄。excludes, includes分別是需要被排除和被包含的文件列表，可以指定它們來判斷是否要保留或移除某些格式的文件。

collect_dynamic_libs(package, destdir=None, search_patterns=['*.dll', '*.dylib', 'lib*.so'])

返回一個(gè)模塊使用的所有二進(jìn)制動(dòng)態(tài)庫文件。

collect_all(package_name, include_py_files=True, filter_submodules=None, exclude_datas=None, include_datas=None, on_error='warn once')

相當(dāng)于上面的collect前綴的幾個(gè)函數(shù)的綜合。例如：

datas, binaries, hiddenimports = collect_all('my_module_name')

使用hooks模塊可以更加方便地制作鉤子。

6.3 為自己的模塊提供鉤子

如果自己創(chuàng)建的模塊需要鉤子，那么可以自己定義一個(gè)文件，并儲(chǔ)存到自己的模塊中。

如果你有一個(gè)名為module_name的模塊文件夾，首先在自己模塊的setup.cfg中（與setuptools模塊相關(guān)，可自行搜索）添加如下代碼（注意里面的module_name）：

[options.entry_points]
pyinstaller40 =
  hook-dirs = module_name.__pyinstaller:get_hook_dirs
  tests     = module_name.__pyinstaller:get_PyInstaller_tests

然后在module_name中添加名字為__pyinstaller的文件夾（與上面hook-dirs和tests里面的命名相一致即可）。

最后可以在__pyinstaller文件夾中添加hook文件。

7 常見問題

打包時(shí)報(bào)錯(cuò)：不是可運(yùn)行的命令或程序

首先檢查pyinstaller是否被成功安裝。在cmd輸入pip list，看安裝列表中是否存在pyinstaller，如果沒有則重新安裝，根據(jù)安裝信息進(jìn)行處理。

如果顯示未找到pyinstaller，則應(yīng)用絕對(duì)路徑指定pyinstaller。首先進(jìn)入所在的文件夾，然后復(fù)制路徑。打包時(shí)，將pyinstaller替換為pyinstaller.exe的絕對(duì)路徑。（pyi-makespec找不到同理）

• Windows: Python目錄下的Scripts文件夾
• GNU/Linux: /usr/bin
• macOS (using the default Apple-supplied Python) /usr/bin
• macOS (using Python installed by homebrew) /usr/local/bin
• macOS (using Python installed by macports) /opt/local/bin

例如，你想要執(zhí)行pyinstaller myscript.py，但是提示找不到pyinstaller.exe。在你的電腦上，pyinstaller.exe安裝在了C:\Python\Python310\Scripts這個(gè)位置，那么執(zhí)行：

C:\Python\Python310\Scripts\pyinstaller.exe myscript.py

還有一種解決方法，將pyinstaller.exe所在的文件夾添加到系統(tǒng)環(huán)境變量（推薦）。Windows上添加環(huán)境變量辦法如下：

右擊“此電腦” -> 單擊“屬性” -> 單擊“高級(jí)系統(tǒng)設(shè)置” -> 單擊“環(huán)境變量” -> 在用戶變量的位置單擊“Path” -> 單擊“編輯” -> 在“編輯環(huán)境變量”的窗口單擊“新建” -> 寫入pyinstaller.exe的所在路徑 -> 一路“確定”進(jìn)行保存。

運(yùn)行后報(bào)錯(cuò)：找不到某些模塊或文件

找不到某些模塊，需要修改命令行參數(shù)--hidden-import，加入找不到的模塊。

如果提示找不到sys, os兩個(gè)模塊，那么命令行參數(shù)修改為：

pyinstaller --hidden-import "sys" --hidden-import "os" ...

如果使用Spec打包，則應(yīng)在Analysis類的hiddenimport參數(shù)的列表中添加找不到的模塊。

如果只是找不到某些模塊中的部分文件，則需要為該模塊添加鉤子，或者將這些文件傳遞到命令行參數(shù)--add-data, --add-binary中。

運(yùn)行后報(bào)錯(cuò)：失去標(biāo)準(zhǔn)輸入

RuntimeError: input(): lost sys.stdin

某些程序打包后出現(xiàn)以上報(bào)錯(cuò)內(nèi)容。這是由于代碼中使用了input這樣的函數(shù)讓用戶進(jìn)行輸入，但是打包時(shí)卻設(shè)置了隱藏控制臺(tái)。于是，運(yùn)行打包后的應(yīng)用后就沒有一個(gè)控制臺(tái)讓用戶進(jìn)行輸入，就會(huì)報(bào)錯(cuò)。（失去stdout并不會(huì)報(bào)錯(cuò)，但是print內(nèi)容不會(huì)顯示）

由于文檔內(nèi)容較多，很難涵蓋每一個(gè)點(diǎn)，如果你認(rèn)為還有本文沒有提及的重點(diǎn)，請(qǐng)指出，歡迎任何建議者。

總結(jié)

到此這篇關(guān)于Python pyinstaller打包exe最新完整圖文教程的文章就介紹到這了,更多相關(guān)Python pyinstaller打包exe內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論