引入問題

如果我要寫一個 Python 專案，打包成 exe 運行（方便在沒有 Python 的電腦上使用），我需要打包出的根目錄結構美觀，沒有多余的、雜亂的依賴檔案在那里礙眼，而且需要在發現 bug 時，我還需要能夠修改里面的代碼后，無需再次打包，就能正常運行，該怎么做呢？

就以一個 Hello 專案為例，記一下我找到的完美方法，

首先，新建專案檔案夾，寫一個 hello.py：

用 PyInstaller 把 hello.py 打包，pyinstaller ./hello.py 命令會得到 build 和 dist 檔案夾，以及 hello.spec 檔案：

其中：

build 檔案夾是存放打包時臨時檔案用的
dist 檔案夾存放了打包好的應用
hello.spec 內容是 PyInstaller 根據我們的命令列生成的打包引數

打開 dist/hello 檔案夾，可以看到我們打包好的 hello.exe 躺在一堆依賴檔案之間，非常丑陋：

我們的目標，就是要把這些依賴包都移到一個子檔案夾中，讓打包檔案夾變得整潔，同時讓程式正常運行，

最后我們可以打包成這個樣子：

首先，所有的依賴模塊都被移動到了 libs 檔案夾，整個打包根目錄清清爽爽，只留下了必要的 python310.dll 和 base_library.zip，

其次，如你所見，這個程式的脾氣不是太好，出口成臟，我們希望用戶在拿到這個開源程式時，可以修改腳本的內容，不需要重新打包就能直接從 hello.exe 運行，因此我們要把 hello.exe 做成程式入口，實際的邏輯寫在 hello_main.py ，同時要確保 hello_main.py 中的依賴都被正確打包到 libs 檔案夾，

我們一步步解決，

第一步：自定義依賴包位置

生成 spec 檔案

達到目的的關鍵在于用命令列打包時自動生成的 hello.spec ，它的本質是一個 python 檔案，pyinstaller 有兩種運行模式：

pyinstaller hello.spec 會使用 spec 檔案中的配置進行打包
pyinstaller hello.py <other args> 根據命令列引數自動生成 spec 檔案，再依據使用 spec 檔案中的配置進行打包

pyinstaller 在打包時，實際上是在做了一些準備作業后，直接運行了 spec 檔案里的 Python 代碼，

相比于給命令列添加引數，直接編輯 spec 檔案，在里面保存引數，更優雅，更方便操作，

除了直接打包腳，本檔案自動生成 spec 配置，還可以通過執行 pyi-makespec hello.py 不打包，只生成 spec 配置，

解釋 spec 檔案

打開 hello.spec 檔案，有如下內容（已作注釋）：

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


block_cipher = None

# 這一部分負責收集你的腳本需要的所有模塊和檔案，的；hiddenimports 引數可以指定一些 PyInstaller 無法自動檢測到的模塊，
a = Analysis(
    ['hello.py'],       # 指定要打包的 Python 腳本的路徑（可以是相對路徑）
    pathex=[],          # 用來指定模塊搜索路徑
    binaries=[],        # 包含了元件或共享物件檔案，會在運行之后自動更新，加入依賴的二進制檔案
    datas=[],           # 串列，用于指定需要包含的額外檔案，每個元素都是一個元組：（檔案的源路徑, 在打包檔案中的路徑)
    hiddenimports=[],   # 用于指定一些 PyInstaller 無法自動檢測到的模塊
    hookspath=[],       # 指定查找 PyInstaller 鉤子的路徑
    hooksconfig={},     # 自定義 hook 配置，這是一個字典，一行注釋寫不下，此處先不講
    runtime_hooks=[],   # 指定運行時 hook，本質是一個 Python 腳本，hook 會在你的腳本運行前運行，可用于準備環境
    excludes=[],        # 用于指定需要排除的模塊
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)
# 除此之外，a 還有一些沒有列出的屬性：
#   pure 是一個串列，包含了所有純 Python 模塊的資訊，每個元素是一個元組，包含了：模塊名, pyc路徑, py 路徑，這些模塊會被打包到一個 .pyz 檔案中，
#   scripts 是一個串列，包含了你的 Python 腳本的資訊，每個元素是一個元組，其中包含了腳本的內部名，腳本的源路徑，以及一些元資料，這些腳本會被打包到一個可執行檔案中，


# pyz 是指生成的可執行檔案的名稱，它是由 PyInstaller 用來打包 Python 程式和依賴項的主要檔案，


# 創建 pyz 檔案，它在運行時會被解壓縮到臨時目錄中，然后被加載和執行，它會被打包進 exe 檔案
pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)


# 創建 exe 檔案
exe = EXE(
    pyz,            # 包含了所有純 Python 模塊
    a.scripts,      # 包含了主腳本及其依賴
    [],             # 所有需要打包到 exe 檔案內的二進制檔案
    exclude_binaries=True,  # 若為 True，所有的二進制檔案將被排除在 exe 之外，轉而被 COLLECT 函式收集
    name='hello',   # 生成的 exe 檔案的名字，
    debug=False,    # 打包程序中是否列印除錯資訊？
    bootloader_ignore_signals=False,
    strip=False,    # 是否移除所有的符號資訊，使打包出的 exe 檔案更小
    upx=True,       # 是否用 upx 壓縮 exe 檔案
    console=True,   # 若為 True 則在控制臺視窗中運行，否則作為后臺行程運行
    disable_windowed_traceback=False,
    argv_emulation=False,
    target_arch=None,
    codesign_identity=None,
    entitlements_file=None,
)


# 這個物件包含了所有需要分發的檔案
# 包括 EXE 函式創建的 exe 檔案、所有的二進制檔案、zip 檔案（如果有的話）和資料檔案
coll = COLLECT(
    exe,
    a.binaries,
    a.zipfiles,
    a.datas,
    strip=False,
    upx=True,
    upx_exclude=[],
    name='hello',   # 生成的檔案夾的名字
)

加入 Hook

通過對 spec 檔案的了解，我們知道了，可以在 a.runtimehooks 串列中加入 python 腳本 hook ，它會在我們的主代碼執行之前運行，為我們準備環境，

在這個 hook 里面，我們就可以修改 sys.path ，自定義 Python 查找模塊的路徑，或者環境變數

那我們就寫一個 hook.py

import sys
from pprint import pprint

print(f'\n\n模塊查找路徑：')
pprint(sys.path)

print('\n')

然后，用 pyinstaller hello.spec 進行打包，再執行得到的 hello.exe，得到如下輸出：

可見 hook.py 確實在 hello.py 之前運行了，且列印出了 sys.path ，即模塊查找路徑，有三個：

dist/hello/base_library.zip 這個是程式所在目錄的 base_library.zip 檔案
dist/hello/lib-dynload 這個是運行程式時動態生成的
dist/hello/ 這個是程式所在目錄

hook 修改 sys.path

因此，我們就可以在打包輸出檔案夾中新建一個 libs 檔案夾，將所有的依賴檔案全都放進去，然后在 hook.py 里把 libs 路徑加入 sys.path ，然后我們的腳本運行時就正確搜索到依賴包了，

改寫 hook.py

import sys
from pathlib import Path
from pprint import pprint

BASE_DIR = Path(__file__).parent

for p in sys.path.copy():
    relative_p = Path(p).relative_to(BASE_DIR)
    new_p = BASE_DIR / 'libs' / relative_p
    sys.path.insert(0, str(new_p))

print(f'\n\n模塊查找路徑：')
pprint(sys.path)

print('\n')

然后，用 pyinstaller hello.spec 進行打包，再執行得到的 hello.exe，得到如下輸出：

從輸出可以看到模塊查找路徑，已經修改成功，新增了 libs 檔案夾，

既然模塊查找路徑添加成功，那我們就手動把所有的依賴檔案都移動到 libs 子檔案夾中，再運行 hello.exe ，完美運行：

需要注意的是：由于 hook 也是 python 腳本，運行 hook 需要 python 環境，所以 python310.dll 和 base_library.zip 不能移動到 libs 檔案夾中，

我用的 Python 版本是3.10，所以會有一個 python310.dll，具體的檔案名會隨你安裝的 Python 版本而變化

查看依賴目標位置

雖然我們在打包后將依賴檔案移動到 libs 檔案夾，程式能正常運行，但是我們肯定不希望每次打包都要手動移動一次，

實際上我們可以在 spec 檔案中定義依賴檔案和二進制檔案的存放位置，

pyinstaller 在執行 spec 檔案中的代碼時，自動分析找到所需的依賴檔案后，會把他們的目標路徑和原始路徑寫到 a.binaries ，我們可以把它列印出來看一下，

修改 hello.spec 檔案

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


block_cipher = None


a = Analysis(
    ['hello.py'],
    pathex=[],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    hooksconfig={},
    runtime_hooks=['hook.py'],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)


from pprint import pprint
pprint(a.binaries)  # 列印 a.binaries


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

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='hello',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    console=True,
    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='hello',
)

然后，用 pyinstaller hello.spec 進行打包程序中得到如下輸出：

[('api-ms-win-crt-runtime-l1-1-0.dll',
  'C:\\Portable_library\\java\\jdk-14.0.1\\bin\\api-ms-win-crt-runtime-l1-1-0.dll',
  'BINARY'),
 ('python310.dll',
  'C:\\Users\\Haujet\\AppData\\Local\\Programs\\Python\\Python310\\python310.dll',
  'BINARY'),
 ('api-ms-win-crt-heap-l1-1-0.dll',
  'C:\\Portable_library\\java\\jdk-14.0.1\\bin\\api-ms-win-crt-heap-l1-1-0.dll',
  'BINARY'),
 ('VCRUNTIME140.dll',
  'C:\\Users\\Haujet\\AppData\\Local\\Programs\\Python\\Python310\\VCRUNTIME140.dll',
  'BINARY'),
  # 剩下的項就省略了
  ]

可以看到，a.binaries 是一個串列，其中的元素是元組，元組有3個內容：

依賴檔案目標路徑
依賴檔案原始路徑
檔案型別

我們只需要修改 a.binaries ，在目標路徑前加上 libs 就可以了，同時，要確保 python310.dll 和 base_library.zip 不被修改，

修改依賴目標位置

編輯 hello.spec 檔案：

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


block_cipher = None


a = Analysis(
    ['hello.py'],
    pathex=[],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    hooksconfig={},
    runtime_hooks=['hook.py'],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)


import re
import os

# 用一個函式選擇性對依賴檔案目標路徑改名
def new_dest(package: str):
    if package == 'base_library.zip' or re.match(r'python\d+.dll', package):
        return package
    return 'libs' + os.sep + package

a.binaries = [(new_dest(x[0]), x[1], x[2]) for x in a.binaries]


# 列印 a.binaries，檢查依賴檔案目標路徑
from pprint import pprint
pprint(a.binaries)


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

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='hello',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    console=True,
    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='hello',
)

然后，用 pyinstaller hello.spec 進行打包，再執行得到的 hello.exe，得到如下輸出：

[('libs\\VCRUNTIME140.dll',
  'C:\\Users\\Haujet\\AppData\\Local\\Programs\\Python\\Python310\\VCRUNTIME140.dll',
  'BINARY'),
 ('python310.dll',
  'C:\\Users\\Haujet\\AppData\\Local\\Programs\\Python\\Python310\\python310.dll',
  'BINARY'),
 ('libs\\_decimal.pyd',
  'C:\\Users\\Haujet\\AppData\\Local\\Programs\\Python\\Python310\\DLLs\\_decimal.pyd',
  'EXTENSION'),
  # 剩下的省略了
 ]

得到了干凈的輸出目錄， hello.exe 也能夠正常運行：

但是如你所見，這個程式脾氣不好，爆粗口，用戶可能會想要修改其中的代碼，但又不想配置環境、重新打包，

因此接下來我們就要把 hello.exe 作為程式入口，實際的邏輯寫在 hello_main.py ，同時確保 hello_main.py 中的依賴都被正確打包到 libs 檔案夾，這樣，用戶就可以通過編輯 hello_main.py 來修改程式行為了，

第二步：打包可修改程式

制作入口

新建檔案 hello_main.py ，將 hello.py 的代碼邏輯復制進去，并且要稍作修改：

# coding: utf-8

from rich import print

def main(*args, **kwargs):

    print('[red]Hello mother fucker! ')
    input('按下回車繼續')

if __name__ == "__main__":
    main()

然后修改 hello.py，將其制作成程式入口，呼叫 hello_main.py 中的 main 函式：

# coding: utf-8

import hello_main

hello_main.main()

然后，用 pyinstaller hello.spec 進行打包，但是我們會發現，打包出的程式與之前一模一樣，雖然打包出的 hello.exe 能正常運行，但是我們卻找不到 hello_main.py ：

查看被打包的 py 模塊

找不到 hello_main.py 的原因是，它被打包進了 hello.exe 中，所有被參考到的 py 檔案都會被打包進 exe 檔案中，

我們回顧一下開頭 spec 檔案中內容的注釋：

# 除此之外，a 還有一些沒有列出的屬性：
#   pure 是一個串列，包含了所有純 Python 模塊的資訊，這些模塊會被打包到一個 .pyz 檔案中，
#   scripts 是一個串列，包含了你的 Python 腳本的資訊，這些腳本會被打包到一個 exe 檔案中，

hello.py 是主腳本，會被加到 a.scripts 串列中，進而打包到 exe 中，hello_main.py 則是作為被匯入的 py 模塊，被加到了 a.pure 串列，后序被打包到 pyz 中，我們可以編輯 hello.spec，在打包程序中顯示出有哪些 py 檔案被打包了：

a = Analysis(
    ['hello.py'],
    pathex=[],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    hooksconfig={},
    runtime_hooks=['hook.py'],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)

import re
import os

# 用一個函式選擇性對依賴檔案目標路徑改名
def new_dest(package: str):
    if package == 'base_library.zip' or re.match(r'python\d+.dll', package):
        return package
    return 'libs' + os.sep + package

a.binaries = [(new_dest(x[0]), x[1], x[2]) for x in a.binaries]


# 列印 a.pure，顯示哪些 py 檔案被打包
from pprint import pprint
pprint(a.pure)

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

... # 后面的代碼省略了

然后，用 pyinstaller hello.spec 進行打包，在輸出中可以搜索到：

[
...
 ('http.cookiejar',  '...\\Python310\\lib\\http\\cookiejar.py',  'PYMODULE'),
 ('hello_main',      'D:\\PyInstaller優雅打包\\hello_main.py', 'PYMODULE'),
 ('rich',            '...Python310\\lib\\site-packages\\rich\\__init__.py','PYMODULE'),
 ...
 ]

hello_main 赫然在列，

阻止 py 模塊被打包

既然 hello_main.py 是因為被自動加入到 a.pure 串列導致被打包的，那我們就可以在 spec 檔案中將它從 a.pure 中剔除，

此外，我們還需要將 hello_main.py 添加到 a.datas 串列中，將它作為普通檔案被復制到打包檔案夾，編輯 hello.spec ：

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


block_cipher = None


a = Analysis(
    ['hello.py'],
    pathex=[],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    hooksconfig={},
    runtime_hooks=['hook.py'],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
    noarchive=False,
)

import re
import os

# 用一個函式選擇性對依賴檔案目標路徑改名，重定向到 libs 檔案夾
def new_dest(package: str):
    if package == 'base_library.zip' or re.match(r'python\d+.dll', package):
        return package
    return 'libs' + os.sep + package

a.binaries = [(new_dest(x[0]), x[1], x[2]) for x in a.binaries]

# 將需要排除的模塊寫到一個串列（不帶 .py）
my_modules = ['hello_main', ]

# 將被排除的模塊添加到 a.datas
for name in my_modules:
    source_file = name + '.py'
    dest_file = name + '.py'
    a.datas.append((source_file, dest_file, 'DATA'))

# 篩選 a.pure
a.pure = [x for x in a.pure if x[0] not in my_modules]

# 列印 a.dates ，顯示哪些檔案被復制到打包檔案夾
from pprint import pprint
pprint(a.datas)

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

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='hello',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    console=True,
    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='hello',
)

此時，hook.py 中的 print 陳述句可以刪掉了，

然后，用 pyinstaller hello.spec 進行打包，輸出中得到：

[
 ('base_library.zip', 'D:\\PyInstaller優雅打包\\build\\hello\\base_library.zip', 'DATA'),
 ('hello_main.py', 'hello_main.py', 'DATA')
]

同時也可以在打包輸出檔案夾中看到 hello_main.py 了，并且程式能正常執行：

編輯 py 后再運行

現在，用戶就可以編輯 hello_main.py 后直接從 hello.exe 運行了，不需要重新打包（需要引入新庫的情況除外），

用戶終于可以動手把這個脾氣暴躁的程式教育成一個健康積極的程式了：

后記

此外，還可以進一步修改 hello.spec ，進而得到更完善的程式，例如匯入額外的包、添加圖示、添加其他資源，

這就是一個打包程式的模板了，

多虧有 ChatGPT 這一個知識淵博、毫無厭倦的老師，耐心的回答我提出的每一個細節問題，才能有這么一個完美的打包方案，

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/554338.html

標籤：其他

上一篇：Java虛擬執行緒

下一篇：返回列表

PyInstaller 完美打包 Python 腳本，輸出結構清晰、便于二次編輯的打包程式

引入問題

第一步：自定義依賴包位置

生成 spec 檔案

解釋 spec 檔案

加入 Hook

hook 修改 sys.path

查看依賴目標位置

修改依賴目標位置

第二步：打包可修改程式

制作入口

查看被打包的 py 模塊

阻止 py 模塊被打包

編輯 py 后再運行

后記