將Python指令碼打包成可執行檔案

幕三少發表於2018-09-27

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工具包裡面的lddobjdump命令。

PyInstaller輸入你指定的的指令碼,首先分析指令碼所依賴的其他指令碼,然後去查詢,複製,把所有相關的指令碼收集起來,包括Python解析器,然後把這些檔案放在一個目錄下,或者打包進一個可執行檔案裡面。

可以直接釋出輸出的整個資料夾裡面的檔案,或者生成的可執行檔案。你只需要告訴使用者,你的應用App是自我包含的,不需要安裝其他包,或某個版本的Python,就可以直接執行了。

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

參考資料

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

相關文章