Pythonのプログラムが実行される順番で困っています

Question

前提・実現したいこと

PythonのTkinterで、以下のような機能を実現したいです。

1. ボタンを押す
2. ラベルを書き換える（歌詞を表示する）
3. 音楽を再生する

発生している問題・エラーメッセージ

ボタンを押した後、音楽が鳴り終わった後にラベルが変更されてしまうので、ラベルを変更してから音楽が流れるようにしたい。

	現状	目標
1	ボタンを押す	ボタンを押す
2	音楽の再生が始まる	ラベルを書き換える
3	音楽の再生が終わる	音楽の再生を始める
４	ラベルが変更される	音楽の再生を終える

該当のソースコード

ボタンを押すとplay_gameが呼び出されます。play_gameの中では、ラベルを変更する関数change_labelをthreadを用いて呼び出し、さらに音楽を再生する関数play_musicを呼び出しています。しかし、実際には音楽の再生→ラベルの変更の順で呼び出されてしまいます。

play_gameの中のlyric[1]には歌詞（ラベルを書き換える文字）が、lyric[2] lyric[3]には音楽の再生したい部分の開始位置と終了位置（ミリ秒）が、lyric[5]にはファイル名が入っています。

import sqlite3
from pydub import AudioSegment
from pydub.playback import play
import tkinter as tk
import threading


def play_game():
    cur = conn.cursor()
    cur.execute('SELECT * FROM lyrics ORDER BY RANDOM() LIMIT 1;')
    lyric = cur.fetchone()
    thread = threading.Thread(target=change_label, args=([lyric[1]]))
    thread.start() # change_labelをthreadで呼び出し
    play_music(lyric[2], lyric[3], lyric[5]) # play_musicを呼び出し


def change_label(sub): # ラベルを変更する関数
    sub_tk.set(sub)


def play_music(start, end, title): # 音楽を再生する関数
    sound = AudioSegment.from_mp3('./asset/mp3s/' + title + '.mp3')
    sound = sound[start:end]
    play(sound)


dbname = 'data.db'
conn = sqlite3.connect(dbname)

root = tk.Tk()
root.title('Label&Music')
root.geometry("300x300")

sub_tk = tk.StringVar() # ここにラベルを書き換える文字をセットする
sub_tk.set('ここに歌詞が出力されます')

subLabel = tk.Label(root, textvariable=sub_tk) # 書き換えるラベル
subLabel.pack()

playButton = tk.Button(root, text='再生')
playButton['command'] = play_game # ボタンを押すとplay_game()を呼び出し
playButton.pack()

root.mainloop()

conn.close()

試したこと

threadを試したのですがうまくいきませんでした。

Answer 1

問題点:
関数の実行が終わったタイミングでGUIの更新が入る為、
イベントハンドラとして呼び出される関数内に、時間の掛かる処理があると、
描画の更新や他のイベントは遅延してしまいます。

暫定的な回避策としては、音楽再生前に
root.update_idletasks() を呼び出して、明示的に表示を更新する事が出来ます。

但し、メインスレッド(GUIのイベントループ内)で音楽再生をすると、
音楽再生中は他の処理が滞る事になるので、解決策としては
別スレッドで音楽再生をし、メインスレッドでGUIの更新する方法を検討してください。

別スレッドからのGUIの同時更新は、本来は安全な操作ではありません。

Tkinter の場合は、別スレッドから操作しても問題なく動くことが多いのですが、
稀なケースで問題になる場合がある為、あまりお勧めは出来ません。

import time
from threading import Thread
import tkinter as tk
from tkinter import ttk
import logging

# マルチスレッドの場合は、print ではなく logging が便利
logger = logging.getLogger(__name__)

# ログでどのスレッドで実行されているかを確認する設定
logging.basicConfig(
    level=logging.DEBUG,
    format="[%(threadName)-10s] %(message)s")


# このサンプルコードで記述の簡略化の為にグローバルに配置してますが、
# 実際のコードでは適切な場所に配置してください。
root = tk.Tk()
var = tk.StringVar()

def play_music():
    # XXX: 処理をブロックするコード
    logger.info("play music start")
    time.sleep(3) # 音楽を再生の替わりに 3秒スリープ
    logger.info("play music end")

    # 注意点: 別スレッドでこの関数を実行していて
    # ここで、GUI の更新をしたい場合は、通知を行い (hint: queue)
    # イベントループが動いているメインスレッド側から実行するようにします。
    # 複数のスレッドから同時にGUIを操作するのは、スレッドセーフではありません。

def play1():
    """音楽再生が終わってからラベルが変更、の実演"""
    logger.info("play1")
    var.set("label1")
    play_music() # XXX: ラベルの反映は play1 関数が終わってから

def play2():
    """音楽再生前にラベルを変更、の実演"""
    logger.info("play2")
    var.set("label2")
    root.update_idletasks() # <--- ここでラベルの描画更新
    play_music() # XXX: 但し、この間GUIは操作を受け付けない

def play3():
    logger.info("play3")
    var.set("label3")
    # 時間の掛かる処理は別スレッドで実行する
    Thread(target=play_music, daemon=True).start()
    # スレッドの終了を待たずに、play3関数を抜けます
    # → イベントループは停滞せずに、直ぐにラベルの描画更新が行われる

ttk.Label(root, textvar=var).pack()
ttk.Button(root, text="1", command=play1).pack()
ttk.Button(root, text="2", command=play2).pack()
ttk.Button(root, text="3", command=play3).pack()

# イベントループが動き続けてることを確認する為に、
# GUI のプログレスバーのアニメーションを表示します。
# イベントループが止まる場合は、プログレスバーのアニメーションも止まる。
bar = ttk.Progressbar(root, mode="indeterminate")
bar.pack()
bar.start()

root.mainloop()

Comments

[退会済みユーザー]

丁寧かつ複数の解決策をありがとうございます。
root.update_idletasks()を書くことで解決できました。
また、音楽を再生する側の方を別スレッドにすることでも無事解決できました。
私は初心者で、スレッドに関してはググった時に見つけた解決策の1つをコピーしただけで、よく分かっていませんでした。スレッドの使い方からloggingのことまで教えていただき、本当に助かりました。ありがとうございました。