Python exe化したGUIアプリ、起動したらFatal Errorになる

Question

一つのPythonのファイルについて　開発作業を終えたので　PyInstallerで　exe化を図ったのですが、
仕上がったexeファイルを実行すると　以下のとおり致命的エラーを招きます。

【exe化の作業の上で心配している点】
勉強がてらPythonのコーディングしていた際と違い、プログラムファイル（.py）と同じパスに置かれたフォルダ内の画像や
ありとあらゆるパッケージ・モジュールを多用して　完成させました。
それでいて、ドス窓からPyInstallerを利用する際に指定したのは　.pyのファイルだけ、
プログラムの中で利用している画像のためのフォルダ、パッケージは　PyInstallerから認識できているのかなぁ　という不安があります。

以下コマンドを実行しました。

py -m PyInstaller C:\Users\hoge\source\repos\MARTINEZ\MARTINEZ\MARTINEZ.py --onefile --noconsole

--noconsoleのオプションを外して仕上がげたEXEを　実行した結果になります。

22:11PM

Comments

[teamikl]

(noconsoleではエラー原因が解らない為)
--noconsole オプションを消して、コンソールに出力されるエラーを提示してください。

--onefile オプションでは、画像などのリソースはEXEファイル内に含まれ
実行時にTempなどへ展開されるようになります。
ソースコード側で実行時情報からPATHを得るように対応が必要です。
(_MEIPASSで検索すると対応方法の情報が見つかります)

他にも、デバッグ時とexe化後では実行時の環境が変わる為、
`sys.argv[0]` や `__file__`といった実行時情報の扱いは、別途対応が必要です。

pyinstaller Run-time Information
https://pyinstaller.readthedocs.io/en/stable/runtime-information.html

[saya24]

いつもお世話になっております。
分かりやすいところから対応していきます。
まずPyInstaller実行時に　--noconsoleの指定をやめるところからですね

[saya24]

本文に　PyiIstallerの実行結果を貼り付けなおしました。
仰られていたのは　--noconsoleを外してexe化し　仕上がったexeを実行した結果をこちらに貼ることですよね？？

exeが仕上がらなくなってしまいました。

おっとベルマークが

[teamikl]

C:\Users\hoge> で実行してますが、これは前回と同じですか？
（同じ条件で 再度--noconsole付ければ成功しますか？）

[teamikl]

順序的には --noconsole 付きでビルドして
先にエラーメッセージを確認した方が良さそうです。

回答は、画像等のリソースを含める場合の対応方法になります。

[saya24]

すみません、コマンドを間違えておりました。--noconsoleを指定しないバージョンのexe、無事仕上がりました。
アカウントを隠して　実行コマンドをこちらに貼り付けたのですが、それを再利用してしまいました。

今から仕上がったexe（--noconsoleを指定しないバージョン）の実行して　結果を本文に貼り付けます。

[teamikl]

> 22:11PM更新分

ログを見た限り、画像の参照に失敗しているので
回答に書いた対応を試してみてください
- exeファイルに画像を含める方法 (--onefileの場合、--add-dataで指定)
- 実行時の画像のpath を実行時情報 sys._MEIPASS から得る

Answer 1

プログラムの中で利用している画像のためのフォルダ、パッケージは　PyInstallerから認識できているのかなぁ　という不安があります。

自動で認識されないので、これは追加で指定が必要ですね。
ディレクトリ構成次第ですが、一例を挙げるとコマンドラインで指定する場合は
--add-binary "images/*.png;images" ← ; の左側がプロジェクト内で参照する画像のpath/ 右側が実行時展開されるフォルダ

一度実行した後に生成されるspec ファイル編集でも指定できます。

---

ファイルのPATHについては、

ファイルを相対パスでしている場合は全て修正が必要です。

ファイルのpath所得方法を、スクリプトを実行した場合と、
exe化してから実行した場合で別ける必要があります。

デバッグ時は、大抵スクリプトファイルのある場所がカレントディレクトリですが、
インストール後は、exeファイルの場所がカレントディレクトリとは限らない点にも注意。

追記: コード側の対応方法 (resource_path 関数はbundling-data-files-with-pyinstaller-onefile から借用

import os
import sys
import tkinter as tk

def resource_path(relative_path):
    try:
        # PyInstaller creates a temp folder and stores path in _MEIPASS
        base_path = sys._MEIPASS
    except Exception:
        base_path = os.path.abspath(".")

    return os.path.join(base_path, relative_path)


IMG_PATH = resource_path("./images/sample.png")


def main():
    root = tk.Tk()
    photo = tk.PhotoImage(file=IMG_PATH)
    button = tk.Button(root, image=photo)
    button.pack()
    root.mainloop()


if __name__ == '__main__':
    main()

Comments

[saya24]

やはり、カッコつけて行った　TkInterのフォーム右上のアイコンを変えている画像を　読み込めていない、という問題でしょうか....

PyInstallerのコマンド実行時に　画像フォルダのありかを宣言する必要がある、ということでしょうか？
例を示して頂きましたが　imagesフォルダに　png　gif　色々入っていて利用しました

[teamikl]

画像の参照ができてないようですね。対応手順としては上記の２点です
・--add-data でEXEファイルに画像をリソースとして含める
・上述の様な resource_path 関数を使い、デバッグ時とEXE後でのファイルのPATHを切り替える

[saya24]

ご見解をありがとうございます。
初歩的なことの確認ですが、２点とは　いづれかですか、それとも両方施さなければなりませんでしょうか？
一先ず　--add data の方策を今からとってみようと思いますが
例に挙げて頂いているのは　ワイルドカードが効く？　ということでしょうか？　分かりが悪くて本当に恥ずかしいのですが

[teamikl]

両方必要です。

--add-data で画像を exe ファイル内に含める。
--onefileで作成されたexeは、実行するとTemp 以下にファイルを全て展開します。
（これはプロセスが終了すると自動的に消えるので気にする必要はありません）

その時展開される path が sys._MEIPASS に設定されるので、
sys._MEIPASSが設定されている場合(=EXE化した場合)はそちらからファイルを読み込むようにPATHを変更します。

----
ワイルドカードは有効です。--add-data を複数回指定も可能です。
複数の多様なファイルを含めたい場合は、specファイルに記述した方が良いかもしれません。

[saya24]

両方なんですね、やはり聞いてよかったです。ちょっと　お時間がかかりそうです（泣）。
仕上がったはずと思ったコードに手を入れることになるとは....

--add-data"images/*.png;images"　という例を示して頂きましたが
この例では　imagesフォルダ内の　拡張子pngしか　適用されないということでしょうか？
この他　gif　や　icoが　同フォルダから参照されている作りなのですが　--add-dataを　PyInstallerに併記するのでしょうか？？　何から何まで聞いてすみません

[teamikl]

後少し・・と言いたいところですが、--onefile する場合は実行環境が変わり
他の問題を引き起こすことも有るので。地道に対応していくしかないですね。
EXE化に関しては --noconsoleなしをデバッグ用として、--noconsoleありをリリース用で再度テストが必要です。

ワイルドカードで良いのですが、imagesフォルダ内全てなら
pyinstaller --onefile --add-binary "images;images" 他のオプション・・・というコマンドになります
https://pyinstaller.readthedocs.io/en/stable/usage.html#options-group-what-to-bundle-where-to-search

※ 区切り文字の ; は windowsの場合です。
※ 左側の images はプロジェクト外から実行の場合はフルパスで記載してください。
pyinstaller --onefile --add-binary"C:\Users\hoge\source\repos\MARTINEZ\images;images" ・・・

訂正: --add-data -> --add-binary の方が良さそうです。
binary は DLL ファイルなどが対象と公式のマニュアルで読んだのですが、
例文に png ファイルも --add-binaryで設定している例がありました。

[teamikl]

回答も --add-data -> --add-binary に変更しました。
ですが、自分の環境(win10 python3.8.3) では --add-data でも成功してます。
(簡単なサンプルしか試してません)

[saya24]

ご親切な提案をいつもありがとうございます。
PyInstallerの実行時には　--add-binaryで　対応することにします。

明朝にはプログラム側の改修を終えて　報告できるようにします。まずはお礼まで

[saya24]

teamiklさん　ご提案頂きました改修を済ませ　かつコマンドプロンプトからPyInstallerでEXE化する際に　画像のイメージファイルをありかを指定する手立てで　無事に動作するEXEを仕上げることができました。

至れりつくせりのご対応ありがとうございました、またご連絡遅くなり申し訳ありません。

EXE化のあとには　あとで　相応の動作検証が必要のようですねｌ
デバッグ実行時には　気が付けない　盛り込むべき仕様があること　痛感致しました。

またご支援を頂けたら幸いです。明らかに　追加で対応しなければならない仕様があるみたいで頭が痛いです

Answer 2

プログラムファイル（.py）と同じパスに置かれたフォルダ内の画像や
ありとあらゆるパッケージ・モジュールを多用して　完成させました。

実行ファイルと同じフォルダにそれらはあるんでしょうか

ValueError: script 'C:\Users\hoge\source\repos\MARTINEZ\MARTINEZ\MARTINEZ.py' not found

存在しないとおっしゃってます

Comments

[saya24]

あちゃ～失敗しました、こちらに実行コマンドを貼り付ける際、当方のPC上のアカウントを隠すため　hoge　にしたのですが　それを再利用（--noconsoleでコマンドたたくとき）してしまいました。

できました、noconsleのVerのexeが。
今から実行して　結果を本文に貼り付けます。

[y_waiwai]

なんか変わってるようには見えませんが。。

[saya24]

本文への　貼り付け　只今完了しました。