Tkinter、Treeviewでドラッグでスクロールしながら複数選択する方法がわからない。

Question

前提

Python Tkinterを使ってアプリを作っています。
Treeviewでドラッグするとスクロールしながら複数選択する機能を実装中に操作不能になってしまいます。
エラーメッセージは発生せず固まります。

実現したいこと

• 固まる理由を教えていただき、解消したい。
• 現在はスレッドを使ってスクロールしているが、他にシンプルな方法あれば教えていただきたい。

該当のソースコード

import tkinter.ttk as ttk
import threading
import time

class Application(tk.Frame):
    def __init__(self,master):
        super().__init__(master)
        self.pack()

        columns = ["a","b","c","d"]
        self.tree = ttk.Treeview(self, columns= columns)
        for i in range(50):
            self.tree.insert("",i,text="No."+str(i),values=("a"+str(i),"b"+str(i),"c"+str(i),"d"+str(i),))

        #スクロールバー
        hbar = ttk.Scrollbar(self, orient=tk.HORIZONTAL, command=self.tree.xview)
        vbar = ttk.Scrollbar(self, orient=tk.VERTICAL, command=self.tree.yview)
        self.tree.configure(xscrollcommand=hbar.set, yscrollcommand=vbar.set)

        #配置
        self.tree.grid(row=0,column=0,sticky="nsew")
        hbar.grid(row=1,column=0,sticky="ew")
        vbar.grid(row=0,column=1,sticky="ns")

        self.thread = None 
        self.is_alive = False
        self.posy = None
        self.posy1 = None
        self.start_id = None
        
        #bind
        def b1_press(e):
            self.posy=e.y
            self.start_id = self.tree.identify_row(self.posy)
        self.tree.bind("<ButtonPress-1>",b1_press)

        def b1_motion(e):
            self.posy1=e.y
            if not self.is_alive:                                
                self.is_alive = True
                self.thread = threading.Thread(target=self.func)
                self.thread.start()
        self.tree.bind("<Button1-Motion>",b1_motion)

        def b1_release(e):
            if self.is_alive:
                print("リリース スレッド終了開始")
                self.is_alive=False
                self.thread.join()
                self.thread = None
                self.posy = None
                self.posy1 = None
                print("リリース スレッド終了完了")
        self.tree.bind("<ButtonRelease-1>",b1_release)

    def func (self,):
        i=0
        while self.is_alive:
            i+=1
            if self.posy1 == self.posy or self.posy1 == None:
                self.tree["cursor"]="target"
                continue
            elif self.posy < self.posy1:
                self.tree["cursor"]="sb_down_arrow"
                self.tree.yview_scroll(1,"units")
            else:
                self.tree["cursor"]="sb_up_arrow"
                self.tree.yview_scroll(-1,"units")                    
            time.sleep(0.2)
       
            #範囲選択
            tpl=()
            print("止まってしまう")
            end=self.tree.identify_row(self.posy1)#ここで止まる
            print("進んだ")
            is_add=False
            for iid in self.tree.get_children():
                if self.start_id == end:
                    tpl=(self.start_id,)
                    break
                if iid == self.start_id or iid == end:
                    is_add= not is_add #反転
                if is_add == True:
                    tpl+=(iid,)
            self.tree.selection_set(tpl)

if __name__ == "__main__":

    root = tk.Tk()
    app = Application(master=root)
    app.mainloop()

試したこと

ButtonRelease-1 でスレッドの終了させるとき、以下のコードで止まっています。

"end=self.tree.identify_row(self.posy1)#ここで止まる"

なぜ、ButtonRelease-1イベントを経由すると動かなくなるのかわかりません。

補足情報（FW/ツールのバージョンなど）

python 3.9.5
VScode 1.74.0

Answer 1

問題点
GUIへのアクセスは、基本、メインスレッド側でしか行ってはいけません。
複数スレッドからの同時アクセスにより、意図しない挙動になることがあります。

毎回止まっているところは、time.sleep です。
sleepによりスレッドの切り替えが発生する為。
他は数ms しか掛からない処理で、 200ms をsleepで待機しているので
止まりやすい位置ではあります。ただし保証された挙動ではありません。

追記: 質問の意図が、エラーで止まってる方だとすれば、説明補足で
self.posy1 は、メインスレッド側で thread.join() 後に None になるため。
毎回そこのエラーが発生する理由は上述の通りです。

解決策
GUI操作でバックグラウンドで処理を行いたい場合は
GUIライブラリの提供するタイマー機能(tkinter では afterメソッド)を使いましょう。

追記
他の解決策で、今回の用途であれば、<Motion>イベントも使えます。

---

他、GUI等のイベント駆動型プログラムでの禁止項目
イベントハンドラ内での時間のかかる処理。thread.join() 等。

イベント駆動型プログラムでは、イベントループ(tkinterでの mainloop)
内部でイベントハンドラに登録した関数が呼び出され、
描画の更新や、ユーザのマウス・キー入力等のイベント処理を「順番に」行ってます。

そのため、イベントハンドラ内での時間のかかる処理は、
イベントループを止めてしまい、GUIがイベントを処理できず、
その間応答なし状態になります。

今回のコードでは、thead.join() スレッドの終了を待ちますが
別スレッド側では time.sleep しているので最長 200 + α ms の間イベントループが止まります。

GUIライブラリの提供するタイマー機能を使えば、
イベントループ内でタイマー・イベントとして割り込むことができるので、
イベントループを止めることなく、バックグラウンドで処理ということができます。
ただし、タイマー内でループ処理を行いたい場合などは少し工夫が必要です。

無理やりマルチスレッドで動かすなら
（おすすめはしませんが、問題点の把握と症状が解消することの確認の為）

• スレッドを daemonスレッドにする → 終了時に確実に破棄する為
• thread.join() を削除。→ イベントループは止めない。
• posy, posy1 のクリア(None代入) は、スレッド側の終了前・ループ後に行う

厳密には、tkinter 自体が別スレッドで内部ライブラリとやりとりを行っていて
その部分はスレッドセーフなのですが、この操作はスレッドセーフかどうか
という確認作業が操作毎に必要になってしまうので、
基本は、メインスレッドでしかGUI操作を行わない、という設計をお勧めします。
(他のGUIライブラリでは、メイン外からのGUI操作は大抵エラーになります)

Comments

[sedo]

tkinter afterメソッドを使うと問題が解決しました。
イベント内でスレッドを使わない方がよいのですね。エラーの原因も何となくですが理解できました。
ありがとうございました。