大家好，我是痞子衡，是正經搞技術的痞子。今天痞子衡給大家介紹的是
串口調試工具pzh-py-com誕生之打包發佈。經過上一篇軟件優化之後，pzh-py-com已經初長成，該到了出去歷練的時候了，只有經歷廣大群眾考驗過的軟件才是合格的軟件。痞子衡在開發pzh-py-com時本地安裝了很多軟件：Python、pySerial、wxPython等，這些軟件是pzh-py-com運行的基礎，但如果將來別人想用pzh-py-com，是不是也需要安裝這些軟件呢？答案當然不是，如果是的話，pzh-py-com基本就沒人願意使用了。為了讓別人能夠不需要特殊環境便能運行pzh-py-com，我們需要將pzh-py-com打包成獨立可執行文件，此時我們需要藉助專門的Python打包工具，本篇是這個系列的最後一篇，痞子衡為大家講如何使用打包工具打包pzh-py-com去發佈。
一、PyInstaller簡介
Python打包工具有很多，如py2exe、cx_Freeze、PyInstaller，其中痞子衡首推PyInstaller。PyInstaller誕生於2005年，經過這麼多年的發展，其版本已經更新到v3.x，其主頁如下：
PyInstaller官方主頁： http://www.pyinstaller.org/
PyInstaller的github主頁： https://github.com/pyinstaller/pyinstaller
在使用PyInstaller進行打包工作之前，首先需要確定你的Python應用程序所調用的所有第三方庫是不是在PyInstaller支持列表裡，這個主頁顯示了PyInstaller支持的所有第三方庫： https://github.com/pyinstaller/pyinstaller/wiki/Supported-Packages，基本上常用的第三方庫都在列表裡，比如Django、numpy、PyGame、PyOpenGL、PyQt、PyWin32等。
PyInstaller的使用非常簡單，可先閱讀一遍官方文檔。對於pzh-py-com的打包，我們只需要掌握-F、-w、-i三個命令選項以及.spec文件使用就可以了。
PyInstaller官方文檔主頁： https://readthedocs.org/projects/pyinstaller/
PyInstaller 3.3.1命令上手： https://pyinstaller.readthedocs.io/en/v3.3.1/usage.html#options
PyInstaller 3.3.1 spec文件： https://pyinstaller.readthedocs.io/en/v3.3.1/spec-files.html#using-spec-files
二、將pzh-py-com打包
安裝好PyInstaller工具便可以開始打包pzh-py-com軟件了，讓我們開始吧，開始之前先介紹下pzh-py-com文件夾目錄結構，結構目錄是很簡單的，只有三個.py源文件和三張圖片，這構成了pzh-py-com軟件的全部源文件。
\pzh-py-com
\.idea --放置PyCharm工程文件
\bin --放置工程發佈的exe文件
\gui --放置工程GUI設計文件
\pzh-py-com.fbp --wxFormBuilder工程文件
\img --放置工程引用圖片文件
\led_black.png
\led_green.png
\logo_merge.jpg
\src --放置工程源代碼文件
\formatter.py --工程linker文件
\main.py --板級相關的源文件（比如pinout，clock等）
\win.py --wxPython窗口源文件（wxFormBuilder生成）
2.1 打包準備
由於pzh-py-com應用程序總共只有6個源文件，並且都已經準備就緒，pzh-py-com依賴的pySerial、wxPython庫也都在PyInstaller支持的列表裡，所以唯一剩下的準備工作便是製作pzh-py-com的圖標文件。
要製作圖標文件，首先你得有一張圖片文件，痞子衡將pySerial的logo截取了部分用作pzh-py-com的圖標，有了圖片，可以使用這個網站 https://converticon.com/ 將其轉換成圖標文件(.ico)，圖標文件製作好之後將其放在 \pzh-py-com\img\目錄下：
\pzh-py-com
\img --放置工程引用圖片文件
\pzh-py-com.png
\pzh-py-com.ico
2.2 開始打包
準備工作就緒，可以開始打包了，在使用PyInstaller打包前必須明白一點的是，PyInstaller僅能將.py格式的源文件以及其所調用的相關Python第三方源文件庫打包進最終的.exe文件，如果你的應用程序會用到圖片等多媒體文件，這些多媒體文件並不能被打包，後續exe在使用時，這些多媒體文件必須一同在場，並且還要保證與打包/開發時的相對路徑是一致的。
痞子衡使用的是如下命令格式打包pzh-py-com: pystaller -F -w [src1.py] [src2.py]... -i [pic.ico]，解釋一下這個命令組合，-F的意思是將應用程序打包成單個可執行文件（與其對立的命令是-D，打包成多文件放在一個文件夾），-w表明要打包成窗口型（與其對立的命令是-c，控制檯型），[src1.py][src2.py][...]為你自己創建的應用程序源文件(src1.py必須是含__main__的主函數文件)，-i指定圖標文件。
PS D:\my_git_repo\pzh-py-com\bin> pyinstaller -F -w ..\src\main.py ..\src\formatter.py ..\src\win.py -i ..\img\pzh-py-com.ico
223 INFO: PyInstaller: 3.3.1
225 INFO: Python: 2.7.14
227 INFO: Platform: Windows-10-10.0.15063
230 INFO: wrote D:\my_git_repo\pzh-py-com\bin\main.spec
233 INFO: UPX is not available.
237 INFO: Extending PYTHONPATH with paths
['D:\\my_git_repo\\pzh-py-com\\bin',
'D:\my_git_repo\pzh-py-com\src',
'D:\my_git_repo\pzh-py-com\src',
'D:\my_git_repo\pzh-py-com\src']
238 INFO: checking Analysis
240 INFO: Building Analysis because out00-Analysis.toc is non existent
240 INFO: Initializing module dependency graph...
246 INFO: Initializing module graph hooks...
323 INFO: running Analysis out00-Analysis.toc
342 INFO: Adding Microsoft.VC90.CRT to dependent assemblies of final executable
required by c:\tools_mcu\python27\python.exe
5611 INFO: Found C:\WINDOWS\WinSxS\Manifests\amd64_policy.9.0.microsoft.vc90.crt_1fc8b3b9a1e18e3b_9.0.30729.1_none_3da38fdebd0e6822.manifest
5615 INFO: Found C:\WINDOWS\WinSxS\Manifests\amd64_policy.9.0.microsoft.vc90.crt_1fc8b3b9a1e18e3b_9.0.30729.6161_none_acd388d7e1d8689f.manifest
5621 INFO: Found C:\WINDOWS\WinSxS\Manifests\amd64_policy.9.0.microsoft.vc90.crt_1fc8b3b9a1e18e3b_9.0.30729.9279_none_acd3d86fe1d846c4.manifest
5825 INFO: Searching for assembly amd64_Microsoft.VC90.CRT_1fc8b3b9a1e18e3b_9.0.30729.9279_none ...
5826 INFO: Found manifest C:\WINDOWS\WinSxS\Manifests\amd64_microsoft.vc90.crt_1fc8b3b9a1e18e3b_9.0.30729.9279_none_08e667efa83ba076.manifest
5828 INFO: Searching for file msvcr90.dll
5829 INFO: Found file C:\WINDOWS\WinSxS\amd64_microsoft.vc90.crt_1fc8b3b9a1e18e3b_9.0.30729.9279_none_08e667efa83ba076\msvcr90.dll
5830 INFO: Searching for file msvcp90.dll
5832 INFO: Found file C:\WINDOWS\WinSxS\amd64_microsoft.vc90.crt_1fc8b3b9a1e18e3b_9.0.30729.9279_none_08e667efa83ba076\msvcp90.dll
5833 INFO: Searching for file msvcm90.dll
5835 INFO: Found file C:\WINDOWS\WinSxS\amd64_microsoft.vc90.crt_1fc8b3b9a1e18e3b_9.0.30729.9279_none_08e667efa83ba076\msvcm90.dll
6032 INFO: Found C:\WINDOWS\WinSxS\Manifests\amd64_policy.9.0.microsoft.vc90.crt_1fc8b3b9a1e18e3b_9.0.30729.1_none_3da38fdebd0e6822.manifest
6033 INFO: Found C:\WINDOWS\WinSxS\Manifests\amd64_policy.9.0.microsoft.vc90.crt_1fc8b3b9a1e18e3b_9.0.30729.6161_none_acd388d7e1d8689f.manifest
6034 INFO: Found C:\WINDOWS\WinSxS\Manifests\amd64_policy.9.0.microsoft.vc90.crt_1fc8b3b9a1e18e3b_9.0.30729.9279_none_acd3d86fe1d846c4.manifest
6037 INFO: Adding redirect Microsoft.VC90.CRT version (9, 0, 21022, 8) -> (9, 0, 30729, 9279)
6175 INFO: Caching module hooks...
6180 INFO: Analyzing D:\my_git_repo\pzh-py-com\src\main.py
8021 INFO: Analyzing D:\my_git_repo\pzh-py-com\src\formatter.py
8024 INFO: Analyzing D:\my_git_repo\pzh-py-com\src\win.py
8040 INFO: Loading module hooks...
8040 INFO: Loading module hook "hook-wx.xrc.py"...
8046 INFO: Loading module hook "hook-encodings.py"...
8750 INFO: Looking for ctypes DLLs
8758 INFO: Analyzing run-time hooks ...
8766 INFO: Looking for dynamic libraries
9258 INFO: Looking for eggs
9258 INFO: Using Python library C:\WINDOWS\system32\python27.dll
9260 INFO: Found binding redirects:
[BindingRedirect(name=u'Microsoft.VC90.CRT', language=None, arch=u'amd64', oldVersion=(9, 0, 21022, 8), newVersion=(9, 0, 30729, 9279), publicKeyToken=u'1fc8b3b9a1e18e3b')]
9264 INFO: Warnings written to D:\my_git_repo\pzh-py-com\bin\build\jayspycom_main\warnjayspycom_main.txt
9287 INFO: Graph cross-reference written to D:\my_git_repo\pzh-py-com\bin\build\jayspycom_main\xref-jayspycom_main.html
9329 INFO: checking PYZ
9329 INFO: Building PYZ because out00-PYZ.toc is non existent
9330 INFO: Building PYZ (ZlibArchive) D:\my_git_repo\pzh-py-com\bin\build\main\out00-PYZ.pyz
9608 INFO: Building PYZ (ZlibArchive) D:\my_git_repo\pzh-py-com\bin\build\main\out00-PYZ.pyz completed successfully.
9648 INFO: checking PKG
9649 INFO: Building PKG because out00-PKG.toc is non existent
9651 INFO: Building PKG (CArchive) out00-PKG.pkg
9796 INFO: Redirecting Microsoft.VC90.CRT version (9, 0, 21022, 8) -> (9, 0, 30729, 9279)
14667 INFO: Building PKG (CArchive) out00-PKG.pkg completed successfully.
14674 INFO: Bootloader c:\tools_mcu\python27\lib\site-packages\PyInstaller\bootloader\Windows-64bit\runw.exe
14674 INFO: checking EXE
14677 INFO: Building EXE because out00-EXE.toc is non existent
14678 INFO: Building EXE from out00-EXE.toc
14695 INFO: SRCPATH [('..\img\jayspycom.ico', None)]
14697 INFO: Updating icons from ['..\img\pzh-py-com.ico'] to c:\users\nxa07314\appdata\local\temp\1\tmpcvu1zy
14698 INFO: Writing RT_GROUP_ICON 0 resource with 20 bytes
14698 INFO: Writing RT_ICON 1 resource with 4264 bytes
14707 INFO: Appending archive to EXE D:\my_git_repo\pzh-py-com\bin\dist\main.exe
14724 INFO: Building EXE from out00-EXE.toc completed successfully.
打包命令成功執行之後，便可以在\pzh-py-com\bin目錄下看到如下生成的文件：
```text
\pzh-py-com
\bin --放置工程源代碼文件
\build\ --
\dist\main.exe --可執行exe文件
\main.spec --spec文件
其中build文件夾存放的是PyInstaller在打包過程中生成的調試信息文件，dist文件夾下面的main.exe便是我們要的最終的可執行文件，main.spec是PyInstaller自動生成的命令解釋文件，其實你在命令行裡輸入的命令首先被翻譯放到.spec文件裡，然後PyInstaller主要是根據.spec文件來打包的，不信你可以試著用pyinstaller main.spec命令重新再打包一次，得到的結果是一樣的。下面是.spec文件裡的內容，如果你對.spec文件瞭解，當然也可以自己創建.spec文件來進行打包。
<code># -*- mode: python -*- block_cipher = None a = Analysis(['main.py', 'formatter.py', 'win.py'], binaries=[], datas=[], hiddenimports=[], hookspath=[], runtime_hooks=[], excludes=[], win_no_prefer_redirects=False, win_private_assemblies=False, cipher=block_cipher) pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher) exe = EXE(pyz, a.scripts, a.binaries, a.zipfiles, a.datas, name='pzh-py-com', debug=False, strip=False, upx=True, runtime_tmpdir=None, console=False , icon='..\\img\\pzh-py-com.ico') main.exe可執行文件已經生成好了，讓我們試著打開使用一下，直接在\pzh-py-com\bin\dist\目錄下打開這個文件發現報瞭如下錯誤，看起來是找不到圖片路徑，這是怎麼回事？痞子衡其實在前面已經提到過，需要保證文件夾內圖片相對路徑與打包時相對路徑一致，試著將main.exe放到\pzh-py-com\bin\目錄下再打開看是不是正常了，因為這時候相對路徑是一致的。大功告成了，最後將main.exe重命名為pzh-py-com.exe。/<code>
番外篇
正文中講了，最終的pzh-py-com.exe必須配合pzh-py-com文件夾（主要是\img裡的圖片）一起使用，並且不能任意移動pzh-py-com.exe在pzh-py-com文件夾中位置，看起來這個pzh-py-com.exe還是有一些使用限制（當然你可以創建pzh-py-com.exe的快捷方式到桌面，你可以任意移動這個快捷方式，這算是一個workaround），能不能打破這個限制？只要一個pzh-py-com.exe文件即可，並且放到任意目錄下都能運行？答案是有，可以參看這篇文章的思路 pyinstaller打包——圖片資源無法顯示問題，思路大概原理是事先將圖片編碼存到.py源文件裡，這樣在打包時便可將這個圖片數據.py源文件直接打包進pzh-py-com.exe，後續pzh-py-com.exe在運行時首先將圖片數據解碼出來並在本地保存為臨時圖片，這樣pzh-py-com.exe啟動便可完成圖片加載，等pzh-py-com.exe圖片加載完成之後可以刪除臨時圖片文件。思路有了，小夥伴趕緊動手試一試，這算是痞子衡在這個系列最後一課留給大家的一個課後作業。
關鍵字: 文件 PyInstaller main
