PyInstaller打包Python腳本的使用示例
1. 寫在前面
通常,在用 Python 編寫完一個腳本后,需要將它部署并集成到一個更大的項目中。常見的集成方式有以下幾種:
- 使用 PyInstaller 打包。
- 使用 Docker 打包。
- 將 Python 嵌入到 C++ 代碼中,并封裝成類。
- 將 Python 代碼轉換為 C++ 代碼。
本文介紹其中一種方式——使用 PyInstaller 打包。通過 PyInstaller,可以將 Python 腳本打包成 .exe 文件(適用于 Windows)或適用于 macOS 和 Linux 的可執(zhí)行文件,用戶無需安裝 Python 或任何相關依賴,便能直接運行程序。
主要優(yōu)勢:
- 將 Python 腳本打包成獨立可執(zhí)行文件,方便分發(fā)和運行。
- 支持單文件打包、圖標定制、以及額外文件的捆綁。
- 可選隱藏控制臺窗口,適合圖形化應用(GUI)程序。
適用場景:
- 發(fā)布桌面工具或命令行程序。
- 讓沒有 Python 環(huán)境的用戶也能使用你的工具。
- 分享自包含的 Python 項目,確保目標機器能夠順利運行。
2. 打包指令解析與參數(shù)詳解
| 參數(shù)名 | 描述 | 示例 | 類型 | 必須 | 默認值 |
|---|---|---|---|---|---|
| --onefile | 將所有依賴文件打包為單個可執(zhí)行文件。 | pyinstaller --onefile example.py | bool | 否 | False |
| --noconsole | 隱藏控制臺窗口(適用于 GUI 應用)。 | pyinstaller --noconsole gui_app.py | bool | 否 | False |
| --name | 指定生成的可執(zhí)行文件名稱。 | pyinstaller --name=my_app example.py | str | 否 | 源文件名(無擴展) |
| --icon | 設置可執(zhí)行文件的圖標(需提供 .ico 文件)。 | pyinstaller --icon=app_icon.ico example.py | str | 否 | None |
| --add-data | 捆綁額外文件(如配置文件、靜態(tài)資源等)。 | pyinstaller --add-data "config.yaml;." example.py | str | 否 | None |
| --clean | 清理之前的構建緩存,強制重新打包。 | pyinstaller --clean example.py | bool | 否 | False |
| --hidden-import | 手動添加隱藏的依賴模塊(通常是自動檢測遺漏的依賴)。 | pyinstaller --hidden-import=requests example.py | list | 否 | 自動檢測 |
3. 基礎步驟
1. 安裝 PyInstaller
在終端(或命令行)中運行以下命令,安裝 PyInstaller:
pip install pyinstaller
2. 使用基礎命令進行打包
假設你有一個 Python 腳本 example_script.py,使用下面的命令將其打包為一個獨立的可執(zhí)行文件:
pyinstaller --onefile example_script.py
- 該命令會將所有依賴項和代碼打包成一個單一的
.exe文件。 - 打包后,可以在
dist目錄下找到生成的可執(zhí)行文件。
4. 常見的用法示例
示例 1:基礎打包
將 example_script.py 打包為一個單文件可執(zhí)行程序:
pyinstaller --onefile example_script.py
示例 2:自定義名稱和圖標
將輸出文件命名為 my_program.exe,并指定圖標文件為 app_icon.ico:
pyinstaller --onefile --name=my_program --icon=app_icon.ico example_script.py
示例 3:捆綁額外文件
將配置文件 config.yaml 一起捆綁進可執(zhí)行文件:
pyinstaller --onefile --add-data "config.yaml;." example_script.py
注意:在 Windows 系統(tǒng)中,路徑分隔符用分號 ;,而在 macOS/Linux 中使用冒號 :。
示例 4:解決缺失依賴問題
如果在運行時遇到某個模塊丟失的錯誤,可以通過 --hidden-import 指定手動引入依賴:
pyinstaller --onefile --hidden-import=requests example_script.py
示例 5:隱藏控制臺窗口
適用于圖形界面(GUI)應用程序,運行時隱藏控制臺窗口:
pyinstaller --onefile --noconsole gui_app.py
5. 注意事項(路徑)
路徑問題:使用
--add-data時,不同操作系統(tǒng)的路徑分隔符需特別注意。- Windows:
"source;destination" - macOS/Linux:
"source:destination"
- Windows:
文件路徑問題:在代碼中訪問本地文件時,使用相對路徑獲取的文件可能會在打包后無法找到。此時,建議使用以下方式獲取正確的文件路徑:
BASE_DIR = os.path.dirname(os.path.realpath(sys.argv[0]))
6. 錯誤處理和日志記錄
在打包的 Python 應用中,為了方便調試,可以加入錯誤處理代碼,將錯誤信息記錄到文件中,幫助定位問題。
try:
# 代碼邏輯
pass
except Exception as e:
print("An error occurred:", e)
with open("error_log.txt", "w") as f:
f.write(str(e))
如果可執(zhí)行文件出現(xiàn)問題,能夠在 error_log.txt 中查看詳細的錯誤信息。
例如,

這就是一個文件路徑錯誤的報錯,原因在于生成的可執(zhí)行文件是在 dist 目錄下,但是文件路徑是相對路徑,在 ../ 上,知道問題就可以解決了。否則,有時候連報錯都不知道在哪。
另外,如果想要更加優(yōu)雅地打包python,建議配合以下教程食用:
Python 參數(shù)配置使用 XML 文件的教程:輕松管理你的項目配置
到此這篇關于PyInstaller打包Python腳本的使用示例的文章就介紹到這了,更多相關PyInstaller打包Python腳本內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
- 使用PyInstaller將Python腳本打包成exe的新手入門指南
- PyInstaller將Python打包成windows可執(zhí)行的exe(細致版)
- PyInstaller將Python腳本打包為可執(zhí)行文件的完整指南
- Python利用PyInstaller庫實現(xiàn)將腳本一鍵打包為EXE文件
- 使用PyInstaller打包Python腳本為可執(zhí)行文件的詳細指南
- 如何使用Python腳本控制PyInstaller打包實戰(zhàn)詳解
- python使用pyinstaller將代碼打包為exe程序
- 使用PyInstaller輕松實現(xiàn)將Python腳本打包成獨立的.exe可執(zhí)行文件
相關文章
Pytorch 實現(xiàn)focal_loss 多類別和二分類示例
今天小編就為大家分享一篇Pytorch 實現(xiàn)focal_loss 多類別和二分類示例,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-01-01
python腳本實現(xiàn)音頻m4a格式轉成MP3格式的實例代碼
這篇文章主要介紹了python腳本實現(xiàn)音頻m4a格式轉成MP3格式的實例代碼,非常不錯,具有一定的參考借鑒價值,需要的朋友可以參考下2019-10-10
pycharm社區(qū)版安裝node.js插件運行js代碼方法
PyCharm可以說是當今最流行的一款Python IDE了,下面這篇文章主要給大家介紹了關于pycharm社區(qū)版安裝node.js插件運行js代碼的相關資料,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2023-10-10
Django利用elasticsearch(搜索引擎)實現(xiàn)搜索功能
這篇文章主要介紹了Django利用elasticsearch(搜索引擎)實現(xiàn)搜索功能,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2020-11-11
Python爬取用戶觀影數(shù)據(jù)并分析用戶與電影之間的隱藏信息!
看電影前很多人都喜歡去 『豆瓣』 看影評,所以我爬取44130條 『豆瓣』 的用戶觀影數(shù)據(jù),分析用戶之間的關系,電影之間的聯(lián)系,以及用戶和電影之間的隱藏關系,需要的朋友可以參考下2021-06-06

