[Python] Py2exeで生成したexeファイル単体で実行できるようにビルドする方法

Py2exeは、PythonスクリプトをWindows用の実行可能ファイル（exe）に変換するツールです。

通常、生成されたexeファイルは依存ファイルと共に配布されますが、特定の設定を行うことで単体で実行可能なexeファイルを作成することができます。

これにより、Pythonがインストールされていない環境でもスクリプトを実行することが可能になります。

Py2exeを使用する際は、setupスクリプトでオプションを適切に設定し、必要なライブラリを含めることが重要です。

単体で実行可能なexeファイルの作成

Pythonプログラムを単体で実行可能なexeファイルに変換する際、依存ファイルの管理や設定が重要です。

以下では、依存ファイルの確認と対策、setup.pyの修正、再ビルドと動作確認の手順を詳しく解説します。

依存ファイルの確認と対策

Pythonプログラムが依存しているライブラリやモジュールを正しく管理することは、exeファイルを正常に動作させるために不可欠です。

依存ファイルのリストアップ

依存ファイルをリストアップするためには、以下の方法を用います。

• pip freezeコマンドを使用して、インストールされているパッケージの一覧を取得
• プログラム内で使用しているモジュールを手動で確認

pip freeze > requirements.txt

依存ファイルの同梱方法

依存ファイルをexeファイルに同梱するためには、setup.pyの設定を行います。

特に、data_filesオプションを使用して、必要なファイルを指定します。

setup.pyの修正

setup.pyは、Py2exeを使用してexeファイルを生成する際の設定ファイルです。

ここでの設定が、最終的なexeファイルの動作に影響を与えます。

bundle_filesオプションの設定

bundle_filesオプションを設定することで、依存ファイルをどのようにパッケージングするかを指定できます。

以下のように設定します。

setup(
    options={
        'py2exe': {
            'bundle_files': 1,  # すべてのファイルを1つのexeにまとめる
            'compressed': True,  # exeファイルを圧縮する
        }
    },
    windows=[{'script': 'your_script.py'}],
    zipfile=None,
)

zipfileオプションの設定

zipfileオプションを設定することで、依存ファイルをどのように扱うかを指定できます。

zipfile=Noneとすることで、すべてのファイルをexeに含めることができます。

再ビルドと動作確認

設定が完了したら、再ビルドを行い、生成されたexeファイルの動作を確認します。

再ビルドの手順

以下のコマンドを実行して、再ビルドを行います。

python setup.py py2exe

このコマンドを実行すると、distフォルダ内にexeファイルが生成されます。

実行テスト

生成されたexeファイルを実行して、正しく動作するか確認します。

コマンドプロンプトを開き、以下のように実行します。

dist\your_script.exe

この手順を経て、依存ファイルが正しく同梱された単体で実行可能なexeファイルが完成します。

実行時のトラブルシューティング

exeファイルを実行する際に発生する可能性のあるトラブルについて、よくあるエラーとその対策、デバッグ方法を解説します。

これにより、問題を迅速に特定し、解決する手助けとなるでしょう。

よくあるエラーと対策

exeファイルを実行する際に遭遇するエラーは多岐にわたりますが、特に以下の2つが一般的です。

DLLが見つからないエラー

DLLが見つからないエラーは、必要なDLLファイルがexeファイルと同じディレクトリに存在しない場合に発生します。

このエラーを解決するための対策は以下の通りです。

• 必要なDLLファイルを手動で同じフォルダにコピーする
• py2exeの設定で、dll_excludesオプションを使用して不要なDLLを除外する

setup(
    options={
        'py2exe': {
            'dll_excludes': ['w9xpopen.exe'],  # 不要なDLLを除外
        }
    },
)

モジュールが見つからないエラー

モジュールが見つからないエラーは、依存しているモジュールが正しく同梱されていない場合に発生します。

このエラーを解決するための対策は以下の通りです。

• setup.pyのincludesオプションを使用して、必要なモジュールを明示的に指定する
• requirements.txtを確認し、必要なモジュールがインストールされているか確認する

setup(
    options={
        'py2exe': {
            'includes': ['numpy', 'requests'],  # 必要なモジュールを指定
        }
    },
)

デバッグ方法

エラーが発生した場合、デバッグを行うことで問題の特定が可能です。

以下の方法を用いてデバッグを行います。

ログファイルの確認

プログラム内でログファイルを生成することで、実行時のエラーや警告を記録できます。

以下のようにloggingモジュールを使用してログを出力します。

import logging
logging.basicConfig(filename='app.log', level=logging.DEBUG)
logging.debug('デバッグ情報')

このログファイルを確認することで、エラーの原因を特定しやすくなります。

デバッグオプションの使用

Py2exeには、デバッグ用のオプションが用意されています。

debugオプションを使用することで、詳細なエラーメッセージを表示させることができます。

setup(
    options={
        'py2exe': {
            'debug': True,  # デバッグモードを有効にする
        }
    },
)

この設定を行った後にexeファイルを実行すると、エラーの詳細情報が表示され、問題の特定が容易になります。

応用例

Pythonを使用して作成したアプリケーションをexeファイルに変換する際の応用例を紹介します。

ここでは、GUIアプリケーション、コンソールアプリケーション、サードパーティライブラリの使用に関する具体的なサンプルを示します。

GUIアプリケーションのexe化

PythonのGUIライブラリを使用して作成したアプリケーションをexe化する方法を解説します。

Tkinterを使ったサンプル

Tkinterを使用した簡単なGUIアプリケーションの例を示します。

このアプリケーションは、ボタンをクリックするとメッセージを表示します。

import tkinter as tk
def show_message():
    label.config(text="こんにちは、世界！")
root = tk.Tk()
root.title("Tkinterサンプル")
label = tk.Label(root, text="")
label.pack()
button = tk.Button(root, text="メッセージを表示", command=show_message)
button.pack()
root.mainloop()

このプログラムをexe化するためのsetup.pyは以下のようになります。

from distutils.core import setup
import py2exe
setup(
    windows=[{'script': 'your_tkinter_script.py'}],
)

PyQtを使ったサンプル

次に、PyQtを使用したGUIアプリケーションの例を示します。

このアプリケーションは、ボタンをクリックするとメッセージボックスを表示します。

import sys
from PyQt5.QtWidgets import QApplication, QMessageBox, QPushButton
def show_message():
    QMessageBox.information(None, "メッセージ", "こんにちは、世界！")
app = QApplication(sys.argv)
button = QPushButton("メッセージを表示")
button.clicked.connect(show_message)
button.show()
sys.exit(app.exec_())

このプログラムをexe化するためのsetup.pyは以下のようになります。

from distutils.core import setup
import py2exe
setup(
    windows=[{'script': 'your_pyqt_script.py'}],
)

コンソールアプリケーションのexe化

コンソールアプリケーションをexe化する際の方法を解説します。

コマンドライン引数の処理

コマンドライン引数を受け取る簡単なコンソールアプリケーションの例を示します。

import sys
if len(sys.argv) > 1:
    print(f"引数: {sys.argv[1]}")
else:
    print("引数が指定されていません。")

このプログラムをexe化するためのsetup.pyは以下のようになります。

from distutils.core import setup
import py2exe
setup(
    console=[{'script': 'your_console_script.py'}],
)

標準入力・出力の処理

標準入力を受け取り、出力するコンソールアプリケーションの例を示します。

name = input("あなたの名前を入力してください: ")
print(f"こんにちは、{name}さん！")

このプログラムをexe化するためのsetup.pyは以下のようになります。

from distutils.core import setup
import py2exe
setup(
    console=[{'script': 'your_input_output_script.py'}],
)

サードパーティライブラリの使用

サードパーティライブラリを使用したアプリケーションをexe化する際の方法を解説します。

requestsライブラリの同梱

requestsライブラリを使用したHTTPリクエストを行うアプリケーションの例を示します。

import requests
response = requests.get("https://api.github.com")
print(response.json())

このプログラムをexe化するためのsetup.pyは以下のようになります。

from distutils.core import setup
import py2exe
setup(
    console=[{'script': 'your_requests_script.py'}],
    options={
        'py2exe': {
            'includes': ['requests'],  # requestsライブラリを同梱
        }
    },
)

numpyライブラリの同梱

numpyライブラリを使用した数値計算を行うアプリケーションの例を示します。

import numpy as np
array = np.array([1, 2, 3, 4, 5])
print(f"配列の合計: {np.sum(array)}")

このプログラムをexe化するためのsetup.pyは以下のようになります。

from distutils.core import setup
import py2exe
setup(
    console=[{'script': 'your_numpy_script.py'}],
    options={
        'py2exe': {
            'includes': ['numpy'],  # numpyライブラリを同梱
        }
    },
)

これらの例を参考にして、さまざまなアプリケーションをexe化することができます。

よくある質問

まとめ

この記事では、Py2exeを使用してPythonプログラムを単体で実行可能なexeファイルに変換する方法を詳しく解説しました。

特に、依存ファイルの管理やトラブルシューティング、応用例について触れ、実践的な知識を提供しました。

これを機に、あなたのPythonアプリケーションをexe化し、配布や実行をよりスムーズに行ってみてください。