PyInstallerの–collect-dataオプションと–add-dataオプションの違いを徹底解説！エラーを解決！

PyInstallerでEXE化する際によくわからないエラーでつまってませんか？

PythonスクリプトをPyInstallerでEXE化する際、スクリプトが依存するデータを適切に含めれていないからかもしれません。

PyInstallerには依存するデータを適切に含めるための2つの主要オプション、--collect-dataと--add-dataがあります。

しかし、それぞれの違いや使用方法がわからず混乱することもあるでしょう。

この記事では、両者の違いを具体例とともに詳しく解説します。

--collect-dataとは？

--collect-dataは、特定のモジュールが依存するデータファイル（例：スタイルシート、フォント、設定ファイルなど）を自動的に収集してEXEに含めるためのオプションです。PyInstallerが依存関係を解析する際に収集対象から漏れるデータを補うのに便利です。

主な用途

• モジュールに関連付けられたデータファイルを自動収集
• モジュールの動作に必要なスタイルファイルや設定データを漏れなく含める

使用例

Matplotlibを使ったスクリプトをEXE化する場合：

pyinstaller --collect-data matplotlib script.py

このコマンドは、Matplotlibが必要とするフォントやスタイルファイルを自動収集し、EXEに含めます。

--add-dataとは？

--add-dataは、特定のリソースファイル（画像、設定ファイルなど）を手動で指定し、EXEに含めるためのオプションです。このオプションはスクリプトが利用するカスタムリソースを含める際に使います。

主な用途

• 独自のリソースファイル（画像、CSV、設定ファイルなど）を含める
• 自動収集されないモジュール外のファイルを追加

使用例

スクリプトが独自の設定ファイルを参照する場合：

pyinstaller --add-data "config/settings.json;config" script.py

このコマンドは、settings.jsonをconfig/フォルダに格納する形でEXEに含めます。

--collect-dataと--add-dataの違い

使用シナリオでの選択

--collect-dataを使うべき場合

• Matplotlib、Pandas、SciPyなど依存データが多いモジュールを使用しているとき
• モジュールがデフォルトで使用するスタイルファイルやフォントが必要なとき

--add-dataを使うべき場合

• スクリプトが独自に読み込む画像や設定ファイルがあるとき
• PyInstallerがモジュールの依存関係を認識できず、データが不足するとき

実用例

Matplotlibを使ったグラフ描画アプリ

以下のスクリプトをEXE化する例を考えます：

import matplotlib.pyplot as plt

plt.plot([1, 2, 3, 4], [10, 20, 30, 40])
plt.title("Sample Graph") 
plt.show() 

このスクリプトをEXE化する場合、スタイルファイルやフォントが不足するとエラーになります。以下のようにコマンドを実行して解決します：

pyinstaller --onefile --collect-data matplotlib script.py

独自設定ファイルを持つデータ分析アプリ

以下のスクリプトを例に考えます：

import json

with open("config/settings.json", "r") as f:
    config = json.load(f)
print(config)

このスクリプトをEXE化する際、settings.jsonをEXEに含めるには以下のコマンドを使用します：

pyinstaller --onefile --add-data "config/settings.json;config" script.py

スクリプト内でファイルを参照する際は、以下のようにパスを解決する関数を使用する必要があります

import sys
import os

def resource_path(relative_path):
    """リソースファイルへのパスを解決"""
    if hasattr(sys, '_MEIPASS'):
        return os.path.join(sys._MEIPASS, relative_path) 
    return os.path.join(os.path.abspath("."), relative_path)

config_file = resource_path("config/settings.json")

--collect-dataと--add-dataの併用

場合によっては両方を同時に使うこともあります。たとえば、Matplotlibを使用しつつ独自の設定ファイルを持つアプリの場合

pyinstaller --onefile --collect-data matplotlib --add-data "config/settings.json;config" script.py

よくあるエラーと解決策

エラー例 1: リソースファイルが見つからない

FileNotFoundError: [Errno 2] No such file or directory: 'config/settings.json'

解決策：
--add-dataでリソースを明示的に含める：

pyinstaller --add-data "config/settings.json;config" script.py

エラー例 2: データ不足によるモジュールエラー

ModuleNotFoundErrorやデフォルトスタイルの読み込みエラー

解決策：
--collect-dataで必要なデータを収集：

pyinstaller --collect-data matplotlib script.py

まとめ

PyInstallerでEXE化する際、--collect-dataと--add-dataは重要なオプションです。

それぞれの用途を正しく理解し、必要に応じて使い分けることで、依存データやリソースを含む実行可能ファイルを問題なく作成できます。

本記事を参考に、どちらのオプションが適しているか判断して作業を進めてみてください！