[Python] Cx_freezeの使い方【インストール/exe生成】

Q: 生成したEXEのサイズが大きい

生成されたEXEファイルのサイズが大きい場合、不要なファイルやライブラリが含まれている可能性があります。 setup.pyのzip_include_packagesオプションを使用して、必要なパッケージのみをZIPに含める設定を行うことで、サイズを小さくすることができます。 また、include_filesオプションで同梱するファイルを最小限に抑えることも効果的です。

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

このツールを使用することで、Pythonがインストールされていない環境でもPythonアプリケーションを実行可能にします。

まず、Cx_freezeをインストールするには、Pythonのパッケージ管理ツールであるpipを使用します。

インストール後、setup.pyファイルを作成し、cx_Freeze.setup関数を用いてスクリプトを指定します。

その後、コマンドラインでpython setup.py buildを実行することで、exeファイルが生成されます。

この記事でわかること

Cx_Freezeのインストール手順
セットアップファイルの作成方法
EXEファイルの生成手順
よくあるエラーとその対策
GUIアプリケーションやデータベースアプリケーションのEXE化の具体例

目次から探す

Cx_Freezeとは

Cx_Freezeは、Pythonで作成したアプリケーションをスタンドアロンの実行可能ファイル(EXEファイル)に変換するためのツールです。

これにより、Pythonがインストールされていない環境でもアプリケーションを実行できるようになります。

特に、デスクトップアプリケーションや配布用のソフトウェアを作成する際に非常に便利です。

Cx_Freezeの概要

Cx_Freezeは、PythonのスクリプトをWindows、macOS、Linux向けの実行可能ファイルに変換するためのクロスプラットフォームのツールです。

主に以下のような特徴があります。

Python 3.xに対応
複数のプラットフォームで動作
GUIアプリケーションやコンソールアプリケーションの両方に対応

Cx_Freezeの特徴

スクロールできます

特徴	説明
クロスプラットフォーム対応	Windows、macOS、Linuxで動作可能
簡単な設定	setup.pyファイルを使って簡単に設定できる
依存関係の自動検出	必要なモジュールやライブラリを自動で検出し、パッケージ化
GUIサポート	TkinterやPyQtなどのGUIライブラリに対応

他のツールとの比較

Cx_Freezeは、他のPythonパッケージングツールと比較して、いくつかの利点と欠点があります。

以下は、代表的なツールとの比較です。

スクロールできます

ツール名	特徴	利点
Cx_Freeze	クロスプラットフォーム対応、簡単な設定	依存関係の自動検出、GUIサポート
PyInstaller	シンプルなコマンドで実行可能ファイルを生成	使いやすさ、豊富なドキュメント
py2exe	Windows専用のEXEファイル生成ツール	Windows環境での最適化
py2app	macOS専用のアプリケーションパッケージ作成ツール	macOSアプリの作成に特化

このように、Cx_Freezeは特にクロスプラットフォームでの利用を重視する開発者にとって、非常に有用なツールです。

Cx_Freezeのインストール

Cx_Freezeは、Pythonのパッケージ管理ツールであるpipを使用して簡単にインストールできます。

以下の手順でインストールを行います。

コマンドライン(Windowsの場合はコマンドプロンプト、macOSやLinuxの場合はターミナル)を開きます。
次のコマンドを入力して、Cx_Freezeをインストールします。

pip install cx_Freeze

このコマンドを実行すると、Cx_Freezeが自動的にダウンロードされ、インストールされます。

インストールが完了したら、次のコマンドでインストールが成功したか確認できます。

python -m cx_Freeze --version

これにより、インストールされたCx_Freezeのバージョンが表示されれば、正しくインストールされています。

これで、Cx_Freezeを使用してPythonアプリケーションをEXEファイルに変換する準備が整いました。

基本的な使い方

Cx_Freezeを使用してPythonアプリケーションをEXEファイルに変換するためには、まずセットアップファイルを作成する必要があります。

このセットアップファイルは、アプリケーションの設定や依存関係を定義するためのものです。

セットアップファイルの作成

setup.pyの基本構造

セットアップファイルは、通常setup.pyという名前で作成します。

以下は、基本的な構造の例です。

from cx_Freeze import setup, Executable
setup(
    name="MyApp",
    version="0.1",
    description="私のアプリケーション",
    executables=[Executable("main.py")]
)

このコードでは、name、version、descriptionを設定し、main.pyというPythonスクリプトを実行可能ファイルに変換するよう指定しています。

setup.pyのオプション設定

setup.pyには、さまざまなオプションを追加することができます。

以下は、一般的なオプションの例です。

setup(
    name="MyApp",
    version="0.1",
    description="私のアプリケーション",
    options={
        "build_exe": {
            "packages": ["numpy", "pandas"],  # 必要なパッケージ
            "include_files": ["data.txt"],     # 同梱するファイル
        }
    },
    executables=[Executable("main.py")]
)

この例では、packagesオプションで必要なパッケージを指定し、include_filesオプションで同梱するファイルを指定しています。

EXEファイルの生成

セットアップファイルが準備できたら、次はEXEファイルを生成します。

コマンドの実行

コマンドラインで以下のコマンドを実行します。

python setup.py build

このコマンドを実行すると、buildフォルダが作成され、その中にEXEファイルが生成されます。

生成されたファイルの確認

生成されたEXEファイルは、buildフォルダ内のサブフォルダに格納されています。

以下のように、生成されたファイルを確認できます。

cd build
ls

このコマンドを実行すると、生成されたEXEファイルや必要なライブラリが表示されます。

これで、PythonアプリケーションをEXEファイルとして配布する準備が整いました。

詳細な設定

Cx_Freezeを使用する際には、基本的な設定に加えて、より詳細なオプションを設定することで、アプリケーションのビルドをカスタマイズできます。

ここでは、追加のオプションやカスタムビルドの設定方法について説明します。

追加のオプション

パッケージの追加

アプリケーションが依存しているパッケージを明示的に指定することができます。

これにより、必要なライブラリが正しく含まれるようになります。

以下は、setup.pyにパッケージを追加する例です。

setup(
    name="MyApp",
    version="0.1",
    description="私のアプリケーション",
    options={
        "build_exe": {
            "packages": ["numpy", "pandas", "matplotlib"],  # 必要なパッケージを追加
        }
    },
    executables=[Executable("main.py")]
)

この例では、numpy、pandas、matplotlibの3つのパッケージが追加されています。

データファイルの追加

アプリケーションが使用するデータファイル(画像、テキストファイルなど)を同梱することも可能です。

以下のようにinclude_filesオプションを使用します。

setup(
    name="MyApp",
    version="0.1",
    description="私のアプリケーション",
    options={
        "build_exe": {
            "include_files": ["data.txt", "config.json"],  # 同梱するデータファイル
        }
    },
    executables=[Executable("main.py")]
)

この例では、data.txtとconfig.jsonがアプリケーションに同梱されます。

カスタムビルド

ビルドプロセスをさらにカスタマイズするためのオプションも用意されています。

ビルドディレクトリの指定

生成されるビルドファイルのディレクトリを指定することができます。

以下のようにbuild_exeオプションでbuild_dirを設定します。

setup(
    name="MyApp",
    version="0.1",
    description="私のアプリケーション",
    options={
        "build_exe": {
            "build_dir": "my_build_directory",  # ビルドディレクトリを指定
        }
    },
    executables=[Executable("main.py")]
)

この例では、my_build_directoryという名前のディレクトリにビルドファイルが生成されます。

圧縮オプションの設定

生成されるEXEファイルのサイズを小さくするために、圧縮オプションを設定することも可能です。

以下のようにzip_include_packagesオプションを使用します。

setup(
    name="MyApp",
    version="0.1",
    description="私のアプリケーション",
    options={
        "build_exe": {
            "zip_include_packages": ["*"],  # すべてのパッケージをZIPに含める
        }
    },
    executables=[Executable("main.py")]
)

この設定により、すべてのパッケージがZIPファイルに圧縮され、EXEファイルのサイズが小さくなります。

これで、より効率的なビルドが可能になります。

トラブルシューティング

Cx_Freezeを使用してアプリケーションをビルドする際に、いくつかのトラブルが発生することがあります。

ここでは、よくあるエラーとその対策、デバッグ方法について説明します。

よくあるエラーと対策

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

アプリケーションを実行した際に「モジュールが見つからない」というエラーが表示されることがあります。

このエラーは、必要なモジュールがビルドに含まれていない場合に発生します。

対策としては、以下の手順を試してください。

setup.pyのoptionsセクションで、packagesオプションに必要なモジュールを追加します。
依存関係を確認し、必要なモジュールがインストールされているか確認します。

options={
    "build_exe": {
        "packages": ["必要なモジュール名"],
    }
}

DLLの問題

特定のライブラリを使用している場合、DLLファイルが見つからないというエラーが発生することがあります。

この場合、以下の対策を試みてください。

必要なDLLファイルを手動でinclude_filesオプションに追加します。
使用しているライブラリのドキュメントを確認し、必要なDLLファイルを特定します。

options={
    "build_exe": {
        "include_files": ["path/to/必要なDLLファイル.dll"],
    }
}

デバッグ方法

アプリケーションのビルドや実行時に問題が発生した場合、デバッグを行うことで原因を特定できます。

ログの確認

Cx_Freezeはビルドプロセス中にログを生成します。

このログを確認することで、エラーの詳細を把握できます。

ビルド時に表示されるメッセージや、buildフォルダ内のログファイルを確認してください。

python setup.py build > build_log.txt

このコマンドを実行すると、ビルドの詳細がbuild_log.txtに出力されます。

デバッグビルドの作成

デバッグ用のビルドを作成することで、問題の特定が容易になります。

以下のように、setup.pyにデバッグオプションを追加します。

setup(
    name="MyApp",
    version="0.1",
    description="私のアプリケーション",
    options={
        "build_exe": {
            "include_files": ["data.txt"],
            "optimize": 0,  # 最適化を無効にする
        }
    },
    executables=[Executable("main.py")]
)

この設定により、最適化が無効になり、デバッグ情報が含まれるビルドが生成されます。

これにより、エラーの原因を特定しやすくなります。

応用例

Cx_Freezeを使用して、さまざまなタイプのアプリケーションをEXEファイルに変換することができます。

ここでは、GUIアプリケーション、コンソールアプリケーション、データベースアプリケーションのEXE化の例を紹介します。

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

Tkinterを使った例

Tkinterを使用した簡単なGUIアプリケーションをEXE化する例です。

以下のコードは、ボタンをクリックするとメッセージが表示されるアプリケーションです。

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

このアプリケーションをEXE化するためのsetup.pyは以下のようになります。

from cx_Freeze import setup, Executable
setup(
    name="TkinterApp",
    version="0.1",
    description="Tkinterを使ったアプリケーション",
    executables=[Executable("tkinter_app.py")]
)

PyQtを使った例

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

以下のコードは、ボタンをクリックするとメッセージが表示されるアプリケーションです。

from PyQt5.QtWidgets import QApplication, QPushButton, QLabel, QVBoxLayout, QWidget
def show_message():
    label.setText("こんにちは、世界！")
app = QApplication([])
window = QWidget()
window.setWindowTitle("PyQtアプリ")
label = QLabel("")
button = QPushButton("メッセージを表示")
button.clicked.connect(show_message)
layout = QVBoxLayout()
layout.addWidget(label)
layout.addWidget(button)
window.setLayout(layout)
window.show()
app.exec_()

このアプリケーションをEXE化するためのsetup.pyは以下のようになります。

from cx_Freeze import setup, Executable
setup(
    name="PyQtApp",
    version="0.1",
    description="PyQtを使ったアプリケーション",
    executables=[Executable("pyqt_app.py")]
)

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

単純なスクリプトの例

以下は、単純なコンソールアプリケーションの例です。

このスクリプトは、ユーザーからの入力を受け取り、挨拶を表示します。

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

このスクリプトをEXE化するためのsetup.pyは以下のようになります。

from cx_Freeze import setup, Executable
setup(
    name="GreetingApp",
    version="0.1",
    description="挨拶を表示するアプリケーション",
    executables=[Executable("greeting_app.py")]
)

複数ファイルのプロジェクトの例

複数のPythonファイルからなるプロジェクトをEXE化する場合、以下のようにsetup.pyを設定します。

from cx_Freeze import setup, Executable
setup(
    name="MultiFileApp",
    version="0.1",
    description="複数ファイルからなるアプリケーション",
    options={
        "build_exe": {
            "packages": ["numpy"],  # 必要なパッケージ
        }
    },
    executables=[Executable("main.py")]
)

データベースアプリケーションのEXE化

SQLiteを使った例

SQLiteを使用したデータベースアプリケーションの例です。

以下のコードは、SQLiteデータベースに接続し、データを挿入するアプリケーションです。

import sqlite3
def create_table():
    conn = sqlite3.connect('example.db')
    c = conn.cursor()
    c.execute('''CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT)''')
    conn.commit()
    conn.close()
def insert_data(name):
    conn = sqlite3.connect('example.db')
    c = conn.cursor()
    c.execute("INSERT INTO users (name) VALUES (?)", (name,))
    conn.commit()
    conn.close()
create_table()
insert_data("山田太郎")

このアプリケーションをEXE化するためのsetup.pyは以下のようになります。

from cx_Freeze import setup, Executable
setup(
    name="SQLiteApp",
    version="0.1",
    description="SQLiteを使ったアプリケーション",
    executables=[Executable("sqlite_app.py")]
)

MySQLを使った例

MySQLを使用したデータベースアプリケーションの例です。

以下のコードは、MySQLデータベースに接続し、データを挿入するアプリケーションです。

import mysql.connector
def insert_data(name):
    conn = mysql.connector.connect(
        host="localhost",
        user="your_username",
        password="your_password",
        database="your_database"
    )
    cursor = conn.cursor()
    cursor.execute("INSERT INTO users (name) VALUES (%s)", (name,))
    conn.commit()
    cursor.close()
    conn.close()
insert_data("佐藤花子")

このアプリケーションをEXE化するためのsetup.pyは以下のようになります。

from cx_Freeze import setup, Executable
setup(
    name="MySQLApp",
    version="0.1",
    description="MySQLを使ったアプリケーション",
    options={
        "build_exe": {
            "packages": ["mysql-connector-python"],  # 必要なパッケージ
        }
    },
    executables=[Executable("mysql_app.py")]
)

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