PyInstallerの使い方をマスターする – PythonコードをEXE・APPに変換＆トラブルシューティング –

こんにちは、Zero-Cheeseです。

はじめに

実行ファイル化することの重要性

繰り返しになりますが、PythonがインストールされていないPCでは、Pythonが動きません。

また、Pythonがインストールされていたとしても、使用した外部ライブラリ（例えばNumpyなど）が一つでも足りないと、エラーが発生してしまいます。

これらの問題を解決するために、実行ファイル化することは、極めて重要です。

PyInstallerは、Pythonスクリプトを、実行可能ファイルに変換する「ツール」です。

PyInstallerのメリット・デメリット

PyInstallerと他のツール（cx_Freeze、py2exe、Py2appなど）を比較した場合の、メリット・デメリットをまとめました。

PyInstallerのインストール方法

pipを使って、簡単にインストールすることができます。

pip install pyinstaller

pipに関しまして、詳細な解説は、こちらまで

【Python】pipの使い方入門 - コマンドライン、Anaconda、PyCharmからの操作方法を解説 -Python入門者を対象に、pipの使い型を解説した記事です。 コマンドライン、Anaconda、PyCharmからの操作方法を、わかりやすく解説しました。 ...

PyInstallerの基本的な使い方

単一のファイルモード

コマンドは、以下の通りです。

pyinstaller --onefile <スクリプト名>.py

ディレクトリモード

コマンドは、以下の通りです。

pyinstaller <スクリプト名>.py

その他、よく使用されるオプション

pyinstaller --onefile -w --icon=myicon.ico --name=MyApp <スクリプト名>.py

サンプルプロジェクトを通して、実際の使い方を、実感する

① 必要なライブラリをインストール

pipにて、インストールします。

pip install beautifulsoup4 
pip install pyinstaller 
pip install requests 

※ 見やすいように、各行に分けた書き方をしています。（1行で、実行してもOKです。）

② 価格.comのサイトをWebスクレイピングして、価格を取得する「Pythonコード」を作成

今回は、スクレイピングにて、「GPU Nvidia RTX4070」の値段とShop名を取得」しました。

具体的には、下記モデルです。（LED等で着飾らなく、信頼のあるASUSから出しているVENTUSが、筆者のお気に入りとなってきました。）

MSI GeForce RTX 4070 VENTUS 2X 12G OC グラフィックスボード VD8471

created by Rinker

MSI

¥96,800 (2024/05/18 21:52:53時点 Amazon調べ-詳細)

• Amazon
• 楽天市場
• Yahooショッピング

Webスクレイピングを行う際は、対象のウェブサイトの利用規約を確認し、違反しないよう注意が必要です。

Pythonコードのファイル名を、「fetch_prices.py」とします。

「価格.com」のHTML構造が変わると、正常に動かない可能性があります。（2023年9月時点に作成）

以下、コード内容です。

import requests
from bs4 import BeautifulSoup

def fetch_prices_and_shops(url):
    response = requests.get(url)
    response.encoding = 'Shift_JIS'
    soup = BeautifulSoup(response.text, 'html.parser')
    rows = soup.select('#mainLeft > table > tr')
    data = []

    for i, row in enumerate(rows):
        if i < 2:  # Skip header rows
            continue

        price_selector = 'td.p-priceTable_col.p-priceTable_col-priceBG > div > p.p-PTPrice_price'
        shop_selector = 'td.p-priceTable_col.p-priceTable_col-shopInfo > div > div.p-PTShop_info > div.p-PTShopData > p.p-PTShopData_name > a'
        price = row.select_one(price_selector)
        shop = row.select_one(shop_selector)
        if price and shop:
            data.append([price.text, shop.text])
    return data

url = 'https://kakaku.com/item/K0001529517/'  # 価格.comのURL
data = fetch_prices_and_shops(url)
print(f'取得したデータ： {data}')

SHIFT_JIS であること、注意しましょう。

取得したデータ： [['¥85,980', 'XPRICE'], ['¥85,980', 'OCNオンラインショップ(旧NTT-X)'], ['¥88,750', 'ドスパラ'], ['¥88,750', 'パソコン工房'], ['¥89,800', 'ＰＣワンズ'], ['¥90,408', 'Qoo10 EVENT'], ['¥94,660', 'ヨドバシ.com'], ['¥94,660', 'e-zoa-lite.com'], ['¥94,660', 'e-zoa.com'], ['¥96,511', 'グッドウィル\n'], ['¥96,735', 'AcademicStore'], ['¥97,160', 'PREMOA\n'], ['¥97,160', '[Amazon] XPRICE\n'], ['¥99,800', 'Joshin'], ['¥99,800', 'TSUKUMO'], ['¥99,800', 'PCSHOPアーク'], ['¥99,800', 'ゲーミングPcan'], ['¥100,808', 'Amazon.co.jp'], ['¥102,080', 'e-tokka'], ['¥106,040', 'ゆたぷろ'], ['¥106,673', 'e-tokka GOLD'], ['¥128,508', 'アスクル法人向け']]

③ PyInstallerを使用して、実行可能ファイルに変換

上記のプログラムを、PyInstallerを使って、実行可能なファイルに変換します。

pyinstaller --onefile fetch_prices.py

④ 生成された実行可能ファイルを、実行する

PyInstallerが生成した「distディレクトリ」に移動し、生成された実行可能ファイルを実行します。

cd dist
./fetch_prices

PyInstallerを使った方法、イメージがついたでしょうか？

PyInstaller トラブルシューティング対応

① ライブラリが見つからない

ライブラリがインストールされていない場合

例：エラーメッセージがNo module named 'requests'の場合、requestsライブラリをインストールする。

pip install requests

ライブラリをインストールした後、実行可能ファイルを、再度生成する必要があります。

pyinstaller myscript.py

実行可能ファイル生成時に、ライブラリへのパスが正しくない

実行可能ファイル生成時、「コード中にimportされたライブラリが、PyInstallerによって見つけられない場合」に発生します。

解決策は、--pathオプションを使用して、ライブラリの検索パスを追加します。

pyinstaller --path /path/to/module myscript.py

② 実行可能ファイルが動作しない

PyInstallerで生成された実行可能ファイルを実行しても、何も起こらない、またはエラーメッセージが表示されることがあります。

ライブラリが見つからない場合（ImportError: No module named 〇〇）は、前章を参考にして下さい。

エラーメッセージが表示される場合、そのエラーに基づいて適切な対策を取ります。

エラーメッセージが表示されない場合、もしくは、はエラーメッセージから原因が特定できない場合、デバッグ情報を取得することが可能です。

pyinstaller --debug all myscript.py

③ ファイルサイズが大きくなりすぎる

PyInstallerは、生成された実行可能ファイルに、依存関係含め、すべての必要なライブラリを含めるため、ファイルサイズが非常に大きくなる可能性があります。

Pythonの仮想環境を作成し、必要なライブラリだけをインストールする

仮想環境の作成

python -m venv myenv

仮想環境のアクティベート

# Windowsの場合
.\myenv\Scripts\activate

# Mac、Linuxの場合
source myenv/bin/activate

必要なライブラリのインストール

pip install requests beautifulsoup4

PyInstallerを使用して実行可能ファイルを生成する

pyinstaller myscript.py

不要なモジュールを除外する

不要なモジュールを除外するには、--exclude-moduleオプションを、使用します。

pyinstaller --exclude-module unwanted_module myscript.py

実行可能ファイルの圧縮する

◆ UPXのインストール方法

Windows:

• UPXの公式GitHubリリースページ から、Windows用の最新バージョンのUPXをDL
• ZIPファイルを解凍し、upx.exeのPATHを通す or コマンドプロンプトからアクセス可能な場所に保存

Mac：

# Homebrew によるインストールが、簡単です
brew install upx

Linux：

# aptが使える、ディストリビューションの場合：
sudo apt install upx

◆ 実行可能ファイルの生成

例えば、WindowsでUPXをC:\path\to\upxに保存した場合

pyinstaller --upx-dir=C:\path\to\upx myscript.py

さいごに

PyInstallerを使用して、Pythonスクリプトを実行可能ファイルに変換することは、多くの場合、非常に便利です。

この記事では、PyInstallerの使い方と、エラーの対処法に関して、詳しく解説しました。

この記事が、あなたの役に立つことができれば、幸いです。

本記事も、最後までお付き合いいただき、ありがとうございました。

また、お会いしましょう！