AIcicle Records

Pythonで開発したGUIアプリケーションを、他の人が簡単に実行できる形式（Windowsなら.exe、macOSなら.app）に変換したい、と考えたことはありませんか？ cx_Freeze は、そんな願いを叶えてくれる便利なライブラリです。

しかし、開発環境がmacOSで、配布先がWindows（またはその逆）の場合、設定ファイルである setup.py の記述に少し工夫が必要になります。

筆者の開発環境はMacOSですが、Windowsでもビルドできるように方法を調べたので解説します。

はじめに：macOS向けの setup.py

最初に、macOSでの実行を想定して書かれた setup.py を見てみましょう。(筆者がPySide6ライブラリを用いてGUIアプリを開発した際に作成したsetup.pyの参考例になります。)

1
# setup.py (macOS version)
2
import sys
3
from cx_Freeze import setup, Executable
4
from pathlib import Path
5

6
# 基本情報
7
APP_NAME = "Sample App"
8
APP_VERSION = "2.0.0"
9

10
# ... (中略) ...
11

12
# macOS用の基本設定
13
build_exe_options = {
14
    "packages": ["PySide6.QtCore", "PySide6.QtGui", "PySide6.QtWidgets"],
15
    "excludes": ["tkinter", "unittest", "test"],
31 collapsed lines
16
    "optimize": 2,
17
}
18

19
# アイコンファイルのパス
20
icon_path = Path("resources/icons/icon.icns")
21

22
# 実行ファイル設定
23
executables = [
24
    Executable(
25
        "main.py",
26
        target_name=APP_NAME,
27
        icon=str(icon_path) if icon_path.exists() else None,
28
    )
29
]
30

31
# macOS用バンドル設定
32
bdist_mac_options = {
33
    "bundle_name": APP_NAME,
34
    "iconfile": str(icon_path) if icon_path.exists() else None,
35
}
36

37
# セットアップ
38
setup(
39
    name=APP_NAME,
40
    version=APP_VERSION,
41
    options={
42
        "build_exe": build_exe_options,
43
        "bdist_mac": bdist_mac_options, # macOS専用のオプション
44
    },
45
    executables=executables,
46
)

このスクリプトには、macOS専用の設定（bdist_mac_options）やアイコン形式（.icns）がハードコードされています。このままではWindows環境で正しくビルドできません。

Windows対応に重要な3つのポイント

この setup.py をWindowsに対応させるには、主に以下の3点を修正・追記する必要があります。

1. コンソールウィンドウを非表示にする (`base`)

GUIアプリケーションをWindowsで実行すると、背後にコマンドプロンプト（黒い画面）が表示されてしまうことがあります。これを防ぐには、Executable の引数に base="Win32GUI" を指定します。

2. Windows用のアイコンを指定する（`.ico`）

macOSのアイコンが .icns 形式であるのに対し、Windowsの実行ファイルでは .ico 形式のアイコンが必要です。プラットフォームに応じて使用するアイコンファイルを切り替える仕組みを導入します。

3. OSを判定して設定を切り替える（`sys.platform`）

sys.platform を使うことで、スクリプトが実行されているOSを判定できます。

完成形：クロスプラットフォーム対応 setup.py

1
import sys
2
from cx_Freeze import setup, Executable
3
from pathlib import Path
4

5
# --- 基本情報 ---
6
APP_NAME = "Sample App"
7
APP_VERSION = "2.0.0"
8

9
# --- 共通設定 ---
10
packages = ["PySide6.QtCore", "PySide6.QtGui", "PySide6.QtWidgets"]
11
excludes = ["tkinter", "unittest", "test"]
12
include_files = ["resources/"]
13

14
build_exe_options = {
15
    "packages": packages,
44 collapsed lines
16
    "excludes": excludes,
17
    "include_files": include_files,
18
    "optimize": 2,
19
}
20

21
# --- プラットフォームごとの設定 ---
22
base = None
23
icon_path = None
24
target_name = APP_NAME
25
options = {"build_exe": build_exe_options}
26

27
# Windowsの設定
28
if sys.platform == "win32":
29
    base = "Win32GUI"
30
    icon_path = Path("resources/icons/icon.ico")
31
    target_name = f"{APP_NAME}.exe"
32

33
# macOSの設定
34
elif sys.platform == "darwin":
35
    icon_path = Path("resources/icons/icon.icns")
36
    bdist_mac_options = {
37
        "bundle_name": APP_NAME,
38
        "iconfile": str(icon_path) if icon_path.exists() else None,
39
    }
40
    options["bdist_mac"] = bdist_mac_options
41

42
# --- 実行ファイル設定 ---
43
executables = [
44
    Executable(
45
        "main.py",
46
        base=base,
47
        target_name=target_name,
48
        icon=str(icon_path) if icon_path and icon_path.exists() else None,
49
    )
50
]
51

52
# --- セットアップ実行 ---
53
setup(
54
    name=APP_NAME,
55
    version=APP_VERSION,
56
    description="Sample App",
57
    options=options,
58
    executables=executables,
59
)

ビルド方法

各OSで以下のコマンドを実行するだけで、それぞれの環境に対応した実行ファイルを作成できます。

1
# 実行ファイルを作成
2
python setup.py build
3

4
# WindowsでMSIインストーラーを作成する場合（オプション）
5
python setup.py bdist_msi
6

7
# macOSでappバンドルを作成する場合
8
python setup.py bdist_mac

まとめ

sys.platform を活用することで、setup.py を一つ用意するだけで、WindowsとmacOSの両方に対応したアプリケーションのビルドが可能になります。OSごとの細かな違いをスクリプト内で吸収することで、開発と配布のプロセスがよりスマートになりました。

cx_FreezeでPythonアプリをexe化!Windows用にsetup.pyを作成!!