メインコンテンツへスキップ
見出し画像

Pythonプログラムをpyinstallerでexe化して配布する方法 | Windows

    pythonで作成したプログラムは、当たり前ですが基本的にはpython環境がないと実行できません。しかし、pyinstaller\verb|pyinstaller|というものを使うと.py\verb|.py|のファイルを.exe\verb|.exe|に変換してWindowsならばどこでも実行できるようになります。今回はその方法を詳しく紹介します。

    1. pyinstaller が使える条件

    手順の前に、pyinstaller\verb|pyinstaller|が使える条件について触れます。
    ※ここではWindowsでの解説です。

    ① python3.7以上が正常にインストールされていること
    ② 基本的にpythonのみで動くこと(他の言語を使わない)
    ③ できれば管理者権限があること(※)
    ④ 64bitでの出力は32bitで動かない
     →逆は可能、また32→32、64→64など同じなら当然可能

    ※ 管理者権限に関しては、exe\verb|exe|で実行したときにファイルが信頼できるか?というwindowsセキュリティ\verb|windowsセキュリティ|に引っかかる場合や、セーブデータ用に内部ファイルを書き換えるときにウイルス対策ソフトに引っかかる場合があるので、できれば持っていることが理想です。

    2. pyinstaller のインストール

    まずはpyinstaller\verb|pyinstaller|のインストールです。
    検索欄またはWindows+R→cmdと入力でコマンドプロンプトを開き、以下のように入力します。

    pip install pyinstaller

    これでインストールができるはずです。

    【補足】インストールがうまくいかないときの対処

    先ほどのコマンドでインストールが完了すればよいですが、実際そんなうまくはいかないことがあります。

    たまにpip\verb|pip|コマンドについて、以下のような文言が出てくることがあります。

    'pip' は、内部コマンドまたは外部コマンド、操作可能なプログラムまたはバッチ ファイルとして認識されていません。

    これが出てきた場合は、以下のようにしてインストールを試みてください。

    py -m pip install pyinstaller

    "py"\verb|"py"|のところは、"python"\verb|"python"|や"python3"\verb|"python3"|に変えると動くこともあります。

    これでも動かない場合は、pip\verb|pip|が正常に入っていないことが多いので、一度python\verb|python|を再インストールするほうが早いです。pythonの公式サイトから、Downloads\verb|Downloads|と書いてあるところにカーソルを合わせ、中央のDownload for Windows\verb|Download for Windows|のところのPython 3.13.7\verb|Python 3.13.7|(バージョン番号は変わると思いますが)を押すとインストーラがダウンロードされます。

    画像

    インストーラを実行して、インストールをするのですが、必ず下にあるAdd Python x.xx to PATH\verb|Add Python x.xx to PATH|にチェックを入れてください。pip\verb|pip|がまともに動かない原因はほぼこれです。あとはInstall now\verb|Install now|を押して、指示に従って普通にインストールするだけでOKです。
    ※下のCustomize Installation\verb|Customize Installation|からやってもできますが、Tcl/tk\verb|Tcl/tk|などのチェックボックスを間違えると面倒なので素直に上からやったほうが良いと思います。

    これが終わったら、最初に戻ってコマンドプロンプトからpip install pyinstaller\verb|pip install pyinstaller|を実行してみてください。

    3. 基本の使い方

    次に基本の使い方です。

    まず、exe化したいpythonファイルがあるディレクトリにcd\verb|cd|コマンドで移動します。エクスプローラーでpythonファイルがあるフォルダを開き、上のところをクリックしてアドレスをコピーします。それをコマンドプロンプトに以下のように入力します。

    cd (コピーしたアドレス)

    例えば、cd C:\Users\ユーザ\Apps\verb|cd C:\Users\ユーザ\Apps|のような感じです。

    次に、コマンドプロンプトに以下のように入力します。

    pyinstaller (exe化したいファイル名).py

    abc.py\verb|abc.py|をexeにしたければ、pyinstaller abc.py\verb|pyinstaller abc.py|と入力します。

    これを実行すると、しばらく(数字) INFO:\verb|(数字) INFO:|のようなログが出てくると思いますが、放置して大丈夫です。最終的にINFO:Build Complete!\verb|INFO:Build Complete!|のような感じで出てきて、コマンドプロンプトに新たなコマンドが入力できるようになっていれば成功です。

    ここで生成したexeファイルは、先ほどcdで移動したディレクトリに生成されているdist\verb|dist|というフォルダの中にあります。実行すればpythonで実行した時と同じようになるはずです。

    ちなみに、dist\verb|dist|フォルダのほかにbuild\verb|build|というフォルダが生成されていると思いますが、これはexe化の処理用なので処理が終わったら削除して大丈夫です。

    4. pyinstaller のいろいろなオプション

    pyinstallerを使うときは、pyinstaller --onefile abc.py\verb|pyinstaller --onefile abc.py|のようにオプションをつけることができます。ここでは代表的な、便利なものを紹介します。

    ※以下、ここでは例としてabc.py\verb|abc.py|をexe化する構文を書きます。

    (1) --onefile

    --onefile\verb|--onefile|はexe化のときにexe一つにまとめてくれるオプションで、非常によく使われます。構文は以下のようになります。

    pyinstaller --onefile abc.py

    これを実行すれば同様にdistの中にexeができ、それ単体で動かすことができるので配布もしやすいと思います。

    (2) --windowed , --nonconsole

    次に--windowed\verb|--windowed|と--nonconsole\verb|--nonconsole|で、これはどちらも同じ意味で「実行時にコマンドプロンプトを開かず、ログを表示しない」ようにします。公式的には--windowed\verb|--windowed|が推奨されているようです。構文は以下のようになります。

    pyinstaller --windowed abc.py
    pyinstaller --nonconsole abc.py

    このコマンドも配布によく使われますが、ログが消える分デバッグには不向きなので、python\verb|python|シェルでわかるうちに可能な限りデバッグはしておきましょう。

    (3) --icon

    --icon\verb|--icon|は指定した.ico\verb|.ico|ファイルをexe化した時のアイコンにできるオプションです。構文は以下のようになります。

    pyinstaller --icon=(ファイル名).ico abc.py

    例えば、img.ico\verb|img.ico|をアイコンにしたい場合はpyinstaller --icon=img.ico abc.py\verb|pyinstaller --icon=img.ico abc.py|のように書きます。ただし、この時指定する.ico\verb|.ico|ファイルはcd\verb|cd|で移動したディレクトリ内に置いておくようにしてください。

    (4) --name

    --name\verb|--name|はexe化した時のファイル名を指定できるオプションです。構文は以下のようになります。

    pyinstaller --name (指定したい名前) abc.py

    例えば、myapp\verb|myapp|という名前にする場合はpyinstaller --name myapp abc.py\verb|pyinstaller --name myapp abc.py|と書きます。

    (5) --add-data

    最後に--add-data\verb|--add-data|です。これは主に--onefile\verb|--onefile|とセットで使うことが多く、特定のフォルダ内のファイルを全てexe\verb|exe|ファイルの中に入れて処理するというコマンドです。例えば画像などを読み込んで使っている場合にはこれを指定することでexe\verb|exe|単体でも実行できるようになるのですが、ちょっと工夫が必要なのでこれは後程解説します。これを使うには、指定フォルダがcdで移動したディレクトリ内にあることが条件です。構文は以下のようになります。

    pyinstaller --add-data "(フォルダ名);(フォルダ名)" abc.py

    (フォルダ名)は各自変更してください。例えばimages\verb|images|フォルダを--add-data\verb|--add-data|する場合は--add-data "images;images"\verb|--add-data "images;images"|と指定します。

    (6) オプションの組み合わせ方

    複数のオプションを同時に使用するときには、以下のように連続して書きます。オプションの順序は実行に関係ないので特に気にする必要はありません。

    pyinstaller --onefile --windowed --icon=img.ico --name MYAPP --add-data "images;images" abc.py

    5. 画像の読み込みを含むプログラムのexe化

    本格的に作成したGUIアプリなどはローカルファイルから画像を読み込むことが多く、それをexe化するにはpyinstaller\verb|pyinstaller|を実行するだけでは不十分で、少し工夫しなければなりません。

    (1) 普通にやるとダメな原因

    画像の読み込みを含む場合、実は普通に--add-data "images;images"\verb|--add-data "images;images"|でやるだけでは実行時にエラーを吐きます。エラー内容は簡単に要約すると「画像が見つかりませんでした」です。含めたはずなのになぜ見つからないとエラーを吐くのでしょうか。

    実はpyinstaller\verb|pyinstaller|でパッケージ化したexeファイルは、exeを実行するときに含めておいたimages\verb|images|フォルダを一時的に_MEIxxxxx\verb|_MEIxxxxx|のようなフォルダを作って展開しています。これはあくまで一時的なものなので、実行が終われば自動で消えます。しかし、プログラム上では「imagesフォルダ」の中にある画像を探そうとするので、当然「フォルダが見つからない」→「画像が見つからない」というエラーを吐くわけです。

    なお、これは相対パス指定での話で、絶対パス指定なら--add-data\verb|--add-data|をする必要もなく正常に読み込めます。しかし、配布したいときは絶対パスだとかなり面倒なので、相対パスで以下の方法で対処するのがおすすめです。

    (2) 対処法と実行方法

    この問題を対処するには、以下のような関数をexe化前のpythonプログラムに付け足してください。

    # パッケージ化用処理
    import sys
    import os
    
    def resource_path(relative_path):
        """PyInstallerでも通常実行でも動くようにする"""
        if hasattr(sys, "_MEIPASS"):
            return os.path.join(sys._MEIPASS, relative_path)
        return os.path.join(os.path.abspath("."), relative_path)

    これが何をしているかというと、pythonでの実行時は普通に指定通りのパス(正確には相対から絶対パスに変換していますが)を返し、exeでの実行時は一時的に作ったほうのファイルパスを返す、ということです。

    ファイルを読み込むプログラムのものもこの関数を利用したものに書き換える必要があります。たとえば、"images\\img.png"\verb|"images\\img.png"|を変数に割り当てている場合は以下のように変更する必要があります。

    (変数) = resource_path("images\\img.png")

    もう一つ例を出しましょう。tkinter\verb|tkinter|を用いて画像を読み込んで変数に割り当てる場合は以下のようになります。

    img = tkinter.PhotoImage(file=resource_path("images\\img.png"))

    本来はtkinter.PhotoImage(file="images\\img.png")\verb|tkinter.PhotoImage(file="images\\img.png")|と書きますが、exe化する場合はresource_path\verb|resource_path|を一度通しておかないといけません。

    この変更ができたらあとは簡単、--add-data\verb|--add-data|を入れてpyinstaller\verb|pyinstaller|を実行するだけです。一応構文を再掲します。

    pyinstaller --add-data "(フォルダ名);(フォルダ名)" (プログラム名).py

    もちろん配布などする場合は--onefile,--windowed\verb|--onefile,--windowed|などのオプションも各自追加して実行してください。

    ちなみにこれは画像に限らず、テキストファイルの読み込みにも使えます。
    基本的にデータを相対パスで読み込む場合はこの方法が便利です。

    6. データの書き出しを含むプログラムのexe化

    先ほどはデータの「読み込み」でしたが、今回は「書き出し」を含むプログラムです。書き出しはゲームのセーブデータなどをopen\verb|open|関数でテキストファイルに記録しておくためによく使いますね。

    実は--add-data\verb|--add-data|で含めたファイルはexe内での変更ができなくなるので、--add-data\verb|--add-data|指定したフォルダに含めてはいけません。かといって何もせずにそのままプログラム内で指定するだけではエラーが出てきます。この対処法は以下のようになります。

    まず、前提として、読み取り専用(画像などを入れる)とそれ以外でフォルダを分けておきます。その後、以下のようなプログラムを追加しておきます。5.で追加したものが残っている場合は消して書き換えてください。

    def resource_path(relative_path, is_save=False):
        if getattr(sys, 'frozen', False):
            if is_save:
                # exe と同じディレクトリを参照
                base_path = os.path.dirname(sys.executable)
            else:
                # 画像などのリソースは展開先を参照
                base_path = sys._MEIPASS
        else:
            # 開発中(python 実行時)
            base_path = os.path.abspath(".")
    
        return os.path.join(base_path, relative_path)

    指定方法は先ほどとほとんど変わりませんが、書き換えを行う場合は第二引数にis_save\verb|is_save|にTrue\verb|True|を指定しておいてください(書き換えない場合は初期値False\verb|False|なので指定不要)。

    7. 配布の方法

    さて、最後に配布の方法を軽くまとめます。
    フォルダ構成は以下のようにすると良いと思います。

    myapp
    ├─ images
    │ ├─ img1.png
    │ └─ img2.png
    ├─ saves
    │ └─ data.txt
    ├─ myapp.exe
    └─ README.txt

    この場合は、exe化のときにはimages\verb|images|のみ--add-data\verb|--add-data|をします。

    あとはこれをzipにまとめたりして、Google DriveやOnedriveなどで共有・配布するのが良いと思います。


    pyinstallerの記事自体はもうネット上に大量にあると思いますが、多少調べてトップに出てくるものには基本的なものしか書いていなかったので、今回自分のためにも記事にしました。ぜひGUIソフトなどをexeにして配布してみてください!

    【この記事を書くにあたってテストした実行環境】
    PC:Windows11 64bit版
    Pythonバージョン: 3.13.7
    pyinstallerバージョン: 6.16.0

    >>>全記事ポータルページはこちら


     
     
    数学とPythonが好きな人です。 主に数学と自作のPythonプログラムの解説記事を書いています。 最近はBVE関連にハマってます… X垢(主にBVE):https://x.com/__init__92435

    あなたへのおすすめ