Python PyInstaller 打包成 Win、Mac 应用程序(app / exe)

20,888 阅读7分钟

一、简介

二、详细对比

Python 中,打包应用程序为独立的可执行文件有多种工具可选。每种工具各有优点,具体选择取决于你的需求。以下是几款常用的 Python 打包工具,以及它们各自的特点和使用场景推荐。

1. PyInstaller

  • 特点

    • 将 Python 脚本打包成单个可执行文件。
    • 支持 Windows、macOS、Linux。
    • 支持包含外部依赖的项目(例如 Tkinter、PyQt 等 GUI 库)。
    • 可以生成一个独立的应用程序包,用户不需要安装 Python 环境。
  • 优点

    • 简单易用,通常无需配置复杂的文件。
    • 支持将所有依赖打包到一个可执行文件中(--onefile)。
    • 生成的文件较为紧凑,适合简单的桌面应用程序。
  • 缺点

    • 对于较大的应用程序,生成的可执行文件体积可能较大。
    • 在 macOS 上签名和发布应用程序时,可能需要额外处理。
  • 推荐场景

    • 适合绝大多数桌面应用程序,尤其是需要快速打包并在多个平台上分发的项目。
  • 安装和使用

    $ pip install pyinstaller
    $ pyinstaller --onefile your_script.py
    

2. cx_Freeze

  • 特点

    • 专为 Python 脚本打包成可执行文件。
    • 跨平台支持 Windows、macOS 和 Linux。
    • 相较于 PyInstaller,cx_Freeze 的生成过程更加灵活,可用于创建更复杂的打包配置。
  • 优点

    • 更加灵活的打包选项,适合需要详细控制打包过程的场景。
    • 支持将 Python 解释器和库文件包含在打包后的文件中。
  • 缺点

    • 配置相对复杂,尤其是当项目包含许多依赖时。
    • 在某些情况下,生成的可执行文件可能体积较大。
  • 推荐场景

    • 适用于需要自定义打包选项的大型项目。
  • 安装和使用

    $ pip install cx_Freeze
    $ cxfreeze your_script.py --target-dir dist/
    

3. Py2exe(仅适用于 Windows)

  • 特点

    • 专门用于将 Python 程序打包成 Windows 可执行文件。
    • 只支持 Windows 平台,不支持 macOS 和 Linux。
  • 优点

    • 针对 Windows 用户进行了优化,生成的可执行文件运行效率较高。
    • 能生成 .exe 文件,适合 Windows 用户分发应用程序。
  • 缺点

    • 仅适用于 Windows 平台,跨平台支持较差。
    • 与其他工具相比,依赖库支持稍弱。
  • 推荐场景

    • 适合 Windows 平台的桌面应用程序打包需求。
  • 安装和使用

    $pip install py2exe
    $python setup.py py2exe
    

4. Nuitka

  • 特点

    • 将 Python 脚本转换为 C 语言并进行编译,生成的二进制文件运行速度更快。
    • 支持将 Python 脚本打包成独立的可执行文件。
  • 优点

    • 编译后的可执行文件速度更快,因为它将 Python 代码转换成了原生的二进制代码。
    • 支持较为复杂的项目,可以显著提高应用的性能。
  • 缺点

    • 打包过程较慢,生成文件体积可能较大。
    • 对于非常复杂的项目,可能需要处理更多的依赖问题。
  • 推荐场景

    • 适用于需要优化性能的 Python 应用,尤其是计算密集型应用程序。
  • 安装和使用

    $ pip install nuitka
    $ nuitka --standalone --onefile your_script.py
    

5. Briefcase(属于 BeeWare 项目)

  • 特点

    • 将 Python 应用程序打包成本地化平台的应用程序(包括桌面应用和移动应用)。
    • 支持 macOS、Windows、Linux,以及移动平台(iOS 和 Android)。
  • 优点

    • 提供一个完整的应用程序框架,适合开发跨平台的桌面和移动应用程序。
    • 易于集成 GUI 库(如 Tkinter、Kivy 等)。
  • 缺点

    • 打包过程较复杂,不如 PyInstaller 等工具简洁。
    • 对于移动平台的支持需要额外的配置。
  • 推荐场景

    • 适用于需要跨平台(包括桌面和移动端)发布的应用程序。
  • 安装和使用

    $ pip install briefcase
    $ briefcase new
    $ briefcase build
    $ briefcase package
    

工具选择建议

  • PyInstaller:如果你需要快速生成跨平台的可执行文件,且项目较为简单,PyInstaller 是首选。它是使用最广泛、配置最简单的工具。
  • cx_Freeze:适合需要更多打包控制的项目,尤其是在大型桌面应用程序中,它提供更灵活的打包方式。
  • Py2exe:如果你只需在 Windows 上分发应用程序,可以考虑使用 Py2exe,特别是当你针对 Windows 用户时。
  • Nuitka:如果性能是关键因素,并且你希望加速 Python 脚本的运行速度,Nuitka 是不错的选择。
  • Briefcase:当你需要跨平台的桌面和移动应用时,Briefcase 是一个非常现代化且全面的工具。

总体来说,PyInstaller 是最推荐的工具,因为它易于使用、支持多个平台,并且在大多数场景下都能很好地工作。

三、使用说明

  • pyinstaller 能够在 WindowsLinuxMac 等操作系统下将 Python 源文件打包,通过对源文件打包, Python 程序可以在没有安装 Python 的环境中运行,也可以作为一个独立文件方便传递和管理。

  • PyInstaller 支持 Python 2.7Python 3.3+。可以在 WindowsMacLinux 上使用,但是并不是跨平台的,而是说要是希望打包成 .exe 文件,需要在Windows 系统上运行 PyInstaller 进行打包工作;打包成 Mac App,需要在 Mac OS 上使用,Linux 也一样,不能在一端上打另外两段的包,还有 Mac m1 的打包不能给 Mac intel 的使用,相反也一样,运行会报错:Error:Bad CPU type in executable。

  • pyinstaller 不需要自己写 setup.py 文件,只需要在工作目录中输入打包命令即可。最后会生成 builddist 文件夹,启动文件在 dist 文件夹下。

  • 安装

    $ pip install pyinstaller
    

    安装后如果有警告 pip 版本低了,升级下

    WARNING: You are using pip version 22.0.4; however, version 22.3.1 is available.
    You should consider upgrading via the '/Users/dengzemiao/.pyenv/versions/3.10.3/bin/python3.10 -m pip install --upgrade pip' command.
    
    $ python -m pip install --upgrade pip
    
  • 升级(备用)

    $ pip install --upgrade pyinstaller
    
  • 切换到工作目录

    $ cd xxxx/xxx
    
  • 打包命令

    Mac 默认不能打包出 Windowsexe,相反同理,就算能做到也怕存在兼容问题,两端打包命令是一样的,在不同环境生成的就是对应环境的软件。

    # 直接打包,会有多个文件,点击打开会有终端窗口弹出
    $ pyinstaller [项目启动文件]
    
    # 直接打包,只有一个 app 文件,点击打开不会有终端窗口弹出,会直接启动
    $ pyinstaller --onefile --windowed ui.py
    
    # 添加 图标
    # 请注意,macOS 使用 `.icns` 格式的图标。如果你有其他格式的图标(例如 `.png`),可以使用在线工具将其转换为 `.icns`。
    $ pyinstaller --onefile --windowed --icon=app_icon.icns ui.py
    

    其他参数(按需求选择):打包完毕后在 dist 文件夹下双击项目启动文件就可以了

    • --onefile: 将所有内容打包成一个可执行文件。

    • --windowed: 不显示终端窗口,适用于 GUI 应用程序,将你的 Python 程序打包成 macOS 上的 .app 格式应用程序。

    • -F:表示在 dist 文件夹下只生成单个可执行文件(内部包含所有依赖),不加默认会在 dist 生成一大堆依赖文件 + 可执行文件。

    • -D:与 -F 相反用法。

    • -W:表示去掉控制台窗口,如果你的程序是有界面的,可以不写这个参数。但是测试情况下建议先加上这个参数,因为如果打包不成功,运行时报错信息会在控制台上输出,没有控制台就看不到报错信息。

    • -c:表示去掉窗框,使用控制台。

    • -p:表示自己定义需要加载的类路径,项目中包含多个自建模块的时候需要加上 -p aaa.py -p bbb.py -p ccc.py

    • -i:表示可执行文件的图标,后面跟图标的路径(例 -i "icon.icns"Mac 下图标文件为 icns 格式, Winico 格式)。

    • --name:设置打包后的应用名称,例 --name "小程序"

    • --hidden-import:后面跟模块名如 queue,用于告诉打包程序某个模块我用不着你不用打包进去。

    iShot_2022-11-20_01.17.24.png

    # 常用打包参数
    # -F -D 互斥参数
    -F  打包成一个 exe 文件,小项目可以采用,打开比较慢,多个 .py 打包时不能使用
    -D  默认参数,打包结果放入到创建的文件夹中,可以看到里面有很多的依赖文件
    
    # -w -c 互斥参数
    -w  使用项目的 GUI 界面,无 cmd 控制台
    -c  默认参数,使用 cmd 控制台 如果打包文件执行报错,可尝试用 -c 显示控制台
    
    -n  执行项目的名称,默认 .py 的文件名
    -i  将 ico 图标打包到 exe 文件中,(例 `-i "icon.icns"`,`Mac` 下图标文件为 `icns` 格式, `Win` 为`ico` 格式)。
    
    --hidden-import 打包时导包信息
    # 打包 PyQt 项目强烈建议 带上以下参数
    --hidden-import PyQt5.sip
    
    # 打包命令示例
    # 在项目的根目录下执行打包命令
    $ pyinstaller -w xxx.py --hidden-import PyQt5.sip
    
    # 打包结果输出在项目根目录下的 dist 文件夹中
    # 不建议使用 -F 打包成一个 exe 文件 所谓:打包一时爽,打开 5 秒钟
    # 非 -F 命令下, 静态资源、建好的 Sqlite 数据库可以直接放入 dist 中生成的文件夹中
    

三、打包

  • 进入到工作目录,直接打包。

  • 打包方式一

    # 【推荐】打包后的应用程序体积大,但是只有首次慢点,后面都快,
    # 不建议使用 -F 打包成一个 exe 文件 所谓:打包一时爽,打开 5 秒钟
    $ pyinstaller demo.py
    

    优点

    1、很容易在文件夹中查看 `pyinstaller` 收集的所有依赖库信息,文件较多。
    
    2、方便发布新的可执行程序。如果脚本依赖库没有任何的变化,那么下次可以直接发布新的可执行程序即可,用户只需要在之前的文件夹中替换可执行文件就能使用。
    
    3、启动速度快,首次会慢点。
    

    缺点

    打出来的包体积大。
    
  • 打包方式二

    # 打包后的应用程序体积小,但是启动慢,每次起码 5 秒干等
    $ pyinstaller --onefile --windowed demo.py
    

    优点

    1、就一个可执行文件,它包含了运行所需要的所有文件,可以直接发布这个工具。
    
    2、文件体积小。
    

    缺点

    但是执行速度慢,而且每次重新启动都慢。
    
  • 执行打包命令后,如果报错:附 完美解决 Python library not found: libpython3.10m.dylib, Python3, .Python, libpython3....

    OSError: Python library not found: .Python, Python, Python3, libpython3.10.dylib, libpython3.10m.dylib
    This means your Python installation does not come with proper shared library files.
    This usually happens due to missing development package, or unsuitable build parameters of the Python installation.
    
    * On Debian/Ubuntu, you need to install Python development packages:
      * apt-get install python3-dev
      * apt-get install python-dev
    * If you are building Python by yourself, rebuild with `--enable-shared` (or, `--enable-framework` on macOS).
    

    解决后,就可以继续执行上面的打包命令了。打包成功后 app/exe 会在 dist 文件夹中。

    推荐 Python virturalenv + pyinstaller 最小化打包 python 程序 !!!!

四、打包进阶

Mac

1、签名和发布

macOS 上应用程序分发时,通常需要对应用进行签名,以便通过 macOS 的安全检查。如果你希望分发给其他人使用并且不想显示“未验证的开发者”警告,通常需要对应用进行代码签名,并可能需要在 Apple 开发者账户上进行公证。

代码签名命令示例(假设你已经拥有开发者证书):

$ codesign --deep --force --verbose --sign "Developer ID Application: Your Name (Team ID)" dist/your_script.app

2、打包为 .dmg.zip

  • 使用 hdiutil 创建 .dmg 镜像:

    $ hdiutil create -volname "MyApp" -srcfolder "dist/your_script.app" -ov -format UDZO "your_script.dmg"
    
  • 或创建一个 .zip 文件:

    $ zip -r your_script.zip dist/your_script.app
    

如果需要分发应用,考虑使用 .dmg.zip 格式进行打包,并且可以对应用进行签名和公证。