如何让PyInstaller正确收集本地包以支持动态导入与二进制数据访问？

问题根源 #

PyInstaller的--collect-all参数针对的是已通过pip安装的正规Python包（具备包元数据），而你的mypackage只是本地目录下的源码包，未被注册为系统/虚拟环境中的正式distribution，因此PyInstaller无法识别它为有效包，导致资源收集失败；同时动态导入的子模块默认不会被PyInstaller扫描到，二进制资源的路径访问在打包后也会失效。

解决方案 #

方案一：手动编辑Spec文件（灵活可控，推荐） #

1. 先生成基础Spec文件：

   pyinstaller main.py --clean --noconfirm --onefile --windowed --hidden-import pyvisa_py
   

2. 打开生成的main.spec，修改Analysis部分：
   • 添加datas参数，将整个mypackage目录复制到打包后的镜像中：

     a = Analysis(
         ['main.py'],
         pathex=['/opt/mysoftware'],  # 确保项目根目录在Python路径中
         binaries=[],
         datas=[('mypackage', 'mypackage')],  # 格式：(本地源路径, 打包后目标路径)
         hiddenimports=['pyvisa_py', 'mypackage.package1.app', 'mypackage.package2.app'],  # 手动添加动态导入的子模块
         ...
     )
     

   • 如果子包数量多，可通过循环生成hiddenimports：

     hiddenimports = ['pyvisa_py'] + [f'mypackage.package{i}.app' for i in [1,2]]
     

3. 用修改后的Spec重新打包：

   pyinstaller main.spec --clean --noconfirm
   

方案二：将本地包安装为可编辑模式（适配PyInstaller的包识别逻辑） #

1. 为mypackage创建包配置文件（如果没有的话）：
   在项目根目录创建setup.py：

   from setuptools import setup, find_packages
   
   setup(
       name="mypackage",
       version="0.1.0",
       packages=find_packages(),
       package_data={
           "mypackage": ["*.bin"],  # 包含根目录下的二进制文件
           "mypackage.package1": ["*"],  # 若子包有资源，按需添加
           "mypackage.package2": ["*"],
       },
   )
   

2. 在虚拟环境中安装可编辑版本：

   source venv/bin/activate
   pip install -e .
   

3. 重新运行PyInstaller命令，此时--collect-all可正常工作：

   pyinstaller main.py --clean --noconfirm --onefile --windowed --hidden-import pyvisa_py --collect-all mypackage
   

关键补充：二进制资源访问适配 #

打包后本地文件路径会失效，需将代码中直接读取文件的逻辑改为使用Python标准库的资源访问方式：
原代码（可能失效）：

with open('mypackage/bindata1.bin', 'rb') as f:
    data = f.read()

修改为：

from importlib.resources import read_binary

# 读取mypackage下的bindata1.bin
data = read_binary('mypackage', 'bindata1.bin')

# 若读取子包资源（如package1下的文件）
data = read_binary('mypackage.package1', 'some_file.bin')

动态导入的额外保障 #

如果动态导入的子模块仍无法被识别，可创建PyInstaller钩子文件：
在项目根目录创建hook-mypackage.py：

from PyInstaller.utils.hooks import collect_submodules

# 收集所有以.app结尾的子模块
hiddenimports = collect_submodules('mypackage', filter=lambda name: name.endswith('.app'))

打包时指定钩子目录：

pyinstaller main.py --clean --noconfirm --onefile --windowed --hidden-import pyvisa_py --collect-all mypackage --additional-hooks-dir .

内容的提问来源于stack exchange，提问作者slarag