前言
一、pandas是什么？
如果我要寫一個(gè) Python 項(xiàng)目，打包成 exe 運(yùn)行（方便在沒有 Python 的電腦上使用），我需要打包出的根目錄結(jié)構(gòu)美觀，沒有多余的、雜亂的依賴文件在那里礙眼，而且需要在發(fā)現(xiàn) bug 時(shí)，我還需要能夠修改里面的代碼后，無需再次打包，就能正常運(yùn)行，該怎么做呢？
就以一個(gè) Hello 項(xiàng)目為例，記一下我找到的完美方法。最新代碼已經(jīng)放到，歡迎參閱：https://github.com/HaujetZhao/PyInstaller-Perfect-Build-Method
首先，新建項(xiàng)目文件夾，寫一個(gè) hello.py：
用 PyInstaller 把 hello.py 打包，pyinstaller ./hello.py 命令會(huì)得到 build 和 dist 文件夾，以及 hello.spec 文件：
其中：
build 文件夾是存放打包時(shí)臨時(shí)文件用的
dist 文件夾存放了打包好的應(yīng)用
hello.spec 內(nèi)容是 PyInstaller 根據(jù)我們的命令行生成的打包參數(shù)
打開 dist/hello 文件夾，可以看到我們打包好的 hello.exe 躺在一堆依賴文件之間，非常丑陋：
我們的目標(biāo)，就是要把這些依賴包都移到一個(gè)子文件夾中，讓打包文件夾變得整潔，同時(shí)讓程序正常運(yùn)行。
最后我們可以打包成這個(gè)樣子：
首先，所有的依賴模塊都被移動(dòng)到了 libs 文件夾，整個(gè)打包根目錄清清爽爽，只留下了必要的 python310.dll 和 base_library.zip。
其次，如你所見，這個(gè)程序的脾氣不是太好，出口成臟，我們希望用戶在拿到這個(gè)開源程序時(shí)，可以修改腳本的內(nèi)容，不需要重新打包就能直接從 hello.exe 運(yùn)行。因此我們要把 hello.exe 做成程序入口，實(shí)際的邏輯寫在 hello_main.py ，同時(shí)要確保 hello_main.py 中的依賴都被正確打包到 libs 文件夾。
我們一步步解決。
二、使用步驟
1.1 生成 spec 文件
達(dá)到目的的關(guān)鍵在于用命令行打包時(shí)自動(dòng)生成的 hello.spec ，它的本質(zhì)是一個(gè) python 文件，pyinstaller 有兩種運(yùn)行模式：
pyinstaller hello.spec 會(huì)使用 spec 文件中的配置進(jìn)行打包
pyinstaller hello.py 根據(jù)命令行參數(shù)自動(dòng)生成 spec 文件，再依據(jù)使用 spec 文件中的配置進(jìn)行打包
pyinstaller 在打包時(shí)，實(shí)際上是在做了一些準(zhǔn)備工作后，直接運(yùn)行了 spec 文件里的 Python 代碼。
相比于給命令行添加參數(shù)，直接編輯 spec 文件，在里面保存參數(shù)，更優(yōu)雅，更方便操作。
除了直接打包腳，本文件自動(dòng)生成 spec 配置，還可以通過執(zhí)行 pyi-makespec hello.py 不打包，只生成 spec 配置。
1.2 解釋 spec 文件
打開 hello.spec 文件，有如下內(nèi)容（已作注釋）：
1.3 加入 Hook
通過對 spec 文件的了解，我們知道了，可以在 a.runtimehooks 列表中加入 python 腳本 hook ，它會(huì)在我們的主代碼執(zhí)行之前運(yùn)行，為我們準(zhǔn)備環(huán)境。
在這個(gè) hook 里面，我們就可以修改 sys.path ，自定義 Python 查找模塊的路徑，或者環(huán)境變量
那我們就寫一個(gè) hook.py
import sys
from pprint import pprint
print(f’\n\n模塊查找路徑：')
pprint(sys.path)
print(‘\n’)
然后，用 pyinstaller hello.spec 進(jìn)行打包，再執(zhí)行得到的 hello.exe，得到如下輸出：
可見 hook.py 確實(shí)在 hello.py 之前運(yùn)行了，且打印出了 sys.path ，即模塊查找路徑，有三個(gè)：
dist/hello/base_library.zip 這個(gè)是程序所在目錄的 base_library.zip 文件
dist/hello/lib-dynload 這個(gè)是運(yùn)行程序時(shí)動(dòng)態(tài)生成的
dist/hello/ 這個(gè)是程序所在目錄
1.4 hook 修改 sys.path
因此，我們就可以在打包輸出文件夾中新建一個(gè) libs 文件夾，將所有的依賴文件全都放進(jìn)去，然后在 hook.py 里把 libs 路徑加入 sys.path ，然后我們的腳本運(yùn)行時(shí)就正確搜索到依賴包了。
改寫 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§.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 進(jìn)行打包，再執(zhí)行得到的 hello.exe，得到如下輸出：
從輸出可以看到模塊查找路徑，已經(jīng)修改成功，新增了 libs 文件夾。
既然模塊查找路徑添加成功。那我們就 手動(dòng) 把所有的依賴文件都移動(dòng)到 libs 子文件夾中，再運(yùn)行 hello.exe ，完美運(yùn)行：
需要注意的是：由于 hook 也是 python 腳本，運(yùn)行 hook 需要 python 環(huán)境，所以 python310.dll 和 base_library.zip 不能移動(dòng)到 libs 文件夾中。
我用的 Python 版本是3.10，所以會(huì)有一個(gè) python310.dll，具體的文件名會(huì)隨你安裝的 Python 版本而變化
1.5 查看依賴目標(biāo)位置
雖然我們在打包后將依賴文件移動(dòng)到 libs 文件夾，程序能正常運(yùn)行，但是我們肯定不希望每次打包都要 手動(dòng) 移動(dòng)一次。
實(shí)際上我們可以在 spec 文件中定義依賴文件和二進(jìn)制文件的存放位置。
pyinstaller 在執(zhí)行 spec 文件中的代碼時(shí)，自動(dòng)分析找到所需的依賴文件后，會(huì)把他們的目標(biāo)路徑和原始路徑寫到 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 進(jìn)行打包過程中得到如下輸出：
[(‘a(chǎn)pi-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’),
(‘a(chǎn)pi-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’),
剩下的項(xiàng)就省略了
]
可以看到，a.binaries 是一個(gè)列表，其中的元素是元組，元組有3個(gè)內(nèi)容：
依賴文件目標(biāo)路徑
依賴文件原始路徑
文件類型
我們只需要修改 a.binaries ，在目標(biāo)路徑前加上 libs 就可以了，同時(shí)，要確保 python310.dll 和 base_library.zip 不被修改。
1.6 修改依賴目標(biāo)位置
編輯 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
用一個(gè)函數(shù)選擇性對依賴文件目標(biāo)路徑改名
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，檢查依賴文件目標(biāo)路徑
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 進(jìn)行打包，再執(zhí)行得到的 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 也能夠正常運(yùn)行：
但是如你所見，這個(gè)程序脾氣不好，爆粗口，用戶可能會(huì)想要修改其中的代碼，但又不想配置環(huán)境、重新打包。
因此接下來我們就要把 hello.exe 作為程序入口，實(shí)際的邏輯寫在 hello_main.py ，同時(shí)確保 hello_main.py 中的依賴都被正確打包到 libs 文件夾。這樣，用戶就可以通過編輯 hello_main.py 來修改程序行為了。
2. 第二步：打包可修改程序
2.1 制作入口
新建文件 hello_main.py ，將 hello.py 的代碼邏輯復(fù)制進(jìn)去，并且要稍作修改：
coding: utf-8
from rich import print
def main(*args, **kwargs):
print('[red]Hello mother fucker! ')
input('按下回車?yán)^續(xù)')
if name == “main”:
main()
然后修改 hello.py，將其制作成程序入口，調(diào)用 hello_main.py 中的 main 函數(shù)：
coding: utf-8
import hello_main
hello_main.main()
然后，用 pyinstaller hello.spec 進(jìn)行打包，但是我們會(huì)發(fā)現(xiàn)，打包出的程序與之前一模一樣，雖然打包出的 hello.exe 能正常運(yùn)行，但是我們卻找不到 hello_main.py ：
2.2 查看被打包的 py 模塊
找不到 hello_main.py 的原因是，它被打包進(jìn)了 hello.exe 中，所有被引用到的 py 文件都會(huì)被打包進(jìn) exe 文件中。
我們回顧一下開頭 spec 文件中內(nèi)容的注釋：
除此之外，a 還有一些沒有列出的屬性：
pure 是一個(gè)列表，包含了所有純 Python 模塊的信息，這些模塊會(huì)被打包到一個(gè) .pyz 文件中。
scripts 是一個(gè)列表，包含了你的 Python 腳本的信息。這些腳本會(huì)被打包到一個(gè) exe 文件中。
hello.py 是主腳本，會(huì)被加到 a.scripts 列表中，進(jìn)而打包到 exe 中，hello_main.py 則是作為被導(dǎo)入的 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
用一個(gè)函數(shù)選擇性對依賴文件目標(biāo)路徑改名
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 進(jìn)行打包，在輸出中可以搜索到：
[
…
(‘http.cookiejar’, ‘…\Python310\lib\http\cookiejar.py’, ‘PYMODULE’),
(‘hello_main’, ‘D:\PyInstaller優(yōu)雅打包\hello_main.py’, ‘PYMODULE’),
(‘rich’, ‘…Python310\lib\site-packages\rich\init.py’,‘PYMODULE’),
…
]
hello_main 赫然在列。
2.3 阻止 py 模塊被打包
既然 hello_main.py 是因?yàn)楸蛔詣?dòng)加入到 a.pure 列表導(dǎo)致被打包的，那我們就可以在 spec 文件中將它從 a.pure 中剔除。
此外，我們還需要將 hello_main.py 添加到 a.datas 列表中，將它作為普通文件被復(fù)制到打包文件夾，編輯 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
用一個(gè)函數(shù)選擇性對依賴文件目標(biāo)路徑改名，重定向到 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]
將需要排除的模塊寫到一個(gè)列表（不帶 .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 ，顯示哪些文件被復(fù)制到打包文件夾
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’,
)
此時(shí)，hook.py 中的 print 語句可以刪掉了。
然后，用 pyinstaller hello.spec 進(jìn)行打包，輸出中得到：
2.4 編輯 py 后再運(yùn)行
現(xiàn)在，用戶就可以編輯 hello_main.py 后直接從 hello.exe 運(yùn)行了，不需要重新打包（需要引入新庫的情況除外）。
用戶終于可以動(dòng)手把這個(gè)脾氣暴躁的程序教育成一個(gè)健康積極的程序了：
總結(jié)
此外，還可以進(jìn)一步修改 hello.spec ，進(jìn)而得到更完善的程序，例如導(dǎo)入額外的包、添加圖標(biāo)、添加其他資源。
這就是一個(gè)打包程序的模板了。
在此之外，其實(shí)還需要做一些改動(dòng)。由于 pyinstaller 默認(rèn)會(huì)把所有依賴的 py 文件打包到 exe 文件中，如果這些 py 文件需要查找某些二進(jìn)制文件，就會(huì)在打包根目錄查找，而不去 libs 文件夾查找，因此需要改動(dòng)一下，讓所有依賴的 py 文件也被復(fù)制到 libs 文件夾中。文章來源：http://www.zghlxwxcb.cn/news/detail-598430.html
這是整個(gè)魔改部分，將它放到 hello.spec 的 a 之后即可，你可以試著理解一下注釋。文章來源地址http://www.zghlxwxcb.cn/news/detail-598430.html
到了這里，關(guān)于【Python】pyinstaller全新的打包方案，堪稱完善！的文章就介紹完了。如果您還想了解更多內(nèi)容，請?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
