將Python腳本打包成可執行文件

Python是一個腳本語言，被解釋器解釋執行。它的發布方式：

• .py文件：對于開源項目或者源碼沒那么重要的，直接提供源碼，需要使用者自行安裝Python并且安裝依賴的各種庫。（Python官方的各種安裝包就是這樣做的）

• .pyc文件：有些公司或個人因為機密或者各種原因，不愿意源碼被運行者看到，可以使用pyc文件發布，pyc文件是Python解釋器可以識別的二進制碼，故發布后也是跨平臺的，需要使用者安裝相應版本的Python和依賴庫。

• 可執行文件：對于非碼農用戶或者一些小白用戶，你讓他裝個Python同時還要折騰一堆依賴庫，那簡直是個災難。對于此類用戶，最簡單的方式就是提 供一個可執行文件，只需要把用法告訴Ta即可。比較麻煩的是需要針對不同平臺需要打包不同的可執行文件（Windows,Linux,Mac,...）。

本文主要就是介紹最后一種方式，.py和.pyc都比較簡單，Python本身就可以搞定。將Python腳本打包成可執行文件有多種方式，本文重點介紹PyInstaller，其它僅作比較和參考。

Freezing Your Code

各種打包工具的對比如下(來自文章Freezing Your Code)：

Solution	Windows	Linux	OS X	Python 3	License	One-file mode	Zipfile import	Eggs	pkg_resources support
bbFreeze	yes	yes	yes	no	MIT	no	yes	yes	yes
py2exe	yes	no	no	yes	MIT	yes	yes	no	no
pyInstaller	yes	yes	yes	no	GPL	yes	no	yes	no
cx_Freeze	yes	yes	yes	yes	PSF	no	yes	yes	no
py2app	no	no	yes	yes	MIT	no	yes	yes	yes

PS.其中pyInstaller和cx_Freeze都是不錯的，stackoverflow上也有人建議用cx_Freeze，說是更便捷些。pkg_resources新版的pyInstaller貌似是支持的。

安裝PyInstaller

對于那些網絡比較穩定，能夠流暢使用pip源地址的用戶，直接下面的命令就可以搞定：

pip install pyinstaller

通常我們會下載源碼包，然后進入包目錄，執行下面的命令（需要安裝setuptools）：

python setup.py install

安裝完后，檢查安裝成功與否：

pyinstaller --version

安裝成功后，就可以使用下面的命令了：

• pyinstaller?: 打包可執行文件的主要命令，詳細用法下面會介紹。
• pyi-archive_viewer?: 查看可執行包里面的文件列表。
• pyi-bindepend?: 查看可執行文件依賴的動態庫（.so或.dll文件）
• pyi-...?: 等等。

使用PyInstaller

pyinstaller的語法：

pyinstaller [options] script [script ...] | specfile

最簡單的用法，在和myscript.py同目錄下執行命令：

pyinstaller mycript.py

然后會看到新增加了兩個目錄build和dist，dist下面的文件就是可以發布的可執行文件，對于上面的命令你會發現dist目錄下面有一堆文 件，各種都動態庫文件和myscrip可執行文件。有時這樣感覺比較麻煩，需要打包dist下面的所有東西才能發布，萬一丟掉一個動態庫就無法運行了，好 在pyInstaller支持單文件模式，只需要執行：

pyinstaller -F mycript.py

你會發現dist下面只有一個可執行文件，這個單文件就可以發布了，可以運行在你正在使用的操作系統類似的系統的下面。

當然，pyinstaller還有各種選項，有通用選項，如-d選項用于debug，了解pyInstaller執行的過程；還有一些針對不同平臺的選項，具體用法可以訪問PyInstaller官方WIKI。

在執行pyInstaller命令的時候，會在和腳本相同目錄下，生成一個.spec文件，該文件會告訴pyinstaller如何處理你的所有腳本，同時包含了命令選項。一般我們不用去理會這個文件，若需要打包數據文件，或者給打包的二進制增加一些Python的運行時選項時...一些高級打包選項時，需要手動編輯.spec文件。可以使用：

pyi-makespec options script [script ...]

創建一個.spec文件，對于手動編輯的.spec文件，我們可以使用下面任意一條命令：

pyinstaller specfile
pyi-build specfile

PyInstaller的原理簡介

PyInstaller其實就是把python解析器和你自己的腳本打包成一個可執行的文件，和編譯成真正的機器碼完全是兩回事，所以千萬不要指望 成打包成一個可執行文件會提高運行效率，相反可能會降低運行效率，好處就是在運行者的機器上不用安裝python和你的腳本依賴的庫。在Linux操作系 統下，它主要用的binutil工具包里面的ldd和objdump命令。

PyInstaller輸入你指定的的腳本，首先分析腳本所依賴的其他腳本，然后去查找，復制，把所有相關的腳本收集起來，包括Python解析器，然后把這些文件放在一個目錄下，或者打包進一個可執行文件里面。

可以直接發布輸出的整個文件夾里面的文件，或者生成的可執行文件。你只需要告訴用戶，你的應用App是自我包含的，不需要安裝其他包，或某個版本的Python，就可以直接運行了。

需要注意的是，PyInstaller打包的執行文件，只能在和打包機器系統同樣的環境下。也就是說，不具備可移植性，若需要在不同系統上運行，就必須針對該平臺進行打包。

參考資料

1. Freezing Your Code
2. PyInstaller官方WIKI
3. PyInstaller源碼

分類: Linux::Code