pyxel.reset() works locally but crashes after exe build

[shiromofufactory]

本文日本語で失礼します。

pyxel.reset()機能を使ってプログラムを再起動すると、ローカル実行時には正常に動作する（再起動する）のですが、exe実行時はそのタイミングで「Failed to remove temporary directory: C:¥Users¥user¥AppData¥Local¥Temp¥_MEI60002」のようなエラーメッセージが表示されてプログラムが落ちてしまいます。

ChatGPTに問い合わせたところ以下の見解でしたが、これはユーザー側の対応で解決できる問題でしょうか？

症状からすると PyInstaller の one-file 実行形式で展開される一時フォルダ（_MEIxxxxx）のクリーンアップ失敗が原因の可能性が高いです。
pyxel.reset() は内部で自分自身を再実行する（execv 相当）ため、**終了時に親プロセスが _MEI... を削除しようとした瞬間、まだそのディレクトリを掴んでいる（＝カレントディレクトリや開きっぱなしのファイルハンドルが残っている）**と、PyInstaller ブートローダが「Failed to remove temporary directory …」で落ちます。ローカル（.py 実行）だとこの仕組みがないので再現しません。

[kitao]

なるほど。pyxapp自体も一時フォルダを作ってそこで作業するのでexeにしても大丈夫かと思っていましたが、見落としがあったようですね。

恒久的な対策はこれから考えてみますが、お手数ですがひとまずアプリ側でこのコードを追加したら直るかみていただけないでしょうか。

if hasattr(sys, "_MEIPASS"):
    import atexit
    import shutil

    def clear_meipass():
        meipass = sys._MEIPASS
        for name in os.listdir(meipass):
            path = os.path.join(meipass, name)
            try:
                if os.path.isdir(path):
                    shutil.rmtree(path)
                else:
                    os.remove(path)
            except Exception:
                pass

    atexit.register(clear_meipass)

（必要に応じて、import os ,sysも追加をよろしくお願いします）

このコードがやっていることは、PyInstaller実行時は、PyInstallerの一時フォルダ削除に失敗したときは代わりにそのフォルダの中身を空にして、エラーそのものは無視する処理になります（ChatGPTが間違っていなければ）　

[shiromofufactory]

ありがとございます。試してみると、他のエラーが出ました。
（「dungeon-antiqua2」が試しているアプリです。）

Failed to execute script 'dungeon-antiqua2' due to unhandled exception: [Errono 2] No such file or directory: 'C:¥¥Users¥¥user¥¥AppData¥¥Local¥¥Trmp¥¥_MEI68122¥dungeon-antiqua2.pyxapp'

Traceback (most recent call last):
File "dungeon-antiqua2.py", line 1, in
File "pyxel\cli.py", line 310, in play_pyxel_app
File "pyxel\cli.py", line 188, in extract_pyxel_app
File "zipfile_init.py", line 1362, in init
FileNotFoundError: [Errno 2] No such file or directory: 'C:\Users\user\AppData\Local\Temp\_MEI68122\dungeon-antiqua2.pyxapp'

[kitao]

実験につき合わせてしまいすみません。

代わりにこちらだとどうでしょうか（エラーにはしないがフォルダを空にはしません）

if hasattr(sys, "_MEIPASS"):
    import atexit
    atexit.register(lambda: None)

[shiromofufactory]

ソース修正のうえ再度試しましたが、同じ内容のエラーが出てしまうようでした。

[kitao]

ご確認ありがとうございます。週末にこちらで実験環境構築して対応策調査したいと思います。

[kitao]

Pyxel 2.5.4で対策行いましたのでご確認いただけますでしょうか

[shiromofufactory]

ありがとうございます。試してみました。

①サンプル01のhello.pyで試した場合（pyxel.exitを単純にpyxel.resetに置き換え）
→resetは効くが、警告ダイアログが出る
Failed to remove temporary directory: C:¥¥Users¥¥user¥¥AppData¥¥Local¥¥Trmp¥¥_MEIxxxxx

②「dungeon-antiqua2」で試した場合
→resetしたタイミングで落ちる（変わらず）

Failed to execute script 'dungeon-antiqua2' due to unhandled exception: No module named 'unicodedata'

Traceback (most recent call last):
  File "dungeon-antiqua2.py", line 1, in <module>
  File "pyxel\cli.py", line 318, in play_pyxel_app
  File "<frozen runpy>", line 287, in run_path
  File "<frozen runpy>", line 98, in _run_module_code
  File "<frozen runpy>", line 88, in _run_code
  File "C:\Users\user\AppData\Local\Temp\.pyxel\play\f45c23a8-6a26-48aa-ab1e-a331b56e278c\app\main.py", line 2, in <module>
    import util
  File "C:\Users\user\AppData\Local\Temp\.pyxel\play\f45c23a8-6a26-48aa-ab1e-a331b56e278c\app\util.py", line 4, in <module>
    import unicodedata
ModuleNotFoundError: No module named 'unicodedata'

補足として、main.pyからutil.pyをimportし、util.pyからunicodedataをimportしています。
また以下のコードは残したままにしていました。

if hasattr(sys, "_MEIPASS"):
    import atexit

    atexit.register(lambda: None)

[kitao]

手元のM2 Macで試していますが、サンプル1は同様の変更を行なって、バイナリ化したものでリセットができているので、環境の違いかPyxelそのもののバージョンアップがうまくいっていない可能性があるかと思います。実行環境について教えていただけますか。

また、例の追加コードはアプリから無くして問題ありません。（私の環境ではそれなしでexe化したランチャーも動いてアプリの切り替えができています）

[shiromofufactory]

これまでの報告はすべてWindowsでのものでした。システム情報は以下となります。
（念のため追加コードをなくして再ビルドしましたが、同じでした。Pyxelのバージョンも2.5.4であることを再確認しております。

エディション Windows 11 Pro
バージョン 22H2
インストール日 ‎2023/‎06/‎19
OS ビルド 22621.4317
エクスペリエンス Windows Feature Experience Pack 1000.22700.1041.0

Macについては私も実行したところ、問題なく動作しました。

[kitao]

なるほどご確認ありがとうございます。
実は私もWindowで試してみたのですが、一定動作はできた（ランチャーアプリは問題なく動作、01は数回リセットしたところでインタプリターのエラーダイアログが表示された）ので、そこの症状も違う感じですね。
継続調査とさせてください

[kitao]

@shiromofufactory ちなみに、exeにする前のpyxapp版は問題なく動作してますでしょうか？

[kitao]

@shiromofufactory すみません。もうひとつ。17_app_launcherをexe化した場合はどうでしょうか。
こちらが各種Windows環境で問題なく動くようであれば解決のヒントになるのではないかと考えております。

[shiromofufactory]

確認いたしました。

exeにする前のpyxapp版は問題なく動作してますでしょうか？

はい、これは問題なく動作します。

17_app_launcherをexe化した場合はどうでしょうか。

01_hello をexe化した場合と同じで「警告（内容も同じです）が出るが、動作はする」でした。

よろしくお願いいたします。

[kitao]

ご確認ありがとうございました。

その後調査と確認が進み、
PyInstallerでonefile化したアプリを再起動する場合、Windowの時のみ、同じプロセスIDでの起動ができない制約により、PyInstallerの監視ルーチンがアプリが終了したと勘違いして一時展開フォルダを消してしまうことがわかりました。

AIの言うことを信じると、一応定番の回避策があるらしいので、それを試してみる予定です。