`PyInstaller` 和`importlib`搭配使用

PyInstaller 和importlib搭配使用

PyInstaller 是一个流行的工具，可以将 Python 应用程序转换为独立的可执行文件。当处理动态导入或像 importlib 这样的包时，会遇到编译出来的exe文件无法加载动态import，因为 PyInstaller 需要检测到你的应用程序使用的所有依赖项。

基本的 PyInstaller 命令

首先，确保你已经安装了 PyInstaller：

pip install pyinstaller

要创建可执行文件，可以运行：

pyinstaller your_script.py

处理 importlib

importlib 允许动态导入模块，这些模块可能不会被 PyInstaller 自动检测到。你可以通过使用 hook 来帮助 PyInstaller 检测这些模块。

为 importlib 创建一个 Hook

1. 创建一个 hook 文件：创建一个名为 hook-importlib.py 的文件。

2. 指定隐藏导入：在文件中添加以下内容。这将列出 importlib 动态导入的模块。

   from PyInstaller.utils.hooks import collect_submodules
   
   hiddenimports = collect_submodules('your_dynamic_module')
   

   将 'your_dynamic_module' 替换为你使用 importlib 动态导入的模块。

3. 在 PyInstaller 命令中指定 hook：运行 PyInstaller 时，指定你的 hook 文件的路径。

   pyinstaller --additional-hooks-dir=. your_script.py
   

示例

假设你有一个脚本 example.py 使用 importlib 动态导入模块：

import importlib

module_name = 'some_module'
module = importlib.import_module(module_name)
module.some_function()

1. 创建 hook 文件：hook-some_module.py 内容如下：

   from PyInstaller.utils.hooks import collect_submodules
   
   hiddenimports = collect_submodules('some_module')
   

2. 使用 hook 运行 PyInstaller：

   pyinstaller --additional-hooks-dir=. example.py
   

故障排除

• 使用 --onefile：这会将所有内容打包成一个单独的可执行文件，这通常更方便。

  pyinstaller --onefile --additional-hooks-dir=. example.py
  

• 检查错误：如果你的可执行文件没有按预期工作，请从命令行运行它以查看错误消息。

• 手动隐藏导入：如果自动收集不起作用，你可以手动列出模块。

  hiddenimports = [
      'some_module',
      'some_module.sub_module',
      # 添加其他模块
  ]
  

通过创建 hooks 并确保正确指定所有动态导入，即使使用 importlib 进行动态模块加载，你也可以成功地使用 PyInstaller 打包你的 Python 应用程序。