[Python] データ読み込み中にwxPythonで待機ウィンドウを表示させ、読み込み完了後に閉じたい…

Question

前提・実現したいこと

Python初心者です。
GUIはwxpythonを使っています。
データの読み込みをするプログラムなのですが、読み込むファイル（xlsx）が重いため時間が少しかかります。
そこで読み込んでいる間、読み込み中のウィンドウを表示して読み込みをバックグラウンドで進めたいと思ったのですが、どのようにしたらいいのかで躓いています。

やりたいこととしては

import pandas as pd
import wx

#ここで待機ウィンドウを表示したい。

#####エクセルデータ読み込み#####
E1=pd.read_excel('E1.xlsx')
E2=pd.read_excel('E2.xlsx')
.
.

#読み込みが終わったら待機ウィンドウを閉じたい。

ウィンドウの表示自体は

if __name__ == '__main__':
	app = wx.App()
	frame = Project()
	frame.Show()
	app.MainLoop()

などでできるのは分かるのですが、当然ながらこれをデータ読み込み前に書いてしまうとMainLoopが閉じるまで処理が進みません。
Messsageウィンドウでも同様で、OKボタンを押すまで結局先に進まないため、バックグラウンドで処理が進みません。。

何かのソフトを立ち上げる際に、待機ウィンドウがぽっと出てきて終わったら本ウィンドウが立ち上がる。というソフトを良く見かけるため、不可能ではないとは思うのですが、なかなか似たような疑問や方法を見つけられず躓いております。

###自身で試したコード

import wx
from time import sleep

app = wx.App()
frame = wx.Frame(None, wx.ID_ANY, 'Test', size=(300, 200))
frame.Show()

#####エクセルデータ読み込み#####
E1=pd.read_excel('E1.xlsx')
E2=pd.read_excel('E2.xlsx')

frame.Close()
frame.Destroy()
app.Destroy()

print('wait')
sleep(5)

この場合、ウィンドウを起動直後に立ち上げることはできますが、閉じることはできません。
app.MainLoop()を記入しないと、Close()が機能しないのか閉じられません。
sleepで5秒経ってプログラム自体が終了すれば当然ウィンドウごとプログラムは閉じられますが、それでは意味がなく…プログラムが起動している状態でウィンドウの表示と処理完了後に閉じる操作をするにはどうするのが良いのでしょうか。

##まとめ
main.pyを実行した直後に「読み込み中」のウィンドウを表示させ、読み込みが終わったらそのウィンドウを閉じる。（プログラムは稼働継続）
ということがやりたいことになります。

補足

Anacondaで構築しています。
Pythonは3.8.10
WxPythonは4.1.1です。

Answer 1

前提として、

• GUI はイベントループが稼働している メイン・スレッド側で動かす必要があります。
• 時間の掛かる処理は、バックグラウンド（別スレッド）で行います。

バックグラウンドの処理が終わり次第、ウィンドウを閉じるのですが、
この時、別スレッド側から直接 GUI を操作してはいけなくて、
スレッドセーフな手段、同期キュー等の仕組みを通じて、
メインスレッドのイベントループに通知します。

他スレッド⇒メイン(GUI)スレッドへの簡単な通知方法は、
wx.CallAfter に関数を渡す方法です。

※ wx.CallAfter はスレッドセーフな関数で、内部で同期キュー相当の仕組みが使われてます。

from threading import Thread
import time
import wx

app = wx.App()
frame = wx.Frame(None, wx.ID_ANY, 'Test', size=(300, 200))
frame.Show()

subframe = wx.Frame(frame, wx.ID_ANY, 'loading ...')
subframe.Show()

def finished():
    subframe.Close()
    subframe.Destroy()

def worker():
    time.sleep(5) # ここで時間の掛かる処理

    wx.CallAfter(finished) # メインスレッドから呼び出す (MainLoop内で呼び出される)

thread = Thread(target=worker, daemon=True)
wx.CallAfter(thread.start)
app.MainLoop()

質問のコードでは app.Destory を呼び出してますが、
通常はアプリケーションのMainLoopは稼働させておいて、ウィンドウのみを閉じるようにし、
GUIと関係のない処理は別スレッドで行うようにした方が良いです。

---

関連

• wxPython wiki - LongRunningTasks
• wxPython wiki - CallAfter

Thread/CallAfter のサンプルコード有。

It is a safe way of requesting action of a Window from another thread.

Comments

[Lups20]

ご丁寧に教えて頂きありがとうございます。大変参考&勉強になります。
是非ベストアンサーにさせて頂きたいのですが、その前に一点だけ伺っても宜しいでしょうか。

＜質問＞
頂いたリンク（wxPython wiki - CallAfter）の方では、wx.CallAfter(thread.start)はなく、単純にthread.start()としています。試しに頂いたコードをwx.CallAfter(thread.start)からthread.start()に変更しても問題なく作動したように思えました。どういった違いがあるのでしょうか。前者の方が良い理由があるのでしょうか。

＜余談＞
最初ご回答が理解できずthreadingやキューについても色々と調べ、
「並列処理をする必要があるため別スレッドで処理をするが、スレッドセーフで行わなければならず、そのやり取りに簡単で便利な方法としてwx.CallAfterがある。」という所まで理解できました。
また、wx.CallAfterについては、頂いたリンクや他のページも読んだのですが、プログラムやPythonの基本的な理解が足りないためかはっきりとは理解できず、今の段階では「別スレッドで処理したい関数があり、その中でGUI側の操作をしたい場合やGUI側に値を渡したい場合はスレッドセーフにするためwx.CallAfterを使うのが良い。」という所に留まっています。今後頑張って参ります。。

[teamikl]

> どういった違いがあるのでしょうか。

thread.start の呼び出しはメインスレッドで良いので、
ここのwx.CallAfter(thread.start) は、殆どの場合、大した違いはありません。
重要な CallAfter は、サブスレッドから使う方です。
（要点が解り難くなるので、例として提示するなら thread.start() で良かったかも知れません）

違いは、
CallAfter で登録した関数は、wxPythonのイベントループにスケジュールされ
「MainLoop 内のイベント処理として」呼び出されます。

frame.Show() の時点では GUI は、実際には表示は保証されておらず
MainLoop の時点で確実に描画が更新されるので、ここでの wx.CallAfter(thread.start) は、
実際に画面に描画されてからスレッドが開始されるのを期待します。

稀なケースですが、読み込むファイルが小さく「時間が掛からない処理」だった場合
thread.start()
～例えば、この間に他の処理があり、
app.MainLoop() とした場合、MainLoop が実行されるまでに読み込みが完了してると
ウィンドウが表示されることなく閉じてしまい、（もしくは一瞬で閉じてちらつきのような現象）
読込が始まったのか、呼ばれてないのか判断が付きにくく成ります。

他の解決策: wx.CallLater(1000, finished) # １秒 (1000ms) 後に閉じる
で、ある程度、遅延に感じない程度にウィンドウを表示してる時間に猶予を持たせる。
（wx.CallAfter を説明をしたかったので避けましたが、同様にメインスレッドへの通知として使えます）

====
＞余談について

概ねその通りです。

「CallLater(指定時間後に実行)」「CallAfter（直ぐに実行）」は、
イベントループ上でのタイマー機能を提供するもので、
そのスケジュール管理の為に、優先度付きキューや同期キューを用いてます。
キューの内容を読み出して実行するのは、元々提供されている挙動なので、
簡易的なケースでは CallAfter のみで済みます。

注意点は、CallAfter は MainLoop 内のイベントループから呼び出されるので
「他スレッド → メインスレッド」の一方通行な通知です。
「メインスレッド→他スレッド」や、双方向の通信は他の手段が必要です。

例えば、GUI からの操作で読み込み処理を中断したいといった場合は、
→ 変数を変更し変化を伝える、キューを使う、等。
スレッド間通信としては「threadingやキュー」が汎用的な解決策なので
wxPython 以外でも通用します。

wxPython でのスレッド間通信の手段
- CallAfter (他スレッド → メインスレッド)
- PostEvent/CommandEvent (※ 他スレッド → メインスレッド の場合のみ)
- QueueEvent/ThreadEvent (メインスレッド <=> 他スレッド)
　双方向でスレッドセーフなイベント
- wx.lib.pubsub (双方向)

[teamikl]

訂正:
> frame.Show() の時点では GUI は、実際には表示は保証されておらず
＞MainLoop の時点で確実に描画が更新されるので、

試してみると、Show() の時点で表示されたので、
正確な説明ではなかったです。（他のライブラリと勘違いしてたかもしれない）

[Lups20]

度々詳細にご回答頂きありがとうございます。。
簡単に言えば、違いとしてはMainloop（）前か後どちらでthread.startさせるかどうかで、意図としては処理が極端に早く終わってしまった場合を考えて後の方がより確実。ということですね。

wx.CallLaterについての解決策も参考になりました。ありがとうございます。

メインスレッド→他スレッドを実装するについてはまだまだ勉強が必要そうですが、また取り組んでみたいと思います。その他もまとめて頂き大変勉強になります。
（何気に当たり前に見ることのあるインストール作業や読み込み中のキャンセルボタンは、簡単に見えて色々と考えられている機能なのですね。。）

本当に助かりました！ありがとうございました！

[teamikl]

意図はその通りです。実際は、コメントを書いていた時点で想定した挙動と違ったので
今回のケースでは影響さそうなので無視して貰って構いません。

MainLoop後だと MainLoop() が終わった後と混同しそうな為、説明としては
「MainLoop 外(前)」か「MainLoop 内 … イベントループ内からの呼出」がより適切かな。
違い自体はあり、使い分けも場合によっては存在します。

----
読込のキャンセルは難しそうですね。
強制中断であれば「プロセス」にしたり「シグナル」を使う方法がありますが、

普通に中断処理を実装しようとすると、read_excel は処理が完了する迄ブロック状態なので
読込中、定期的に呼ばれる内部処理の中で、フラグを判定して中断するようにする必要があります。
read_excel の実装次第ですが、(対象がCで書かれた処理だと面倒）
Pythonでは動的にメソッドを差し替える等の方法で対応可能です。

tqdm で pd.read_excel の進捗を表示する方法があるので、
もし読込の進捗表示やキャンセルを実装する場合は、その辺りの情報を参考にしてみてください。

[Lups20]

御返事遅くなってしまいすみません。

＞「MainLoop 外(前)」か「MainLoop 内 … イベントループ内からの呼出」がより適切
すみません。。仰る通りですね。

こちらもご丁寧にアドバイス頂きありがとうございます。
中断の実装はもっと勉強してからになりそうです。。
進捗を表示する方法があるのですね！表示だけでもやってみようかと思います。

ありがとうございました！！

Answer 2

wxPython-複数ドキュメントインターフェイス

というのを使えば複数のウインドウを表示できると書いてあります。
これで別のウインドウを開いて「読み込み中」と表示させれば良いのではないですか。

Comments

[Lups20]

ご回答ありがとうございます。
ただ、伺いたかったこととしては複数ウィンドウを出すことではなく、実行直後に「読み込み中」というウィンドウを一つだけ表示させて読み込みが終わったら閉じる、ということは可能かということだったのですが、分かり難くてすみません。。そういったことは難しいのでしょうか。
（誤解を招いてしまったため、質問内容を編集いたしました。）