[Python] py2exeで生成するexeを軽量化する方法

Pythonで作成したスクリプトをWindowsの実行可能ファイル（exe）に変換する際、py2exeを使用することが一般的です。しかし、生成されるexeファイルはしばしば大きくなりがちです。

軽量化するためには、不要なライブラリやモジュールを除外することが重要です。py2exeの設定ファイルでexcludesオプションを使用し、使用しないモジュールを指定することで、ファイルサイズを削減できます。

また、bundle_filesオプションを調整することで、複数のファイルを一つにまとめ、全体のサイズを小さくすることも可能です。

exeファイルの軽量化の基本

Pythonで作成したプログラムをexeファイルに変換する際、ファイルサイズが大きくなることがあります。

特に、py2exeを使用する場合、不要なモジュールやリソースが含まれることが多いため、軽量化が重要です。

ここでは、exeファイルの軽量化に役立つ基本的な方法を紹介します。

不要なモジュールの除外

exeファイルを生成する際に、使用していないモジュールを除外することで、ファイルサイズを小さくすることができます。

以下の方法で不要なモジュールを除外できます。

• setup.pyでの除外設定: setup.pyファイルに除外するモジュールを指定します。
• モジュールの依存関係の確認: 使用しているモジュールの依存関係を確認し、不要なものを特定します。
• 実際の除外例: 例えば、numpyを使用していない場合、以下のように設定します。

from distutils.core import setup
import py2exe
setup(
    console=['your_script.py'],
    options={
        'py2exe': {
            'excludes': ['numpy', 'scipy']  # 除外するモジュール
        }
    }
)

この設定により、numpyとscipyは生成されるexeファイルに含まれなくなります。

圧縮オプションの利用

py2exeには、生成されるexeファイルを圧縮するオプションがあります。

これを利用することで、ファイルサイズをさらに小さくすることが可能です。

• 圧縮オプションの設定方法: setup.py内で圧縮オプションを指定します。
• 圧縮率の比較: 圧縮を行うことで、ファイルサイズがどれだけ減少するかを確認します。
• 圧縮によるパフォーマンスへの影響: 圧縮を行うと、起動時に解凍が必要になるため、パフォーマンスに影響が出る場合があります。

以下は、圧縮オプションを設定する例です。

setup(
    console=['your_script.py'],
    options={
        'py2exe': {
            'compressed': True  # 圧縮を有効にする
        }
    }
)

この設定を行うことで、生成されるexeファイルが圧縮され、サイズが小さくなります。

スクリプトの最適化

スクリプト自体を最適化することも、exeファイルの軽量化に寄与します。

以下のポイントに注意して最適化を行いましょう。

• コードのリファクタリング: 冗長なコードを整理し、効率的なコードに書き換えます。
• 不要なライブラリの削除: 使用していないライブラリを削除することで、依存関係を減らします。
• 最適化ツールの利用: pyminifierなどのツールを使用して、コードを圧縮・最適化します。

例えば、以下のようにリファクタリングを行うことで、コードを簡潔にできます。

def calculate_sum(a, b):
    return a + b  # 簡潔な関数

このように、スクリプトを最適化することで、生成されるexeファイルのサイズを小さくすることができます。

不要なモジュールの除外方法

exeファイルを生成する際に、不要なモジュールを除外することは、ファイルサイズを小さくするために非常に重要です。

ここでは、具体的な除外方法について詳しく説明します。

setup.pyでの除外設定

setup.pyファイルは、py2exeを使用してexeファイルを生成する際の設定ファイルです。

このファイル内で、除外したいモジュールを指定することができます。

以下は、setup.pyでの除外設定の基本的な構文です。

from distutils.core import setup
import py2exe
setup(
    console=['your_script.py'],
    options={
        'py2exe': {
            'excludes': ['module1', 'module2']  # 除外するモジュールをリストで指定
        }
    }
)

このように、excludesオプションを使用して、不要なモジュールをリスト形式で指定します。

これにより、指定したモジュールは生成されるexeファイルに含まれなくなります。

モジュールの依存関係の確認

不要なモジュールを除外するためには、使用しているモジュールの依存関係を確認することが重要です。

以下の方法で依存関係を確認できます。

• pip freezeコマンド: 現在インストールされているパッケージのリストを表示します。
• import文の確認: スクリプト内で実際に使用しているモジュールを確認します。
• 依存関係ツールの利用: pipdeptreeなどのツールを使用して、依存関係を視覚的に確認します。

これにより、実際に使用していないモジュールを特定し、除外することができます。

実際の除外例

具体的な除外の例を見てみましょう。

例えば、以下のようなスクリプトがあるとします。

import os
import numpy  # 使用していない場合
import requests
def fetch_data(url):
    response = requests.get(url)
    return response.json()

このスクリプトでは、numpyは使用されていないため、除外することができます。

setup.pyは以下のようになります。

from distutils.core import setup
import py2exe
setup(
    console=['your_script.py'],
    options={
        'py2exe': {
            'excludes': ['numpy']  # numpyを除外
        }
    }
)

この設定を行うことで、生成されるexeファイルにはnumpyが含まれず、ファイルサイズを小さくすることができます。

これにより、不要なモジュールを効果的に除外することが可能です。

圧縮オプションの利用

py2exeを使用して生成されるexeファイルは、圧縮オプションを利用することで、ファイルサイズをさらに小さくすることができます。

ここでは、圧縮オプションの設定方法やその効果について詳しく説明します。

圧縮オプションの設定方法

圧縮オプションは、setup.pyファイル内で簡単に設定できます。

以下のように、compressedオプションをTrueに設定することで、生成されるexeファイルを圧縮することができます。

from distutils.core import setup
import py2exe
setup(
    console=['your_script.py'],
    options={
        'py2exe': {
            'compressed': True  # 圧縮を有効にする
        }
    }
)

この設定を行うことで、生成されるexeファイルは圧縮され、サイズが小さくなります。

圧縮を有効にすることで、ディスクスペースの節約が可能です。

圧縮率の比較

圧縮オプションを利用することで、どれだけファイルサイズが減少するかを比較することが重要です。

以下は、圧縮前と圧縮後のファイルサイズの例です。

この例では、圧縮を行うことで、ファイルサイズが40%減少しています。

圧縮率はプロジェクトによって異なりますが、一般的に数割のサイズ削減が期待できます。

圧縮によるパフォーマンスへの影響

圧縮を行うことで、ファイルサイズは小さくなりますが、起動時に解凍が必要になるため、パフォーマンスに影響を与える可能性があります。

以下の点に注意が必要です。

• 起動時間の増加: 圧縮されたexeファイルは、起動時に解凍処理が行われるため、通常のファイルよりも起動時間が長くなることがあります。
• リソースの消費: 解凍処理にはCPUリソースが必要なため、特にリソースが限られた環境では注意が必要です。

実際の影響は、アプリケーションの内容や使用する環境によって異なるため、圧縮を行った場合と行わなかった場合の起動時間を比較することをお勧めします。

これにより、圧縮の利点と欠点を理解し、最適な設定を選択することができます。

スクリプトの最適化

exeファイルの軽量化を図るためには、スクリプト自体の最適化が重要です。

ここでは、コードのリファクタリングや不要なライブラリの削除、最適化ツールの利用について詳しく説明します。

コードのリファクタリング

リファクタリングは、コードの可読性や保守性を向上させるための手法です。

冗長なコードを整理し、効率的なコードに書き換えることで、ファイルサイズを小さくすることができます。

以下は、リファクタリングの例です。

# リファクタリング前
def calculate_area(length, width):
    area = length * width
    return area
# リファクタリング後
def calculate_area(length, width):
    return length * width  # 不要な変数を削除

このように、不要な変数を削除することで、コードが簡潔になり、可読性も向上します。

リファクタリングを行うことで、スクリプトのサイズを小さくし、exeファイルの軽量化に寄与します。

不要なライブラリの削除

スクリプト内で使用していないライブラリを削除することも、軽量化に効果的です。

以下の手順で不要なライブラリを特定し、削除します。

• インポート文の確認: スクリプト内のimport文を確認し、実際に使用していないライブラリを特定します。
• 依存関係の確認: pip freezeコマンドを使用して、インストールされているライブラリのリストを確認します。
• 削除の実施: 使用していないライブラリを削除し、スクリプトを再テストします。

例えば、以下のようにpandasを使用していない場合、インポート文を削除します。

# 不要なライブラリを削除
import requests  # pandasは使用していないため削除

このように、不要なライブラリを削除することで、依存関係が減り、生成されるexeファイルのサイズを小さくすることができます。

最適化ツールの利用

スクリプトの最適化には、さまざまなツールを利用することができます。

以下は、代表的な最適化ツールです。

これらのツールを使用することで、コードを圧縮したり、実行速度を向上させたりすることが可能です。

例えば、pyminifierを使用してコードを圧縮する場合、以下のようにコマンドを実行します。

pyminifier your_script.py -o optimized_script.py

このコマンドにより、your_script.pyが圧縮され、optimized_script.pyとして出力されます。

最適化ツールを活用することで、スクリプトのサイズを小さくし、exeファイルの軽量化に貢献します。

応用例

ここでは、具体的な応用例として、GUIアプリケーション、データ処理スクリプト、サーバーサイドスクリプトの軽量化方法について説明します。

これらの例を通じて、実際のプロジェクトにおける軽量化のアプローチを理解しましょう。

GUIアプリケーションの軽量化

GUIアプリケーションは、通常多くのライブラリやリソースを使用するため、ファイルサイズが大きくなりがちです。

以下の方法で軽量化を図ることができます。

• 不要なウィジェットの削除: 使用していないウィジェットや機能を削除することで、アプリケーションのサイズを小さくします。
• 画像やリソースの圧縮: 使用する画像やアイコンを圧縮し、ファイルサイズを削減します。
• モジュールの除外: setup.pyで不要なモジュールを除外することで、生成されるexeファイルのサイズを小さくします。

例えば、以下のようにtkinterを使用したGUIアプリケーションのsetup.pyを設定します。

from distutils.core import setup
import py2exe
setup(
    windows=['gui_app.py'],
    options={
        'py2exe': {
            'excludes': ['numpy', 'pandas']  # 不要なモジュールを除外
        }
    }
)

データ処理スクリプトの軽量化

データ処理スクリプトは、特に大量のデータを扱う場合、ライブラリの依存関係が増え、ファイルサイズが大きくなることがあります。

以下の方法で軽量化を図ります。

• 使用するライブラリの見直し: 必要な機能を持つ軽量なライブラリに切り替えることで、依存関係を減らします。
• データの前処理: 不要なデータを事前に削除し、処理するデータのサイズを小さくします。
• スクリプトの最適化: リファクタリングを行い、冗長なコードを削除します。

例えば、以下のようにpandasを使用している場合、必要な機能だけを残すようにします。

import pandas as pd  # 必要な機能だけを使用
def process_data(file_path):
    data = pd.read_csv(file_path)
    # 不要な列を削除
    data = data[['必要な列1', '必要な列2']]
    return data

サーバーサイドスクリプトの軽量化

サーバーサイドスクリプトは、特に多くのリクエストを処理する場合、軽量化が重要です。

以下の方法で軽量化を図ります。

• フレームワークの選定: 軽量なフレームワーク(例：Flask)を使用することで、依存関係を減らします。
• 不要な機能の削除: 使用していないエンドポイントや機能を削除し、コードを簡潔に保ちます。
• キャッシュの利用: データベースへのアクセスを減らすために、キャッシュを利用します。

以下は、Flaskを使用したサーバーサイドスクリプトの例です。

from flask import Flask, jsonify
app = Flask(__name__)
@app.route('/data')
def get_data():
    # データを取得して返す
    return jsonify({'key': 'value'})
if __name__ == '__main__':
    app.run()

このように、軽量なフレームワークを使用し、不要な機能を削除することで、サーバーサイドスクリプトのサイズを小さくし、効率的に運用することができます。

これらの応用例を参考に、実際のプロジェクトにおける軽量化を進めていきましょう。

よくある質問

まとめ

この記事では、py2exeを使用して生成するexeファイルの軽量化方法について詳しく解説しました。

具体的には、不要なモジュールの除外、圧縮オプションの利用、スクリプトの最適化など、さまざまなアプローチを紹介しました。

これらの知識を活用して、実際のプロジェクトでexeファイルのサイズを効果的に削減し、パフォーマンスを向上させてください。