[Python] Py2exeで使用できるキーワード・オプション一覧

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

このツールを使用する際には、さまざまなキーワードやオプションを指定することができます。

例えば、consoleオプションはコンソールアプリケーションを作成するために使用され、windowsオプションはGUIアプリケーションを作成するために使用されます。

また、includesやexcludesオプションを使用して、特定のモジュールを含めたり除外したりすることが可能です。

これらのオプションを適切に設定することで、効率的にPythonアプリケーションを配布することができます。

Py2exeのキーワード・オプション一覧

setup.pyファイルの基本構造

setup.pyは、Py2exeを使用してPythonスクリプトを実行可能なファイルに変換するための設定ファイルです。

基本的な構造は以下の通りです。

from distutils.core import setup
import py2exe
setup(
    console=['your_script.py'],  # ここに変換したいスクリプトを指定
)

このファイルを作成することで、Py2exeがどのスクリプトを実行可能ファイルに変換するかを指定します。

consoleオプション

consoleオプションの使い方

consoleオプションは、コンソールアプリケーションを作成するために使用します。

このオプションには、実行可能にしたいPythonスクリプトのファイル名をリスト形式で指定します。

consoleオプションの具体例

setup(
    console=['my_script.py'],  # my_script.pyをコンソールアプリケーションに変換
)

この設定により、my_script.pyがコンソールアプリケーションとしてビルドされます。

windowsオプション

windowsオプションの使い方

windowsオプションは、GUIアプリケーションを作成するために使用します。

consoleオプションと同様に、実行可能にしたいスクリプトをリスト形式で指定します。

windowsオプションの具体例

setup(
    windows=['my_gui_script.py'],  # my_gui_script.pyをGUIアプリケーションに変換
)

この設定により、my_gui_script.pyがGUIアプリケーションとしてビルドされます。

optionsオプション

optionsオプションの使い方

optionsオプションは、Py2exeの動作をカスタマイズするための設定を行うために使用します。

具体的には、パッケージの圧縮や依存関係の管理などが含まれます。

optionsオプションの具体例

setup(
    options={
        'py2exe': {
            'bundle_files': 1,  # すべてのファイルを1つの実行ファイルにバンドル
        }
    },
)

この設定により、すべてのファイルが1つの実行ファイルにまとめられます。

zipfileオプション

zipfileオプションの使い方

zipfileオプションは、依存ファイルをZIP形式でまとめるために使用します。

このオプションを指定することで、実行ファイルと依存ファイルを分けて管理できます。

zipfileオプションの具体例

setup(
    zipfile=None,  # ZIPファイルを作成しない
)

この設定により、依存ファイルはZIP形式でまとめられず、すべてのファイルが同じディレクトリに配置されます。

data_filesオプション

data_filesオプションの使い方

data_filesオプションは、アプリケーションに必要なデータファイルを指定するために使用します。

これにより、実行ファイルと一緒にデータファイルを配布できます。

data_filesオプションの具体例

setup(
    data_files=[('config', ['config.json'])],  # config.jsonをconfigフォルダに配置
)

この設定により、config.jsonが実行ファイルと同じディレクトリ内のconfigフォルダに配置されます。

bundle_filesオプション

bundle_filesオプションの使い方

bundle_filesオプションは、実行ファイルに含めるファイルの数を指定します。

1、2、3のいずれかの値を指定できます。

bundle_filesオプションの具体例

setup(
    options={
        'py2exe': {
            'bundle_files': 2,  # 依存ファイルを別のフォルダに配置
        }
    },
)

この設定により、実行ファイルと依存ファイルが別々のフォルダに配置されます。

dist_dirオプション

dist_dirオプションの使い方

dist_dirオプションは、生成される実行ファイルの出力先ディレクトリを指定します。

デフォルトでは、distという名前のフォルダが作成されます。

dist_dirオプションの具体例

setup(
    dist_dir='output',  # 出力先をoutputフォルダに指定
)

この設定により、生成された実行ファイルはoutputフォルダに配置されます。

Py2exeの応用例

GUIアプリケーションの作成

Py2exeを使用して、Pythonで作成したGUIアプリケーションを実行可能ファイルに変換することができます。

以下は、tkinterを使用した簡単なGUIアプリケーションの例です。

import tkinter as tk
from distutils.core import setup
import py2exe
def main():
    root = tk.Tk()
    root.title("サンプルGUIアプリ")
    label = tk.Label(root, text="こんにちは、Py2exe!")
    label.pack()
    root.mainloop()
if __name__ == "__main__":
    main()

このアプリケーションを実行可能ファイルに変換するためのsetup.pyは以下のようになります。

setup(
    windows=['gui_app.py'],  # gui_app.pyをGUIアプリケーションに変換
)

この設定により、gui_app.pyがGUIアプリケーションとしてビルドされます。

コンソールアプリケーションの作成

コンソールアプリケーションもPy2exeで簡単に作成できます。

以下は、ユーザーからの入力を受け取るシンプルなコンソールアプリケーションの例です。

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

このアプリケーションを実行可能ファイルに変換するためのsetup.pyは以下のようになります。

setup(
    console=['console_app.py'],  # console_app.pyをコンソールアプリケーションに変換
)

この設定により、console_app.pyがコンソールアプリケーションとしてビルドされます。

複数ファイルのバンドル

複数のPythonファイルを1つの実行可能ファイルにバンドルすることも可能です。

以下は、複数のモジュールを使用するアプリケーションの例です。

# main.py
from module import greet
def main():
    greet("ユーザー")
if __name__ == "__main__":
    main()
# module.py
def greet(name):
    print(f"こんにちは、{name}さん!")

このアプリケーションを実行可能ファイルに変換するためのsetup.pyは以下のようになります。

setup(
    console=['main.py'],  # main.pyをコンソールアプリケーションに変換
)

この設定により、main.pyとmodule.pyが1つの実行可能ファイルにバンドルされます。

外部ライブラリのインクルード

Py2exeを使用して、外部ライブラリを含むアプリケーションを作成することもできます。

以下は、requestsライブラリを使用する例です。

import requests
def main():
    response = requests.get("https://api.github.com")
    print(response.json())
if __name__ == "__main__":
    main()

このアプリケーションを実行可能ファイルに変換するためのsetup.pyは以下のようになります。

setup(
    console=['external_lib_app.py'],  # external_lib_app.pyをコンソールアプリケーションに変換
    options={
        'py2exe': {
            'includes': ['requests'],  # requestsライブラリを含める
        }
    },
)

この設定により、requestsライブラリが実行可能ファイルに含まれます。

カスタムアイコンの設定

Py2exeを使用して、実行可能ファイルにカスタムアイコンを設定することもできます。

以下は、アイコンを指定する方法の例です。

setup(
    windows=[{
        'script': 'gui_app.py',  # GUIアプリケーションのスクリプト
        'icon_resources': [(1, 'icon.ico')]  # アイコンファイルを指定
    }],
)

この設定により、gui_app.pyがビルドされる際に、icon.icoがアイコンとして使用されます。

これにより、アプリケーションの見た目をカスタマイズできます。

トラブルシューティング

よくあるエラーとその対処法

Py2exeを使用する際に遭遇する一般的なエラーとその対処法を以下に示します。

これらのエラーが発生した場合は、上記の対処法を試してみてください。

デバッグ方法

Py2exeで作成した実行ファイルのデバッグは、以下の方法で行うことができます。

1. ログ出力: プログラム内にログ出力を追加し、実行時の状態を確認します。

Pythonのloggingモジュールを使用することが一般的です。

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

2. 例外処理: 例外をキャッチして、エラーメッセージを表示することで、問題の特定を容易にします。

try:
       # 何らかの処理
   except Exception as e:
       print(f"エラーが発生しました: {e}")

3. コマンドラインでの実行: 実行ファイルをコマンドラインから実行し、エラーメッセージを直接確認します。

依存関係の解決方法

Py2exeで依存関係を解決するための方法は以下の通りです。

1. includesオプションの使用: setup.py内でincludesオプションを使用して、必要なライブラリを明示的に指定します。

setup(
       console=['your_script.py'],
       options={
           'py2exe': {
               'includes': ['numpy', 'pandas'],  # 必要なライブラリを指定
           }
       },
   )

2. packagesオプションの使用: パッケージ全体を含める場合は、packagesオプションを使用します。

setup(
       console=['your_script.py'],
       options={
           'py2exe': {
               'packages': ['your_package'],  # パッケージを指定
           }
       },
   )

3. 依存関係の確認: pip freezeコマンドを使用して、現在インストールされているパッケージを確認し、必要な依存関係を特定します。

これらの方法を使用して、依存関係の問題を解決し、アプリケーションを正常に動作させることができます。

よくある質問

options={
       'py2exe': {
           'includes': ['your_library'],  # 含めたいライブラリを指定
       }
   }

まとめ

この記事では、Py2exeの基本的な使い方やトラブルシューティングの方法、よくある質問について解説しました。

Py2exeを使用することで、Pythonスクリプトを簡単に実行可能なファイルに変換できることが理解できたと思います。

ぜひ、実際にPy2exeを使って、自分のアプリケーションをパッケージングしてみてください。