pythonでの処理を遅らせる方法（after, time)

Question

pythonでRPGのような自作ゲームを作っています。その中で、自動戦闘の場面があります。
「Aの攻撃！　⇨　Bに１００ダメージ！　⇨Bの攻撃！⇨　・・・・・・」
と表示させるのを、tkinter.StringVar()を使ってlabelで表示しているのですが、
「Aの攻撃！」と表示した後、1秒くらい待ってから「Bに１００ダメージ！」を出さないとプレイヤーが文字を読めないじゃないですか。

そこで、

def game():
    Text1.set(NR[Left] + "の攻撃！")
    time.sleep(1)
    Text1.set(NR[Right] + "に１００のダメージ！")

としました。ところがこれだと、一つ目のTextがsetされる前にスリープ処理が入ってしまい、速攻で二つ目のTextがsetされて表示されてしまいました。
time.sleepの場所を、cv.after(1000)と変えてみても、結果は同じでした。
一応解決策は見つけたのですが、

def game():
    Text1.set(NR[Left] + "の攻撃！")
    cv.after(1000,game2)
def game2():
    Text1.set(NR[Right]+"に"+ str(atkAll[Leftdata]) +"のダメージ")

このようにしたら目的の動作はしてくれました。が、これはちょっとめんどくさいので何かいい方法はありませんか？
抽象的な聞き方をしてしまって申し訳ありません、よろしくお願いします

PCはMacOS　BigSur 11.2.1
Pycharmでコードを書いています。

Answer 1

この問題、単にメッセージを適当なタイミングで表示するだけではありませんよね。ゲームなのですから、

敵のターン -> 行動の選択 -> 敵の攻撃 -> 当たり判定 -> ダメージ算出 -> 状態変更 -> 自分のターン ・・・

のような、そのゲームの流れをコントロール/支配している部分(コア)というのがある(これから作る)と思います。
そして、ゲームの進行のタイミングもそのコアが適切に調整すべきですし、メッセージの表示はコアが担当するのが適当でしょう。

Comments

[tom_honmono]

なるほど、確かにそうですね。今後機能をつけていく中でそうしたいと思います、ありがとうございます

Answer 2

タイマー＆コールバックを使ったコードを、
ジェネレーターで書き換える方法があります。

import tkinter as tk

import gentimer

root = tk.Tk()
label = tk.Label(root)
label.pack()

def count_up(count):
    for num in range(count):
        label.config(text=str(num))
        yield 1  # sleep 1 sec without blocking

gentimer.tk(root, count_up(10), root.quit)
root.mainloop()

今、PyPI に登録しようとしてるのですが、
数行で出来るので、実装方法も紹介。
（pypi に登録したパッケージでは、処理のキャンセル迄を実装してます。）

def gen_timer(root, gen):
    def _next():
        interval = next(gen, None)
        if interval is not None:
            root.after(int(interval*1000), _next)
    root.after_idle(_next)

# gen_timer(root, count_up(10))

解説: ジェネレーターを使うと yield の部分で処理を中断、
再度 next() で呼ぶと、続きから再開できます。

この仕組をイベントループのタイマーと組み合わせて、yield で 待機したい秒数を返し、
イベントループ側では、指定秒数後に続きの処理を再開～次のyield 迄実行、という風にしてます。

• repo

追記: ドキュメント書きかけのままですが、質問と同じような流れで
time.sleep での待機 → GUIのイベントループ内では一瞬フリーズする
→ タイマーを使って解消 → コールバック多用することになりコードが追い難くなる
→ ジェネレーターを使って解消

---

Demo スペースキーの入力待等も同様に、同じ関数内で処理できます。

• CountDown demo (generator版)
• CountDown demo (asyncio版)

Comments

[tom_honmono]

ありがとうございます。難しいですが、おそらく僕が求めていたものがそれです。

[teamikl]

丁度昨日、パッケージを作る練習の題材としていたので、
自分にとってタイムリーな話題でした。
登録したので pip install gentimer でインストール可能です。

Answer 3

呼び出し部分が少し説明が必要かなと思ったので、
ジェネレーターを使った実装（サンプル）

import tkinter as tk

root = tk.Tk()
text = tk.StringVar()
label = tk.Label(root, textvar=text)
label.pack()


### [Step1] この関数を導入します
def gen_timer(root, gen):
    def _next():
        interval = next(gen, None)
        if interval is not None:
            root.after(int(interval*1000), _next)
    root.after_idle(_next)

def game():
    text.set("味方の攻撃！")
    yield 1  ### [Step2] time.sleep(1) の部分を置き換え
    text.set("敵に100のダメージ")

### [Step3] 呼び出し方法を変更。
gen_timer(root, game())

### ボタンのイベントcommand 等に登録する際は、
# イベント実行時に、gen_timer 関数が呼ばれるように構成する。
# ジェネレータを作成するタイミングが異なる点が注意

# 従来: 関数を登録していたところを
#   command=game
# OK:
#   command=lambda: gen_timer(root, game())
# NG: 2回目以降の呼び出しで、ジェネレーターが再利用されてしまう → 2回目以降反応しない
#   command=functools.partial(gen_timer, root, game())

button = tk.Button(root, text="start")
button.config(command=lambda:gen_timer(root, game()))
button.pack()

root.mainloop()

変更が必要な点は３箇所

• Step1: ユーティリティ関数の導入
• Step2: time.sleep -> yield へ変更
• Step3: 呼び出し部分の変更

---

※ functools.partial を使いたい場合は、
ジェネレータ生成を遅らせるように、少し工夫が必要です。

functools.partial -> lambda は殆どの場合、書き換えが可能です。
引数の順序をどうこうする、パズル的な難しさがありますが、
うまく使えると、記述を簡潔に出来たり実行効率を良くしたり出来ます。

それぞれ状況に応じて長所短所があるので、
確実な方法は、新たな関数を作る方法です。

from functools import partial

def gen_timer_func(root, func):
    gen_timer(root, func())

button.config(command=partial(gen_timer_func, root, game))


## 引数を渡したい場合は、少し複雑になります。

## functools.partial を使う場合
make_game = partial(game, arg1, arg2)
button.config(command=partial(gen_timer_func, root, make_game)

## lambda を使う場合。記述はシンプルになりますが
# 注意点: for文内で使うと想定した挙動にならない落とし穴があります。
button.config(
  command=lambda: gen_timer(root, game(arg1, arg2))))

# arg1, arg2 がループ内で変化する変数の場合、このような対策が必要になる
button.config(
  command=lambda arg1=arg1, arg2=arg2: gen_timer(root, game(arg1, arg2))))

## 関数
# 無難な方法は（少し手間でも）関数を定義する方法です
def start_game():
    gen_timer(root, game(arg1, arg2))

button.config(command=start_game)