PyInstaller 常用用法

PyInstaller 常用用法

PyInstaller 是一個跨平台的 Python 應用打包工具，支持 Windows/Linux/MacOS 三大主流平台，能夠把 Python 腳本及其所在的 Python 解釋器打包成可執行文件，從而允許最終用戶在無需安裝 Python 的情況下執行你的程序。
PyInstaller 制作出來的執行文件並不是跨平台的。如果你需要分別為三大平台打包的話，那么你就要在三個平台上分別運行 PyInstaller

• 安裝 PyInstaller

　　Python 3 以上版本安裝 PyInstaller 最方便的方法當然是通過 PIP

　　>pip install PyInstaller
　　命令確認 PyInstaller 安裝成功
　　>pyinstaller --version

• 運行 PyInstaller

　　PyInstaller 最簡單的運行形式，只需要指定作為程序入口的腳本文件。假定這個文件叫做 main.py.
　　>pyinstaller main.py
　　運行之后，我們會看到目錄中多了這些內容：
　　main.spec 文件，其前綴和腳本名相同。它本質上是一個 Python 文件，指定了打包時所需的各種參數，熟悉格式以后也可以手工修改，其角色類似於 setup.py；
　　build 子目錄，其中存放打包過程中生成的臨時文件。有幾個文件需要關注一下：
　　warnxxxx.txt：該文件記錄了生成過程中的警告/錯誤信息。在一切正常的情況下，該文件也可能包含若干類似 missing module 的信息，這些信息並不表示出錯，但如果 PyInstaller 運行有問題的話，你就需要檢查這個文件來獲取錯誤的詳細內容了。
　　xref-xxxx.html：該文件輸出了 PyInstaller 分析腳本得到的模塊依賴關系圖。如果出現類似找不到模塊的信息，你可以查找這個文件來獲得一些線索。但該文件的內容比較龐大，一般情況下很少會直接使用它。
　　dist 子目錄，存放生成的最終文件。如果使用單文件模式————后面會講到），那么這里將只有單個執行文件；如果使用目錄模式的話，那么這里還會有一個和腳本同名的子目錄，其下才是真正的可執行文件（以及相關的其他附屬文件）。雙擊可執行文件就會啟動程序。

PyInstaller 命令行選項

• pyinstaller --help

　　由於可用的選項如此之多，這里並不會逐個講解，只主要介紹經常使用的幾個開關。其他選項的詳細內容可以參考官方手冊。

　　-y | --noconfirm 直接覆蓋輸出文件，而無需提示。在多次重復運行命令時可避免煩人的反復確認。

　　-D | --onedir 生成包含執行文件的目錄（這是默認行為）

　　-F | --onefile 和上一個選項相對，生成單一的可執行文件。注意，這個選項會帶來一些特殊的行為，並且我個人強烈地不推薦你使用這個選項。具體的原因我們在后面的文章中討論。

　　-i | --icon [.ico | .exe | .icns] 為 Windows/Mac 平台的執行文件指定圖標。如果是 .exe 的話，還可以在后面加上 ,id 參數來指定具體的圖標ID。

　　--version-file [filename] 添加文件版本信息。后面我們會通過一個具體的例子說明其用法。

　　-c | --console | --nowindowed 通過控制台窗口運行程序 並且分配標准輸入/輸出，（默認行為）。

　　-w | --windowed | --noconsole 和上一個選項相反，不創建控制台窗口，也不分配標准輸入/輸出。它們主要用來運行 GUI 程序。需要說明的是，沒有輸入輸出會給調試帶來一定困難，因此即便你編寫的是 GUI 程序，也建議在調試時禁用這個選項，在最終發布時再打開。

　　--add-data [file:dir] 添加數據文件。如果有多個文件需要添加的話，該選項可以出現多次。注意，文件參數的格式為文件名+輸出目錄名，用路徑分隔符分割。路徑分割符，從技術上來講就是 os.pathsep，在 Windows 下使用 ;，其他系統下則使用 :。 如果輸出到和腳本相同的目錄，則使用 . 作為輸出目錄。

　　--add-binary [file:dir] 添加二進制文件，即運行程序所需的 .exe/.dll/.so 等。其選項格式和 --add-data 相同，不再贅述。

通過 Shell 腳本/批處理運行 PyInstaller
這個問題有兩個解決辦法。第一，我們可以把需要的命令保存成 Shell/批處理腳本。第二，也可以通過運行 .spec 文件來達到同樣的效果。目前，我們還沒有介紹 .spec 文件的內容，作為示例，我們先使用第一個方法。
Linux 中一個腳本的例子大概是這樣的：

pyinstaller --noconfirm --onedir --windowed \
--add-data="README.txt:." \
--add-data="sample.png:img" \
--add-binary="mylib.dll:lib" \
--icon="main.ico" \
--version-file="version.txt" \
main.py

而 Windows 版本則是這樣：

pyinstaller --noconfirm --onedir --windowed ^
--add-data="README.txt;." ^
--add-data="sample.png;img" ^
--add-binary="mylib.dll;lib" ^
--icon="main.ico" ^
--version-file="version.txt" ^
main.py

使用 UPX 優化執行文件大小

有不少用戶會覺得 PyInstaller 生成的文件太大，不便於發布。由於 Python 解釋器本身的體積很難裁剪，所以 PyInstaller 提供了一個方案。如果 PyIntaller 在系統路徑上發現了 UPX，那么它會用 UPX 來壓縮執行文件。如果你確實有 UPX，但又並不希望裁剪的話，可以用--no-upx 開關來屏蔽它。

盡管 UPX 對大多數程序都能有不錯的壓縮率，但作為代價，使用 UPX 以后程序執行速度可能會有所減慢。此外，個別程序也存在不兼容 UPX 的情況，因此請你自己權衡是否值得使用。

為執行文件添加版本信息
上述大多數命令行選項都是相當直觀的，相信讀者參考腳本的例子就能看懂，不需要多作解釋。但有一個選項有點復雜，值得拿出來說一下，那就是 --version-file。

在 Windows 下，為應用程序添加版本信息是一種專業的表現，並且對軟件的排錯和更新也可能會有所幫助。但版本信息是一個復雜的結構————技術性的介紹可參考MSDN(https://msdn.microsoft.com/en-us/library/ff468916(v=vs.85).aspx )————自己生成版本記錄文件是比較困難的。PyInstaller 考慮到了這一點，因此它為你提供了一個用於提取版本記錄的輔助命令：pyi_grab_version。如果你的 PyInstaller 是通過 PIP 安裝的，那么該程序應該位於 Pythonxx\Scripts 子目錄下，並且如果 Python 已經添加到系統 PATH 的話，你可以直接運行此命令：
>pyi-grab_version

注意中划線和下划線的寫法，如果找不到命令的話，請檢查一下 Scripts 子目錄。

這里作為例子，我們直接從系統程序里“偷”一個版本信息過來：
>pyi-grab_version c:\windows\notepad.exe version.txt

然后打開生成的 version.txt, 會看到類似下面的內容：
# UTF-8
VSVersionInfo(

VarFileInfo([VarStruct(u'Translation', [1033, 1200])])
]
)
需要修改的是其中的版本信息和一些輔助性的描述。將文中內容修改如下：

# UTF-8
VSVersionInfo(
ffi=FixedFileInfo(
filevers=(1, 0, 1, 1),
prodvers=(1, 0, 1, 1),
...
),
kids=[
StringFileInfo(
[
StringTable(
u'040904B0',
[StringStruct(u'CompanyName', u'Sample Corp'),
StringStruct(u'FileDescription', u'PyInstaller application'),
StringStruct(u'FileVersion', u'1.0.0.1'),
StringStruct(u'InternalName', u'PyInstaller application'),
StringStruct(u'LegalCopyright', u'Sample Corp.'),
StringStruct(u'OriginalFilename', u'main.exe'),
StringStruct(u'ProductName', u'PyInstaller application'),
StringStruct(u'ProductVersion', u'1.0.0.1')])
]),
VarFileInfo([VarStruct(u'Translation', [1033, 1200])])
]
)

然后編譯程序。從資源管理器找到發布目錄下的文件（本例中應為 dist/main/main.exe），右鍵查看屬性可見版本信息已經成功添加到 .EXE 文件中了。

PyInstaller 在生成文件的同時會創建一個相應的 .spec 文件。其實，.spec 文件才是生成過程的真正核心。它本質上是一個特殊的 Python 腳本，其中記錄了生成所需的指令，和包管理所使用的 setup.py 在某種程度上有些相似。當熟悉它的格式以后，你也可以按自己的意願去修改此文件，並且某些特殊場景下修改 .spec 文件是最簡便的方法。本文就講述 spec 文件的格式、原理和一些常用使用案例。

Spec 文件生成方法
第一種就是我們已經使用過的，直接指定 .py 腳本：
>pyinstaller [options] xxx.py

PyInstaller 會首先根據選項生成對應的 .spec 文件，然后執行 .spec 文件所指定的過程生成最終文件。

你也可以指定已存在的 spec 文件：
>pyinstaller [options] xxx.spec
指定 spec 文件的情況下通常很少再使用命令行選項，因為這些選項都可以通過 .spec 文件中對應的信息修改。我們在下一節講述 .spec 文件的具體格式。
Spec 文件格式
Analysis: 分析腳本的引用關系，並將所有查找到的相關內容記錄在內部結構中，供后續步驟使用；
　　PYZ: 將所有 Python 腳本模塊編譯為對應的 .pyd 並打包；
　　EXE: 將打包后的 Python 模塊及其他文件一起生成可執行的文件結構；
　　COLLECT: 將引用到的附屬文件拷貝到生成目錄的對應位置。

命令行開關 Spec 參數 備注
　　xx.py Analysis 第一個參數 入口腳本
　　--add-binary Analysis.binaries 附加二進制文件
　　--add-data Analysis.datas 附加數據文件
　　--no-upx EXE.upx, COLLECT.upx 使用UPX
　　-c, -w EXE.console 控制台/窗口
　　--version-file EXE.version 版本信息
　　--icon EXE.icon 程序文件圖標
　　.spec 本質上就是 Python 腳本文件，所以添加自己的代碼也是完全可能的。比如，你想確認一下程序引用了哪些腳本，就可以在 Analysis 后面加上一句：

　　print('a.scripts:', a.scripts)

　　>pyinstaller --add-data="img\電影.png;img" --add-data="ffprobe.exe;." -i="img\電影.ico" -Fw movielen.py