Pythonプログラムのexe化ガイド

【概要】

PyInstaller（Pythonプログラムを実行可能ファイルに変換するソフトウェア）を使用して，Pythonプログラムを実行可能ファイル（exe）に変換する方法を説明する．この方法により，Python実行環境がないパソコンでもプログラムを実行できるようになる．

【目次】

第１章　特徴と利点

1.1 使用技術の特徴

1.2 期待される効果

第２章　環境構築

動作環境（OS，機材）

Python 3.12 のインストール

Pythonのインストールを行い、Pythonのプログラムを実行する環境を整える。扱う環境は、Windows搭載パソコンである。金子研究室では、Python 3.12.10を推奨する。

[Windows での Python 3.12 のインストール手順を見るには、ここをクリック]

Windows での Python 3.12 のインストール

以下のいずれかの方法でPython 3.12をインストールする。Pythonがインストール済みの場合、この手順は不要である。

方法 1：winget によるインストール

【インストールコマンドの実行方法】

管理者権限でコマンドプロンプトを起動する（手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。そして、コマンド全体をコマンドプロンプトにコピー＆ペーストする。

--scope machine を指定することで、システム全体（全ユーザー向け）にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動するとPATHが反映される。

REM Python 3.12 をシステム領域にインストール
winget install --id Python.Python.3.12 -e --scope machine --silent --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_test=0 Include_pip=1 Include_launcher=1 InstallLauncherAllUsers=1 TargetDir=\"C:\Program Files\Python312\""
if not "%ERRORLEVEL%"=="0" ( color 0c & echo Python 3.12 のインストールに失敗しました & ping 127.0.0.1 -n 6 >nul & color )

REM Python と Scripts を PATH 先頭に追加
powershell -NoProfile -Command "$p='C:\Program Files\Python312'; $s=\"$p\Scripts\"; if(Test-Path $p){$k=[Microsoft.Win32.Registry]::LocalMachine.OpenSubKey('SYSTEM\CurrentControlSet\Control\Session Manager\Environment',$true); $c=$k.GetValue('Path','',[Microsoft.Win32.RegistryValueOptions]::DoNotExpandEnvironmentNames); $t=$k.GetValueKind('Path'); $new=$c; if((';'+$new+';') -notlike \"*;$p;*\"){$new=$p+';'+$new}; if((';'+$new+';') -notlike \"*;$s;*\"){$new=$s+';'+$new}; if($new -ne $c){$k.SetValue('Path',$new,$t)}; $k.Close()}"

REM 現在のセッションにも反映（システムPATHを再取得して連結）
for /f "usebackq tokens=2,*" %A in (`reg query "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /v Path`) do set "PATH=%B"

REM pip / wheel の更新
python -m pip install --no-user -U pip wheel
if not "%ERRORLEVEL%"=="0" ( color 0c & echo pip / wheel の更新に失敗しました & ping 127.0.0.1 -n 6 >nul & color )

方法 2：インストーラーによるインストール

  1. Python公式サイト（https://www.python.org/downloads/）にアクセスし、「Download Python 3.x.x」ボタンからWindows用インストーラーをダウンロードする。
  2. ダウンロードしたインストーラーを実行する。
  3. 初期画面の下部に表示される「Add python.exe to PATH」にチェックを入れてから「Customize installation」を選択する。このチェックを入れ忘れると、コマンドプロンプトから python コマンドを実行できない。
  4. 「Install Python 3.xx for all users」にチェックを入れ、「Install」をクリックする。

インストールの確認

コマンドプロンプトで以下を実行する。

python --version

バージョン番号（例：Python 3.12.x）が表示されればインストール成功である。「'python' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

第３章　プログラムファイルの準備

  1. コマンドプロンプトを開く（通常モードで良い）．Windowsキーを押して「cmd」と入力する．
  2. cdコマンドでプログラムの保存先に移動する．例えば，保存先をデスクトップにする場合は次のように入力する： 
    cd Desktop
  3. 以下のコマンドでプログラムファイルを作成する（notepad は「メモ帳」である）： 
    notepad hello.py
  4. 次のプログラムを入力し，Ctrl+Sキーを押して保存する（あるいは，メニューで保存操作を行う）： 
    print("Hello, World!\n")

第４章　PyInstaller の使用方法

  1. 仮想環境の作成と有効化：
    1. コマンドプロンプトでプログラムの保存先に移動する．例えば，保存先がデスクトップの場合は次のように入力する： 
      cd Desktop
    2. 仮想環境（独立したPython実行環境）を作成する： 
      python -m venv venv
    3. 仮想環境を有効化する： 
      venv\Scripts\activate

      コマンドプロンプトの先頭に(venv)と表示されることを確認する．

  2. 必要なパッケージのインストール：
    1. 仮想環境が有効化されていることを確認する（プロンプトの先頭に(venv)が表示されている）．
    2. PyInstallerをインストールする： 
      pip install -U --no-user pyinstaller
  3. Pythonプログラムの動作確認：
    1. 仮想環境が有効化されていることを確認する（プロンプトの先頭に(venv)が表示されている）．
    2. プログラムを実行する： 
      python hello.py
  4. 実行可能ファイルの生成：
    1. 仮想環境が有効化されていることを確認する．
    2. PyInstallerでexeファイルを生成する： 
      pyinstaller --onefile hello.py
  5. 実行可能ファイルの動作確認：
    1. distディレクトリに移動する： 
      cd dist
    2. 生成された実行可能ファイルを実行する： 
      hello.exe
  6. 作業完了後：
    1. 仮想環境を無効化する： 
      deactivate

第５章　パラメータ設定

PyInstallerのコマンドラインオプション：

第６章　出力データ

6.1 生成されるファイル

第７章　トラブルシューティング

7.1 PyInstallerのエラー

7.2 実行可能ファイルの問題