PyInstallerで作成するexeを軽量化する方法を解説

この記事では、Pythonで作成したアプリケーションをexeファイルに変換する際に、ファイルサイズが大きくなる理由と、そのサイズを軽くするための方法について解説します。

目次から探す

exeファイルのサイズが大きくなる理由

Pythonで開発したアプリケーションを配布する際、PyInstallerを使用してexeファイルを生成することが一般的です。

しかし、生成されたexeファイルのサイズが大きくなることがあります。

ここでは、その理由を詳しく解説します。

依存関係の取り込み

Pythonのプログラムは、他のライブラリやモジュールに依存していることが多いです。

PyInstallerは、これらの依存関係を自動的に検出し、exeファイルに含めるため、結果としてファイルサイズが大きくなります。

例えば、NumPyやPandasなどの大きなライブラリを使用している場合、それらのライブラリもexeファイルに含まれるため、サイズが増加します。

依存関係を最小限に抑えるためには、必要なライブラリだけを選んで使用することが重要です。

また、--exclude-moduleオプションを使って、不要なモジュールを除外することも可能です。

アセットファイルの含有

アプリケーションによっては、画像や音声ファイルなどのアセットを使用することがあります。

これらのアセットファイルもexeファイルに含まれるため、サイズが増加します。

特に、画像ファイルは解像度が高い場合、サイズが大きくなる傾向があります。

アセットファイルを軽量化するためには、画像や音声ファイルを圧縮することが有効です。

例えば、PNG形式の画像をJPEG形式に変換することで、ファイルサイズを大幅に削減できます。

また、音声ファイルもビットレートを下げることで、サイズを小さくすることができます。

Pythonインタプリタの同梱

PyInstallerは、Pythonプログラムを実行するために必要なPythonインタプリタをexeファイルに同梱します。

これにより、ユーザーがPythonをインストールしていなくてもアプリケーションを実行できるようになりますが、その分ファイルサイズが大きくなります。

Pythonインタプリタを同梱しない方法もありますが、その場合はユーザーにPythonをインストールしてもらう必要があります。

これを避けたい場合は、インタプリタを含めることになりますが、ファイルサイズを気にする場合は、他の軽量化手法を併用することが重要です。

以上のように、exeファイルのサイズが大きくなる理由は主に依存関係の取り込み、アセットファイルの含有、そしてPythonインタプリタの同梱に起因しています。

これらの要因を理解することで、次の軽量化手法を考える際の参考になります。

exeファイルを軽量化するための基本的な手法

PyInstallerを使用して作成したexeファイルは、時にサイズが大きくなりがちです。

ここでは、exeファイルを軽量化するための基本的な手法をいくつか紹介します。

不要なライブラリの除外

PyInstallerは、Pythonスクリプトが依存しているライブラリを自動的に検出し、exeファイルに含めます。

しかし、実際には使用していないライブラリも含まれてしまうことがあります。

これを防ぐために、不要なライブラリを除外することが重要です。

–exclude-moduleオプションの使用

--exclude-moduleオプションを使用することで、特定のモジュールを除外することができます。

例えば、以下のコマンドを実行することで、numpyモジュールを除外したexeファイルを作成できます。

pyinstaller --exclude-module numpy your_script.py

このようにすることで、不要なライブラリを含めずに、ファイルサイズを小さくすることができます。

アセットファイルの最適化

アプリケーションに画像や音声ファイルなどのアセットが含まれている場合、これらのファイルがexeファイルのサイズを大きくする原因となります。

アセットファイルを最適化することで、全体のサイズを軽減できます。

画像や音声ファイルの圧縮

画像ファイルは、PNGやJPEG形式で保存されていることが多いですが、これらのファイルを圧縮することでサイズを小さくできます。

例えば、画像圧縮ツールを使用して、無劣化で圧縮することが可能です。

音声ファイルについても、WAV形式からMP3形式に変換することで、ファイルサイズを大幅に削減できます。

これにより、アセットファイルのサイズを軽減し、最終的なexeファイルのサイズも小さくなります。

Pythonインタプリタの省略

PyInstallerは、Pythonインタプリタをexeファイルに同梱するため、ファイルサイズが大きくなることがあります。

しかし、特定の条件下では、インタプリタを省略することが可能です。

–onefileオプションの活用

--onefileオプションを使用すると、すべての依存関係を1つのexeファイルにまとめることができます。

このオプションを使用することで、インタプリタを含めずに、より軽量なexeファイルを作成することができます。

以下のコマンドを実行することで、your_script.pyを1つのexeファイルにまとめることができます。

pyinstaller --onefile your_script.py

この方法を使うことで、ファイルサイズを小さくし、配布や実行が容易になります。

これらの基本的な手法を活用することで、PyInstallerで作成したexeファイルのサイズを効果的に軽量化することができます。

次のセクションでは、さらに高度な軽量化テクニックについて解説します。

高度な軽量化テクニック

exeファイルのサイズをさらに軽量化するためには、基本的な手法に加えて高度なテクニックを活用することが重要です。

ここでは、UPXによる圧縮とスクリプトの最適化について詳しく解説します。

UPXによる圧縮

UPX(Ultimate Packer for eXecutables)は、実行可能ファイルを圧縮するためのツールです。

UPXを使用することで、生成されたexeファイルのサイズを大幅に削減することができます。

UPXのインストールと設定

UPXは、公式サイトからダウンロードできます。

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

  1. UPXの公式サイト(https://upx.github.io/)にアクセスします。
  2. 最新のリリースをダウンロードします。

Windowsの場合は、upx-<version>-win64.zipを選択します。

  1. ダウンロードしたZIPファイルを解凍し、任意のフォルダに配置します。
  2. 解凍したフォルダのパスを環境変数に追加することで、コマンドラインからUPXを直接呼び出せるようになります。

UPXが正しくインストールされたか確認するために、コマンドプロンプトを開き、以下のコマンドを実行します。

upx --version

UPXのバージョン情報が表示されれば、インストールは成功しています。

UPXを使った圧縮手順

PyInstallerで生成したexeファイルをUPXで圧縮する手順は以下の通りです。

  1. コマンドプロンプトを開き、exeファイルがあるディレクトリに移動します。
  2. 以下のコマンドを実行します。
upx --best --lzma your_program.exe

ここで、your_program.exeは圧縮したいexeファイルの名前です。

--bestオプションは最も高い圧縮率を指定し、--lzmaオプションはLZMA圧縮アルゴリズムを使用します。

圧縮が完了すると、元のexeファイルと同じディレクトリに圧縮されたファイルが生成されます。

圧縮後のファイルサイズを確認してみましょう。

スクリプトの最適化

スクリプトの最適化は、exeファイルのサイズを軽量化するための重要なステップです。

コードを見直し、不要な部分を削除することで、ファイルサイズを削減できます。

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

リファクタリングとは、コードの内部構造を改善することを指します。

以下のポイントに注意してリファクタリングを行いましょう。

  • 重複コードの削除: 同じ処理を繰り返している部分を関数化し、再利用することでコードを簡潔にします。
  • 不要な変数の削除: 使用していない変数や関数を削除することで、コードをスリムに保ちます。
  • ライブラリの最適化: 使用しているライブラリの中で、必要な機能だけをインポートするようにします。

例えば、from module import *ではなく、from module import specific_functionのようにします。

不要なモジュールの削除

PyInstallerは、スクリプト内で使用されているすべてのモジュールを自動的に検出し、exeファイルに含めます。

しかし、実際には使用していないモジュールが含まれていることがあります。

これを防ぐために、以下の手順を実施します。

  1. スクリプトを見直し、使用していないモジュールを特定します。
  2. 不要なモジュールのインポート文を削除します。
  3. PyInstallerの--exclude-moduleオプションを使用して、特定のモジュールを除外することもできます。

例えば、以下のようにコマンドを実行します。

pyinstaller --onefile --exclude-module unused_module your_script.py

これにより、unused_moduleがexeファイルに含まれなくなります。

これらの高度な軽量化テクニックを活用することで、PyInstallerで生成したexeファイルのサイズを大幅に削減することが可能です。

PyInstallerの設定ファイルを活用する

PyInstallerを使用してPythonスクリプトをexeファイルに変換する際、デフォルトの設定ではなく、カスタマイズを行うことで、より効率的にexeファイルを作成することができます。

そのために重要なのが.specファイルです。

このセクションでは、.specファイルの基本的な理解と、カスタマイズ方法について詳しく解説します。

.specファイルの理解

.specファイルは、PyInstallerがexeファイルを生成する際の設定を記述するためのファイルです。

このファイルには、どのスクリプトを実行するか、どのライブラリやアセットを含めるか、さらには出力ファイルの名前や場所など、さまざまな情報が含まれています。

PyInstallerを初めて実行すると、指定したPythonスクリプトに基づいて自動的に.specファイルが生成されます。

例えば、以下のコマンドを実行すると、my_script.pyというスクリプトに対する.specファイルが生成されます。

pyinstaller my_script.py

このコマンドを実行すると、my_script.specというファイルが生成され、これを編集することでカスタマイズが可能になります。

.specファイルによるカスタマイズ

.specファイルを使って、さまざまなカスタマイズを行うことができます。

ここでは、依存関係の管理とアセットの取り扱いについて詳しく見ていきます。

依存関係の管理

.specファイルでは、必要な依存関係を明示的に指定することができます。

これにより、不要なライブラリを除外したり、特定のバージョンのライブラリを指定したりすることが可能です。

例えば、以下のようにhiddenimportsを使って、特定のモジュールを明示的に指定することができます。

a = Analysis(['my_script.py'],
             pathex=['path/to/your/script'],
             binaries=[],
             datas=[],
             hiddenimports=['module1', 'module2'],  # 必要なモジュールを追加
             hookspath=[],
             runtime_hooks=[],
             excludes=['unwanted_module'],  # 除外したいモジュール
             win_no_prefer_redirects=False,
             win_private_assemblies=False,
             cipher=None,
             noarchive=False)

このようにすることで、必要な依存関係だけを含めることができ、exeファイルのサイズを軽量化することができます。

アセットの取り扱い

アセットファイル(画像、音声、データファイルなど)をexeファイルに含める際も、.specファイルを活用することができます。

アセットを含めるには、datasリストにファイルのパスを追加します。

例えば、以下のように記述することで、特定の画像ファイルを含めることができます。

a = Analysis(['my_script.py'],
             pathex=['path/to/your/script'],
             binaries=[],
             datas=[('path/to/image.png', 'destination_folder')],  # アセットファイルの指定
             hiddenimports=[],
             hookspath=[],
             runtime_hooks=[],
             excludes=[],
             win_no_prefer_redirects=False,
             win_private_assemblies=False,
             cipher=None,
             noarchive=False)

この設定により、image.pngがexeファイルに含まれ、実行時に指定したフォルダに配置されます。

これにより、アプリケーションが必要とするすべてのリソースを一つのexeファイルにまとめることができ、配布が容易になります。

以上のように、.specファイルを活用することで、PyInstallerによるexeファイルの生成をより柔軟にカスタマイズし、軽量化を図ることができます。

目次から探す