[cx_Freeze] 作成したexeでコンソールを非表示にする方法

2025-01-18更新日: 2025-01-18

cx_FreezeはPythonスクリプトを実行可能なexeファイルに変換するためのツールです。通常、生成されたexeファイルを実行すると、コンソールウィンドウが表示されますが、GUIアプリケーションではこれを非表示にしたい場合があります。

コンソールを非表示にするには、cx_Freezeの設定ファイルでbaseオプションをWin32GUIに設定します。これにより、生成されたexeファイルはコンソールウィンドウを表示せずに実行されます。

この設定は、特にWindows環境でGUIアプリケーションを開発する際に役立ちます。

目次から探す

コンソールを非表示にする方法
実際の例
応用例
まとめ

コンソールを非表示にする方法

Pythonで作成したアプリケーションを配布する際、コンソールウィンドウを非表示にしたい場合があります。

特にGUIアプリケーションでは、ユーザーにとって不要なコンソールが表示されるのは好ましくありません。

ここでは、cx_Freezeを使用してexeファイルを作成する際に、コンソールを非表示にする方法を解説します。

setup.pyの修正

cx_Freezeを使用してexeファイルを作成するためには、setup.pyという設定ファイルを作成します。

このファイルを修正することで、コンソールを非表示にする設定を行います。

baseオプションの設定

setup.py内で、baseオプションを設定することが重要です。

GUIアプリケーションの場合、baseを"Win32GUI"に設定します。

以下はその例です。

from cx_Freeze import setup, Executable
setup(
    name="MyApp",
    version="0.1",
    description="コンソールを非表示にするアプリケーション",
    executables=[Executable("main.py", base="Win32GUI")]
)

この設定により、アプリケーションを実行した際にコンソールウィンドウが表示されなくなります。

GUIアプリケーション用の設定

GUIアプリケーションを作成する際は、cx_Freezeの設定を適切に行う必要があります。

以下のように、必要なライブラリやファイルを指定することができます。

from cx_Freeze import setup, Executable
build_exe_options = {
    "packages": ["tkinter"],  # 使用するパッケージ
    "include_files": ["icon.ico"]  # アイコンファイルなど
}
setup(
    name="MyApp",
    version="0.1",
    description="コンソールを非表示にするアプリケーション",
    options={"build_exe": build_exe_options},
    executables=[Executable("main.py", base="Win32GUI")]
)

このように設定することで、必要なパッケージやファイルを含めた状態でexeファイルを作成できます。

ビルドコマンドの再実行

setup.pyを修正した後は、ビルドコマンドを再実行する必要があります。

コマンドプロンプトを開き、以下のコマンドを入力します。

python setup.py build

これにより、修正した設定に基づいて新しいexeファイルが生成されます。

非表示設定の確認

ビルドが完了したら、生成されたexeファイルを実行して、コンソールウィンドウが表示されないことを確認します。

もしコンソールが表示される場合は、setup.pyの設定を再度確認し、baseオプションが正しく設定されているかをチェックしてください。

実際の例

ここでは、コンソールを非表示にする設定を適用したシンプルなGUIアプリケーションの具体例をいくつか紹介します。

これにより、実際のコードを通じて理解を深めることができます。

シンプルなGUIアプリケーションの例

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

このアプリケーションでは、tkinterを使用しています。

import tkinter as tk
from tkinter import messagebox
def show_message():
    messagebox.showinfo("メッセージ", "ボタンがクリックされました！")
app = tk.Tk()
app.title("シンプルなアプリ")
app.geometry("300x200")
button = tk.Button(app, text="クリックしてね", command=show_message)
button.pack(pady=20)
app.mainloop()

このコードをmain.pyとして保存し、前述のsetup.pyを使用してビルドすると、コンソールウィンドウが表示されないexeファイルが生成されます。

Tkinterを使った例

次に、tkinterを使用したもう少し複雑なアプリケーションの例を示します。

このアプリケーションでは、ユーザーが入力したテキストを表示する機能があります。

import tkinter as tk
def display_text():
    user_input = entry.get()
    label.config(text=f"入力されたテキスト: {user_input}")
app = tk.Tk()
app.title("テキスト表示アプリ")
app.geometry("400x200")
entry = tk.Entry(app)
entry.pack(pady=10)
button = tk.Button(app, text="表示", command=display_text)
button.pack(pady=10)
label = tk.Label(app, text="")
label.pack(pady=10)
app.mainloop()

このアプリケーションも同様に、setup.pyを使ってビルドすることで、コンソールを非表示にしたexeファイルを作成できます。

PyQtを使った例

最後に、PyQtを使用したGUIアプリケーションの例を紹介します。

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

import sys
from PyQt5.QtWidgets import QApplication, QWidget, QPushButton, QMessageBox
def show_message():
    QMessageBox.information(window, "メッセージ", "ボタンがクリックされました！")
app = QApplication(sys.argv)
window = QWidget()
window.setWindowTitle("PyQtアプリ")
window.setGeometry(100, 100, 300, 200)
button = QPushButton("クリックしてね", window)
button.clicked.connect(show_message)
button.move(100, 80)
window.show()
sys.exit(app.exec_())

このコードをmain.pyとして保存し、setup.pyを適切に設定した後にビルドすることで、コンソールを非表示にしたexeファイルを作成できます。

応用例

ここでは、cx_Freezeを使用して作成したexeファイルに関する応用例を紹介します。

これにより、より高度な設定や機能を実装する方法を学ぶことができます。

複数のexeファイルを作成する方法

複数のexeファイルを作成する場合、setup.py内で複数のExecutableオブジェクトを指定することができます。

以下は、2つの異なるPythonスクリプトからexeファイルを生成する例です。

from cx_Freeze import setup, Executable
setup(
    name="MyMultiApp",
    version="0.1",
    description="複数のexeファイルを作成するアプリケーション",
    executables=[
        Executable("main1.py", base="Win32GUI"),
        Executable("main2.py", base="Win32GUI")
    ]
)

この設定により、main1.pyとmain2.pyの2つのexeファイルが生成されます。

外部ライブラリを含める方法

外部ライブラリを含める場合、build_exe_optionsを使用して必要なパッケージを指定します。

以下は、numpyライブラリを含める例です。

from cx_Freeze import setup, Executable
build_exe_options = {
    "packages": ["numpy"],  # 必要なパッケージを指定
}
setup(
    name="MyAppWithLib",
    version="0.1",
    description="外部ライブラリを含めたアプリケーション",
    options={"build_exe": build_exe_options},
    executables=[Executable("main.py", base="Win32GUI")]
)

この設定により、numpyライブラリが含まれたexeファイルが生成されます。

アイコンを設定する方法

exeファイルにアイコンを設定するには、Executableオブジェクトのiconオプションを使用します。

以下は、アイコンファイルを指定する例です。

from cx_Freeze import setup, Executable
setup(
    name="MyAppWithIcon",
    version="0.1",
    description="アイコンを設定したアプリケーション",
    executables=[Executable("main.py", base="Win32GUI", icon="icon.ico")]
)