PyInstaller.exceptions.ImportErrorWhenRunningHook:

[zh-ffmc]

I am trying to create an installer for my project for which I built a tkinter gui output but wile trying to package it i persistantly get this error and can't seem to solve it.

Would appreciate if someone can help point me in the right direction, Thanks

$ tree
.
├── code
│ ├── data.py
│ ├── gui.py
│ ├── input
│ ├── main.py
│ └── workflow.py
├── output
│ ├── model_pretty_print.txt
│ └── variables.xlsx
├── requirements.txt

$ pyinstaller --onefile --windowed code/gui.py  
72 INFO: PyInstaller: 6.8.0, contrib hooks: 2024.7
72 INFO: Python: 3.10.12
73 INFO: Platform: Linux-5.15.153.1-microsoft-standard-WSL2-x86_64-with-glibc2.35
73 INFO: Python environment: /usr
78 INFO: wrote /mnt/wsl/docker-desktop-bind-mounts/Ubuntu/0d34af67bb5657997f33d333feda9e02601dd005d1607d8f0bc5270a07720a3b/gui.spec
97 INFO: Module search paths (PYTHONPATH):
['/usr/lib/python310.zip',
 '/usr/lib/python3.10',
 '/usr/lib/python3.10/lib-dynload',
 '/home/dev/.local/lib/python3.10/site-packages',
 '/usr/local/lib/python3.10/dist-packages',
 '/usr/lib/python3/dist-packages',
 '/mnt/wsl/docker-desktop-bind-mounts/Ubuntu/0d34af67bb5657997f33d333feda9e02601dd005d1607d8f0bc5270a07720a3b/code']
236 INFO: checking Analysis
238 INFO: Building Analysis because Analysis-00.toc is non existent
238 INFO: Running Analysis Analysis-00.toc
238 INFO: Target bytecode optimization level: 0
238 INFO: Initializing module dependency graph...
238 INFO: Caching module graph hooks...
241 INFO: Analyzing base_library.zip ...
551 INFO: Loading module hook 'hook-heapq.py' from '/home/dev/.local/lib/python3.10/site-packages/PyInstaller/hooks'...
580 INFO: Loading module hook 'hook-encodings.py' from '/home/dev/.local/lib/python3.10/site-packages/PyInstaller/hooks'...
1195 INFO: Loading module hook 'hook-pickle.py' from '/home/dev/.local/lib/python3.10/site-packages/PyInstaller/hooks'...
1715 INFO: Caching module dependency graph...
1809 INFO: Looking for Python shared library...
1819 INFO: Using Python shared library: /usr/lib/x86_64-linux-gnu/libpython3.10.so
1819 INFO: Analyzing /mnt/wsl/docker-desktop-bind-mounts/Ubuntu/0d34af67bb5657997f33d333feda9e02601dd005d1607d8f0bc5270a07720a3b/code/gui.py
1879 INFO: Loading module hook 'hook-_tkinter.py' from '/home/dev/.local/lib/python3.10/site-packages/PyInstaller/hooks'...
1909 INFO: Loading module hook 'hook-workflow.py' from '/home/dev/.local/lib/python3.10/site-packages/_pyinstaller_hooks_contrib/hooks/stdhooks'...
Traceback (most recent call last):
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/depend/imphook.py", line 383, in _load_hook_module
    self._hook_module = importlib_load_source(self.hook_module_name, self.hook_filename)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/compat.py", line 583, in importlib_load_source
    mod_loader.exec_module(mod)
  File "<frozen importlib._bootstrap_external>", line 883, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "/home/dev/.local/lib/python3.10/site-packages/_pyinstaller_hooks_contrib/hooks/stdhooks/hook-workflow.py", line 15, in <module>
    datas = copy_metadata('workflow')
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/utils/hooks/__init__.py", line 957, in copy_metadata
    dist = importlib_metadata.distribution(package_name)
  File "/usr/lib/python3.10/importlib/metadata/__init__.py", line 969, in distribution
    return Distribution.from_name(distribution_name)
  File "/usr/lib/python3.10/importlib/metadata/__init__.py", line 548, in from_name
    raise PackageNotFoundError(name)
importlib.metadata.PackageNotFoundError: No package metadata was found for workflow

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/dev/.local/bin/pyinstaller", line 8, in <module>
    sys.exit(_console_script_run())
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/__main__.py", line 231, in _console_script_run
    run()
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/__main__.py", line 215, in run
    run_build(pyi_config, spec_file, **vars(args))
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/__main__.py", line 70, in run_build
    PyInstaller.building.build_main.main(pyi_config, spec_file, **kwargs)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/building/build_main.py", line 1216, in main
    build(specfile, distpath, workpath, clean_build)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/building/build_main.py", line 1156, in build
    exec(code, spec_namespace)
  File "/mnt/wsl/docker-desktop-bind-mounts/Ubuntu/0d34af67bb5657997f33d333feda9e02601dd005d1607d8f0bc5270a07720a3b/gui.spec", line 4, in <module>
    a = Analysis(
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/building/build_main.py", line 556, in __init__
    self.__postinit__()
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/building/datastruct.py", line 184, in __postinit__
    self.assemble()
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/building/build_main.py", line 696, in assemble
    program_scripts.append(self.graph.add_script(script))
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/depend/analysis.py", line 268, in add_script
    self._top_script_node = super().add_script(pathname)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 1160, in add_script
    self._process_imports(n)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 2591, in _process_imports
    target_modules = self._safe_import_hook(*import_info, **kwargs)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/depend/analysis.py", line 437, in _safe_import_hook
    ret_modules = super()._safe_import_hook(
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 2048, in _safe_import_hook
    target_modules = self.import_hook(
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 1232, in import_hook
    target_package, target_module_partname = self._find_head_package(
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 1411, in _find_head_package
    target_package = self._safe_import_module(
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/depend/analysis.py", line 501, in _safe_import_module
    return super()._safe_import_module(module_basename, module_name, parent_package)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 1792, in _safe_import_module
    self._process_imports(n)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 2591, in _process_imports
    target_modules = self._safe_import_hook(*import_info, **kwargs)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/depend/analysis.py", line 437, in _safe_import_hook
    ret_modules = super()._safe_import_hook(
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 2048, in _safe_import_hook
    target_modules = self.import_hook(
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 1232, in import_hook
    target_package, target_module_partname = self._find_head_package(
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 1411, in _find_head_package
    target_package = self._safe_import_module(
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/depend/analysis.py", line 501, in _safe_import_module
    return super()._safe_import_module(module_basename, module_name, parent_package)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 1792, in _safe_import_module
    self._process_imports(n)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/lib/modulegraph/modulegraph.py", line 2591, in _process_imports
    target_modules = self._safe_import_hook(*import_info, **kwargs)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/depend/analysis.py", line 368, in _safe_import_hook
    excluded_imports = self._find_all_excluded_imports(source_module.identifier)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/depend/analysis.py", line 356, in _find_all_excluded_imports
    excluded_imports.update(module_hook.excludedimports)
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/depend/imphook.py", line 316, in __getattr__
    self._load_hook_module()
  File "/home/dev/.local/lib/python3.10/site-packages/PyInstaller/depend/imphook.py", line 386, in _load_hook_module
    raise ImportErrorWhenRunningHook(self.hook_module_name, self.hook_filename)
PyInstaller.exceptions.ImportErrorWhenRunningHook: Failed to import module __PyInstaller_hooks_0_workflow required by hook for module /home/dev/.local/lib/python3.10/site-packages/_pyinstaller_hooks_contrib/hooks/stdhooks/hook-workflow.py. Please check whether module __PyInstaller_hooks_0_workflow actually exists and whether the hook is compatible with your version of /home/dev/.local/lib/python3.10/site-packages/_pyinstaller_hooks_contrib/hooks/stdhooks/hook-workflow.py: You might want to read more about hooks in the manual and provide a pull-request to improve PyInstaller.

[rokm]

That's because all your modules effectively top-level modules, and so workflow from your codebase is triggering a hook for workflow package.

Either:

• rename your workflow module
• organize your top-level modules into a package, e.g.: code/main.py, code/mypackage/data.py, code/mypackage/gui.py, code/mypackage/input, code/mypackage/workflow.py, etc.
• remove the problematic hook (/home/dev/.local/lib/python3.10/site-packages/_pyinstaller_hooks_contrib/hooks/stdhook/hook-workflow.py)
• create a directory called extra-hooks, create empty extra-hooks/hook-workflow.py inside of it, and pass this directory to pyinstaller via --additional-hooks-dir extra-hooks (This will run the new no-op hook for workflow instead of the one from pyinstaller-hooks-contrib).

[zh-ffmc]

That worked like a charm, Thank you for helping me out :)