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

1. 概要

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

2. 特徴と利点

2.1 使用技術の特徴

2.2 期待される効果

3. 環境構築

動作環境(OS,機材)

Python 3.12 のインストール

以下のいずれかの方法で Python 3.12 をインストールする。

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

Python がインストール済みの場合、この手順は不要である。管理者権限コマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。

winget install -e --id Python.Python.3.12 --scope machine --silent --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 AssociateFiles=1 InstallLauncherAllUsers=1"

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

方法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' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

4. プログラムファイルの準備

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

5. PyInstaller の使用方法

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

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

  2. 必要なパッケージのインストール:
    1. 仮想環境が有効化されていることを確認する(プロンプトの先頭に`(venv)`が表示されている)
    2. PyInstallerをインストールする:
      pip install 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

6. パラメータ設定

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

7. 出力データ

7.1 生成されるファイル

8. トラブルシューティング

8.1 PyInstallerのエラー

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