Python程式打包成exe可執行檔案

Python程式打包工具

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

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

• .pyc檔案：有些公司或個人因為機密或者各種原因，不願意源碼被運作者看到，可以使用pyc檔案釋出，pyc檔案是Python解釋器可以識别的二進制碼，故釋出後也是跨平台的，需要使用者安裝相應版本的Python和依賴庫。

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

.py和.pyc都比較簡單，Python本身就可以搞定。将Python腳本打包成可執行檔案有多種方式。

各種打包工具的對比如下

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

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

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指令的時候，會在和腳本相同目錄下，生成一個.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

       或：

        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 表示可執行檔案的圖示。

py2exe

         （py2exe似乎隻能支援python3.3和pyhton3.4）

         py2exe是一個将python腳本轉換成windows上的可獨立執行的可執行程式(*.exe)的工具，這樣，你就可以不用裝python而在windows系統上運作這個可執行程式。 

        py2exe已經被用于建立wxPython, Tkinter, Pmw, PyGTK, pygame,win32com client和server,和其它的獨立程式。py2exe是釋出在開源許可證下的。

py2exe的用法 

        如果你有一個名為myscript.py的python腳本，你想把它轉換為運作在windows上的可執行程式，并運作在沒有安裝python的 windows系統上，那麼首先你應寫一個用于釋出程式的設定腳本例如mysetup.py，在其中的setup函數前插入語句import py2exe 。 

mysetup.py示例如下: 

# mysetup.py 

from distutils.core import setup 

import py2exe 

setup(console=["myscript.py"]) 

然後按下面的方法運作mysetup.py: 

python mysetup.py py2exe 

        上面的指令執行後将産生一個名為dist的子目錄，其中包含了myscript.exe,python24.dll,library.zip這些檔案。

        如果你的myscript.py腳本中用了已編譯的C擴充子產品，那麼這些子產品也會被拷貝在個子目錄中，同樣，所有的dll檔案在運作時都是需要的，除了系統的dll檔案。 dist子目錄中的檔案包含了你的程式所必須的東西，你應将這個子目錄中的所有内容一起釋出。

        預設情況下，py2exe在目錄dist下建立以下這些必須的檔案： 

        1、一個或多個exe檔案。

        2、python##.dll。

        3、幾個.pyd檔案，它們是已編譯的擴充名，它們是exe檔案所需要的；加上其它的.dll檔案，這些.dll是.pyd所需要的。 

        4、一個library.zip檔案，它包含了已編譯的純的python子產品如.pyc或.pyo 上面的mysetup.py建立了一個控制台的myscript.exe程式，如果你要建立一個圖形使用者界的程式，那麼你隻需要将mysetup.py中的console=["myscript.py"]替換為windows=["myscript.py"]既可。 

        py2exe一次能夠建立多個exe檔案，你需要将這些腳本檔案的清單傳遞給console或windows的關鍵字參數。如果你有幾個相關聯的腳本，那麼這是很有用的。 

        運作下面個指令，将顯示py2exe指令的所有指令行标記。 

        python mysetup.py py2exe--help 

指定額外的檔案 

       一些應用程式在運作時需要額外的檔案，諸如配置檔案、字型、位圖。 如果在安裝腳本中用data_files可選項指定了那些額外的檔案，那麼py2exe能将這些檔案拷貝到dist子目錄中。data_files應包含一個元組(target-dir, files)清單，其中的files是這些額外的檔案的清單。 

示例如下： 

# mysetup.py

from distutils.core import setup

import glob

import py2exe 

setup(console=["myscript.py"], 

data_files=[("bitmaps", ["bm/large.gif","bm/small.gif"]), ("fonts", glob.glob("fonts\\*.fnt"))], ) 

說明：data_files選項将建立一個子目錄dist\bitmaps，其中包含兩個.gif檔案；一個子目錄dist\fonts，其中包含了所有的.fnt檔案。

Windows NTservices 

        你可以通過傳遞一個service關鍵字參數給setup函數來建造Windows NT services ,這個service參數的值必須是一個Python子產品名(包含一service類)的清單。 

示例如下： 

# mysetup.py

from distutils.core import setup

import py2exe

setup(service=["MyService"]) 

所建造的可執行的service是可以通過在其後跟一定的指令行參數标記來自行安裝和解除安裝的。