Python 程序打包工具
Python 是一個腳本語言,被解釋器解釋執行。它的發布方式:
.py 文件:對於開源項目或者源碼沒那么重要的,直接提供源碼,需要使用者自行安裝 Python 並且安裝依賴的各種庫。(Python 官方的各種安裝包就是這樣做的)。
.pyc 文件:有些公司或個人因為機密或者各種原因,不願意源碼被運行者看到,可以使用 pyc 文件發布,pyc 文件是 Python 解釋器可以識別的二進制碼,故發布后也是跨平台的,需要使用者安裝相應版本的 Python 和依賴庫。
可執行文件:對於非碼農用戶或者一些小白用戶,你讓他裝個 Python 同時還要折騰一堆依賴庫,那簡直是個災難。對於此類用戶,最簡單的方式就是提供一個可執行文件,只需要把用法告訴他即可。比較麻煩的是需要針對不同平台需要打包不同的可執行文件(Windows, Linux, Mac,…)。
.py 和.pyc 都比較簡單,Python 本身就可以搞定。將 Python 腳本打包成可執行文件有多種方式。
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 若打包項目包含配置文件,且配置文件需要暴露的話,則在代碼中配置文件的路徑必須要寫成絕對路徑,否則exe文件執行不了。
你會發現 dist 下面只有一個可執行文件,這個單文件就可以發布了,可以運行在你正在使用的操作系統類似的系統的下面。當然,pyinstaller 還有各種選項,有通用選項,如 -d 選項用於 debug。
在執行 pyInstaller 命令的時候,會在和腳本相同目錄下,生成一個.spec 文件,該文件會告訴 pyinstaller 如何處理你的所有腳本,同時包含了命令選項。一般我們不用去理會這個文件,若需要打包數據文件,或者給打包的二進制增加一些 Python 的運行時選項時…一些高級打包選項時,需要手動編輯.spec 文件。可以使用:
pyi-makespec optionsscript [script …]
創建一個.spec 文件,對於手動編輯的.spec 文件,我們可以使用下面任意一條命令:
pyinstaller specfile
pyi-build specfile
PyInstaller 原理簡介
PyInstaller 其實就是把 python 解析器和你自己的腳本打包成一個可執行的文件,和編譯成真正的機器碼完全是兩回事,所以千萬不要指望成打包成一個可執行文件會提高運行效率,相反可能會降低運行效率,好處就是在運行者的機器上不用安裝 python 和你的腳本依賴的庫。在 Linux 操作系統下,它主要用的 binutil 工具包里面的 ldd 和 objdump 命令。
PyInstaller 輸入你指定的的腳本,首先分析腳本所依賴的其他腳本,然后去查找,復制,把所有相關的腳本收集起來,包括 Python 解析器,然后把這些文件放在一個目錄下,或者打包進一個可執行文件里面。
可以直接發布輸出的整個文件夾里面的文件,或者生成的可執行文件。你只需要告訴用戶,你的應用 App 是自我包含的,不需要安裝其他包,或某個版本的 Python,就可以直接運行了。
需要注意的是,PyInstaller 打包的執行文件,只能在和打包機器系統同樣的環境下。也就是說,不具備可移植性,若需要在不同系統上運行,就必須針對該平台進行打包。
實踐問題
pyinstaller 打包后的 exe 運行怎么去掉彈出的命令行提示窗口?
1. 如果使用.spec 文件的話, 在該文件中找到 console=True 修改為 console=False
2. 如果是直接指定 python 文件進行 pyinstaller 打包的話,需要添加—noconsole
pyinstaller path\mycode.py–noconsole
如果想只打包成一個 exe:
pyinstaller -F path\mycode.py –noconsole(注意:noconsole前面必須是兩個 - -,一個 - 不起作用)
或:
pyinstaller -F -wpath\mycode.py
更換最終 exe 生成路徑
在 cmd 中,一開始就要 cd D:\PythonEXE\ 切換到輸出文件夾,然后在用上面的代碼,說明:各個參數的作用,
例子:pyinstaller -F -w -pD:\tmp\core-python\libs -i d:\tmp\main.ico main.py
-F 表示生成單個可執行文件;
-D –onedir 創建一個目錄,包含 exe 文件,但會依賴很多文件(默認選項)。
-w 表示去掉控制台窗口,這在 GUI 界面時非常有用。不過如果是命令行程序的話那就把這個選項刪除吧!;
-c –console, –nowindowed 使用控制台,無界面 (默認);
-p 表示你自己自定義需要加載的類路徑,一般情況下用不到;
-i 表示可執行文件的圖標。