使用pyinstaller打包python PyQt5程序

Posted on by

當你有打包你的python應用的需求以後，你可能會像搜索引擎尋求幫助，你或許曾經搜索過“python 轉 exe”，“python打包”等等這樣的字眼，你或許曾看到過各種各樣的相關解決方案，本文介紹的是其中的一種，但是可以負責任的說，這是目前最好的方案，並且是跨平臺最好的方案，也就是說使用這個叫pyinstaller的工具，你可以把同樣的代碼打包在Windows，Linux以及macOs上運行。

這個工具的名稱就是pyinstaller，官方主頁：
http://www.pyinstaller.org/

這個工具將打包工作封裝成一條簡單的指令就能完成的動作。

準備

工具準備

第一件事情當然是安裝這個庫瞭，和往常一樣，使用pip

pip install pyinstaller

源代碼準備

因為我們是針對一個GUI應用來打包，那麼我們需要簡單的改造一下源代碼，如果你是在打包命令行，則不需要進行這個操作。

首先，我們要創建一個入口文件，名稱為 wifidrop.pyw，名字無所謂，它將成為你最終的軟件名稱，這裡需要註意的是，我們的文件後綴為pyw，比py文件後綴多瞭一個w，而w的意思是window，也就是說告訴python環境，我們這個軟件是一個窗口應用，如果不這麼做，在運行軟件的時候，除瞭有我們的GUI界面以外，python還會留 一個命令行窗口在後邊，這顯然不是我們想要的，而使用瞭pyw後綴以後，python則不會顯示命令行窗口。

在 wifidrop.pyw 不需要做什麼太多東西，僅僅是簡單的調用main.py中的main函數就可以瞭。

import sys
from main import main

if __name__ == '__main__':
    excode = main()
    sys.exit(excode)

打包

做好代碼相關的準備以後，就可以使用pyinstaller來打包軟件瞭，過程也非常簡單，一行命令就能解決，在命令行中運行

pyinstaller --clean -F -w wifidrop.pyw -i Treetog-I-Documents.ico

參數說明

–clean ：告訴pyinstaller刪除緩存和臨時文件
-F ：告訴pyinstaller將打包的結果放在一個exe文件中，也就是說最終結果將隻有一個exe文件，如果不使用這個參數，那麼結果會是一個exe加很多依賴文件，不利於我們分發軟件。
-w ：告訴pyinstaller我們要生成的是一個窗口應用
-i ：為我們的應用指定一個圖標，否則默認的話會使用python圖標
一般來說，這些參數就足夠日常使用瞭，如果需要更深入的功能，比如加密等等，就需要閱讀手冊瞭。

這條命令成功運行完以後，你將會在項目目錄中看到build和dist兩個文件夾，最終的可執行文件就放置在dist文件傢中。

針對PyQt應用的改進

目前的小問題

當我們嘗試運行在dist中生成的wifidrop.exe文件的時候，你將發現，程序無法運行，不知道你還有沒有印象，至今為止，我們都一直在main.py中使用loadUi函數加載Qt Creator創建的ui的方式來創建GUI界面，那麼仔細觀察一下dist文件夾中，裡邊並沒有ui文件，對吧？

因為pyinstaller僅僅是一個py應用的打包工具，它並不知道其他的文件的存在，所以，你可以嘗試把我們的兩個ui文件拷貝到dist文件夾中之後再運行這個exe。

你會發現現在應用可以正常使用瞭。但是這樣會不會有什麼風險？

對瞭，ui文件說白瞭是一個xml格式的文本文件，如果使用我們軟件的人有意或者無意的修改瞭這兩個文件中的內容，我們的軟件極有可能就沒辦法運行瞭，因此，在分發我們的軟件的時候，要避免使用ui文件。

ui文件的好處是在開發的時候，可以迅速的通過Qt Creator修改UI。

解決辦法

當然PyQt也提供瞭很好的解決辦法，它提供瞭一個小腳本，可以幫我們把ui文件轉成py文件，並將UI轉換成類。我們通過運行下邊這兩條命令，將mainwindow和dialog轉成python類。

python -m PyQt5.uic.pyuic -x dialog.ui -o dialog.py
python -m PyQt5.uic.pyuic -x mainwindow.ui -o mainwindow.py

每一個ui文件會對應一個py文件，而py文件中會有相應的類。

有瞭py模塊以後，我們還需要在實例化ui的地方（也就是main.py）中將加載ui文件的方式改為實例化python類的方式來加載ui，分別要修改MainWindow和SendDialog的初始化函數，選擇2 option的方式來加載ui

class MainWindow(QMainWindow):
    """Main window"""
    def __init__(self):
        super(MainWindow, self).__init__()

        # UI setup - 1 option
        # dynamic load ui for development purpose
        # self.ui = loadUi('./mainwindow.ui', self)

        # Use py to setup UI - 2 option
        self.ui = Ui_MainWindow()
        self.ui.setupUi(self)

        self.setStatusBar(None)  # https://doc.qt.io/qt-5/qmainwindow.html#setStatusBa
class SendDialog(QDialog):
    def __init__(self, url_list, socket_server_thread, device_discover_thread, socket_broadcast):
        super(SendDialog, self).__init__()

        # UI setup - 1 option
        # dynamic load ui for development purpose
        # self.ui = loadUi('./dialog.ui', self)

        # Use py to setup UI - 2 option
        self.ui = Ui_dialog()
        self.ui.setupUi(self)

再次打包

代碼修正之後，我們來使用上邊相同的pyinstaller命令打包，成功運行後，點擊生成的wifidrop.exe，你會發現在無需ui文件的情況下，軟件也能很好的運行瞭。

代碼倉庫說明

本文中用到的打包命令和ui轉py命令，可以在github 倉庫 https://github.com/pythonlibrary/wifidrop 中的 tutorial-6-direct-dist 和 tutorial-6-dist tag下找到，這兩個tag的區別是：前一個使用瞭加載ui文件的方式顯示UI，後邊一個修正瞭這個問題，使用類實例化的方式顯示UI。

更多關於使用pyinstaller打包python程序的文章請查看下面的相關文章

推薦閱讀：