解决actions/setup-python项目中macOS平台PyInstaller构建universal2二进制文件的兼容性问题

在Python项目打包过程中，PyInstaller是一个常用的工具，它能够将Python应用打包成独立的可执行文件。然而，在macOS平台上，特别是当我们需要构建支持多种架构的universal2二进制文件时，可能会遇到一些兼容性问题。

问题背景

在macOS平台上，universal2二进制文件可以同时包含x86_64和arm64两种架构的代码，这使得同一个二进制文件能够在Intel芯片和Apple Silicon芯片的Mac上运行。但在实际使用PyInstaller构建过程中，开发者可能会遇到如下错误提示：

PyInstaller.utils.osx.IncompatibleBinaryArchError: markupsafe/_speedups.cpython-312-darwin.so is not a fat binary!

这个错误表明PyInstaller在尝试构建universal2格式的二进制文件时，发现某些依赖库并不支持多架构格式。

问题根源分析

经过深入分析，这个问题主要由以下几个因素导致：

1. Python解释器架构不匹配：使用的Python解释器可能本身就不支持universal2架构，或者安装时只针对特定架构进行了编译。

2. 依赖库架构限制：项目依赖的某些第三方库（如示例中的markupsafe）可能只提供了单一架构的二进制版本。

3. 构建环境配置：GitHub Actions的macOS运行器环境可能存在特定配置，影响了多架构构建过程。

解决方案

针对这个问题，我们有以下几种解决方案：

方案一：明确指定目标架构

如果项目不需要同时支持Intel和Apple Silicon芯片，可以明确指定目标架构：

poetry run pyinstaller --target-architecture arm64 --add-data "ksso/success_message.html:ksso" --onefile ksso/main.py

或者对于Intel芯片：

poetry run pyinstaller --target-architecture x86_64 --add-data "ksso/success_message.html:ksso" --onefile ksso/main.py

方案二：检查并重建依赖库

对于不兼容的依赖库，可以尝试从源码重新编译：

1. 卸载有问题的库：pip uninstall markupsafe
2. 从源码安装：pip install --no-binary markupsafe markupsafe

方案三：使用兼容的Python环境

确保使用的Python环境本身支持universal2架构：

- name: Set up python
  uses: actions/setup-python@v4
  with:
    python-version: '3.12'
    architecture: 'x64'  # 或'arm64'，根据需要选择

最佳实践建议

1. 分架构构建：考虑为不同架构分别构建，而不是强制使用universal2。

2. 环境隔离：使用虚拟环境确保依赖的一致性。

3. 依赖管理：明确指定依赖版本，避免不兼容的更新。

4. 持续集成测试：在CI流程中加入多架构测试环节。

总结

在macOS平台上使用PyInstaller构建universal2二进制文件时，开发者需要注意Python环境、依赖库和目标架构之间的兼容性。通过明确指定架构、重建依赖库或使用兼容的Python环境，可以有效解决构建过程中的兼容性问题。对于大多数项目来说，分架构构建可能是更可靠的选择，除非确实需要同时支持Intel和Apple Silicon芯片的Mac设备。