【配布用】Python スクリプトを実行ファイル化する PyInstaller を徹底解説！

my_project/
├── my_script.py
├── my_script.spec
├── build/
│   └── my_script/
│       ├── base_library.zip
│       ├── my_script.exe.manifest
│       ├── my_script.exe.pyi
│       ├── warn-my_script.txt
│       └── <その他の中間ファイル>
└── dist/
    └── my_script/
        ├── my_script.exe
        ├── <依存ファイル1>
        ├── <依存ファイル2>
        └── <その他の依存ファイル>

python --version

# 結果
# Python 3.11.7

pip install pyinstaller

pyinstaller --version

# 結果
# 6.6.0

print("hello, world")

pyinstaller myscript.py

pyinstaller --onefile --noconsole --icon=my_icon.ico --clean myscript.py

./dist/myscript

Hello, World!

Saving session...
...copying shared history...
...saving history...truncating history files...
...completed.

[プロセスが完了しました]

pyinstaller myscript.py

# -*- mode: python ; coding: utf-8 -*-

block_cipher = None

a = Analysis(
    ['myscript.py'],
    pathex=['/path/to/your/script'],
    binaries=[],
    datas=[],
    hiddenimports=[],
    hookspath=[],
    runtime_hooks=[],
    excludes=[],
    win_no_prefer_redirects=False,
    win_private_assemblies=False,
    cipher=block_cipher,
)
pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='myscript',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    upx_exclude=[],
    runtime_tmpdir=None,
    console=True,
)
coll = COLLECT(
    exe,
    a.binaries,
    a.zipfiles,
    a.datas,
    strip=False,
    upx=True,
    upx_exclude=[],
    name='myscript',
)

pyinstaller myscript.spec

exe = EXE(
    ・・・
    exclude_binaries=True,  # onefileオプション
    ・・・
)

# onefileのためにCOLLECTステップを削除

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='myscript',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    upx_exclude=[],
    runtime_tmpdir=None,
    console=False,  # noconsole オプション
)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,
    name='myscript',
    debug=False,
    bootloader_ignore_signals=False,
    strip=False,
    upx=True,
    upx_exclude=[],
    runtime_tmpdir=None,
    console=True,
    icon='path/to/icon.ico'
)

ModuleNotFoundError: No module named 'some_module'

# .specファイルの編集
a = Analysis(['my_script.py'],
             pathex=['/path/to/my_project'],
             hiddenimports=['some_module'],  # 見つからなかったモジュールを指定
             ...)

ImportError: DLL load failed: The specified module could not be found.

# .specファイルの編集
binaries=[('path/to/dll_or_shared_library', '.')]

FileNotFoundError: [Errno 2] No such file or directory: 'some_file'

# .specファイルの編集
datas=[('path/to/datafile', 'destination_directory')]

pyinstaller --onefile --debug=all my_script.py

import logging

logging.basicConfig(level=logging.DEBUG)
logging.debug("This is a debug message")

a = Analysis(
    ['myscript.py'],  # 対象の Python スクリプト名
    pathex=['/path/to/your/script'],  # スクリプトのパスを指定
    binaries=[],  # 追加のバイナリファイル(DLL, SOファイル)
    datas=[],  # 追加のデータファイル(画像、設定ファイルなど)
    hiddenimports=[],  # PyInstaller が自動検出できないモジュールのリスト
    hookspath=[],  # カスタムフックファイル
    runtime_hooks=[],  # アプリ実行時に実行されるスクリプトのリスト
    excludes=[],  # PyInstaller に含めないモジュールリスト
)

pyz = PYZ(a.pure, a.zipped_data)

exe = EXE(
    pyz,  # 一つ前のステップで作成した PYZ オブジェクト
    a.scripts,  # Analysis オブジェクトで解析されたスクリプト
    [],  # 追加の Python スクリプトを指定する場合に必要
    exclude_binaries=False,  # バイナリと実行ファイルを分離しない
    name='myscript',  # 実行ファイルの名前
)

coll = COLLECT(
    exe,  # 先に作成したEXEオブジェクト
    a.binaries,  # 解析されたバイナリのリスト
    a.zipfiles,  # 解析された圧縮ファイルのリスト
    a.datas,  # 解析されたエータファイルのリスト
    strip=False,  # デバッグ情報等を含めない
    upx=True,  # True にすると UPX で圧縮
    name='myscript',  # 出力ディレクトリ名を指定
)

exe = EXE(
    pyz,
    a.scripts,
    [],
    exclude_binaries=True,  # これがonefileに相当
    name='myscript',
)