tkinter キー入力の待受の方法

Question

python3とtkinterでテトリスを作っています。

キー入力を判定するために、次のようなプログラムを書きました。

目的は、スペースキーを押すことによる、カウントダウンの開始です。

#グローバル空間

key = ""

def down_key(event):
  global key
  key = event.keysym

def up_key(event):
  global key
  key = ""

def game_main():
  #~~~~
　#一部省略
  #~~~~

  # カウントダウンの待受処理
  # Spaceキーで、カウントダウン開始
  while not key == "Space":
    pass

  count_down() # （他で定義済み）

win = tk.Tk()
canvas = tk.Canvas()

win.bind("<KeyPress>", down_key)
win.bind("<KeyRelease>", up_key)

game_main()
win.mainloop()

このコードを実行したところ、whileループに差し掛かっていることは確認できたのですが、
GUIに対して何度スペースキーを入力しても、ループを抜けることができませんでした。

GUIとwhileの相性が悪いのかもしれないと思ったのですが、どうでしょうか。
また、解決策など教えていただけると幸いです。

Answer 1

このコードだと、game_main() 内でspaceキーを待ち受ける無限ループになってしまい、
win.mainloop() まで到達しないのでそもそもウィンドウすら表示されません。
(ちなみに、 while not key == "Space": の Spaceは spaceの間違いのようです）

tkinterはイベントモデルのようなので、while Trueで無限ループを回すようなコードを書くと
すべての処理がそこでとまってしまいます。

で、スペースキーのハンドリングなのですが、以下のように書くとそれだけで動いてしまいます。
win.bind("<space>",count_down)

ゲーム開始前とゲーム中とでspaceキーの意味が異なると思うので、そのあたりでまだまだ考慮が必要そうですが、手元の環境ではこれで動きました。

Comments

[tetuhiroshi]

言われてみると、そのとおりでした。
ありがとうございます。
そこそこ癖のある（guiはたいていそうだけれど）インターフェースなので、
混乱してしまいました。
tkitnerプログラミングは、やっぱり数をこなさないとだめですかね...

Answer 2

回答ではなく、紹介のみですが

GUIとwhileの相性が悪いのかもしれないと思ったのですが、どうでしょうか。

GUIに限らず「イベント駆動型プログラミング」との相性が良くないです。

ライブラリ/フレームワーク自身もイベント処理をするループを持つので、
2つのループを同時に実行する方法を考えなければなりません。

whileが必要な場面では、タイマーやスレッドを使った解決策が一般的ですが、
他に、ジェネレータやコルーチンで実装するというアプローチもあります。

メインスレッド上で、GUIのmainloopを阻害することなく動作します。
コードはメイン処理のみ抜粋。

def main():
    # 省略

    def game_main():
        drawText("Press space key to start")

        # スペースキー入力を待機
        yield from wait_key_event("<space>", canvas)
        clear()

        # カウントダウン
        for num in [3, 2, 1]:
            item = drawText(str(num), fontsize=100)
            yield 1000 # 1秒(1000ms) sleep
            clear(item)
        else:
            drawText("start!")

    after_timed_gen(root, game_main())
    root.mainloop()

• generator 版デモ source on repl.it
• asyncio 版デモ source on repl.it

---

質問のコードに適応すると、こんな感じになります。

import tkinter as tk

def after_timed_gen(root, gen, _stop=None):
    # タイマーでジェネレータを一つづつ読み出し
    # yield で返された値を遅延時間に指定する(sleep)
    def next_gen():
        interval = next(gen, _stop)
        if interval is not _stop:
            root.after(interval, next_gen)
    root.after_idle(next_gen)

def count_down(canvas):
    for num in [3, 2, 1]:
        item = canvas.create_text(200, 200, text=str(num), font=("", 50))
        yield 1000 # 1秒sleep
        canvas.delete(item)

def game_main(canvas):
    canvas.create_text(200, 200, text="press space key")

    flag = [True] # 空になったらスペースキーが押されたと判断

    canvas.bind_all("<space>", lambda _: flag.clear())
    while flag:
        yield 500 # 0.5秒sleep
    canvas.unbind_all("<space>")

    canvas.delete("all")
    yield from count_down(canvas) # （他で定義済み）

    canvas.create_text(200, 200, text="done", font=("", 30))


win = tk.Tk()
win.geometry("400x400")
canvas = tk.Canvas()
canvas.pack(fill=tk.BOTH, expand=True)

after_timed_gen(win, game_main(canvas))
win.mainloop() # ↑ タイマーで実行するので、mainloop内から呼び出される

※ ジェネレータ版の実装は、タイマーの精度(多分10ms程度が最小) の問題が有るので、
あまりリアルタイム性の高いゲーム向けではありません。

Comments

[tetuhiroshi]

お礼がとても遅くなってしまい、本当に申し訳ありません。
５年前の自分の質問を見返したところ、返信していなかったことに気が付きました。

スキルの上がった今の自分から見ても、要点と重要な本質を簡潔に、しかし、必要十分にまとめていただいた、惚れ惚れするような回答、私には真似できぬ。と思いました。

回答のコード、メモ帳に保存して、寝る前の楽しみとして、ゆっくり読ませていただきます。
再度になりますが、遅れて申し訳ありませんでした。ご活躍を願っています。

[teamikl]

わざわざ丁寧にコメント＆声援ありがとう。

折角なので幾つか情報を更新をしておくと、

この回答に用いたコードの after_timed_gen 関数は、
ジェネレーターを様々な(tk/wx/qt/sched)上で消化する gentimer関数として実装し
pypi に登録しました。https://github.com/teamikl/gentimer

この回答では while で変数状態を0.5秒間隔で常時チェックしてますが、
タイマー自体を一時中断し、 space が押されると再開といった効率の良い実装も可能です。

また、この頃(４～５年前)はジェネレーターで記述してましたが、
今だと、各ライブラリの非同期(asyncio) 対応しているものであれば
ジェネレーターではなく、async/await を用いたコルーチンとして実装すれば
ループの非同期実行も 自然な whle/for 文のコードで記述できます。

====
更に発展・応用的な話題に言及すると、

このジェネレーターを用いたアプローチ (after_timed_gen) を応用することで、
独自にイベントループを持つ複数のライブラリを統合することも可能です。
（ジェネレーター内で別ライブラリのイベントループをステップ実行する）

例えば、matplotlib+tkitner や pygame+tkinter といった組み合わせや、
qt/wx/tk + asyncio 対応みたいな事も実現可能になります。
(非同期処理(asyncio)対応のフレームワーク等でも用いられてます）
====

個人的に、学習の題材探しを兼ねてこのサイトを活用させてもらっていたのですが、
この回答で用いたジェネレーターを使ったアプローチは、日常的に色々な場所で活用してます。
初めてpypiへライブラリを登録したりで、良い機会＆トピックでした。感謝

Answer 3

tkinterのキー入力のハンドリングを含むGUIの処理は、メインループwin.mainloop()の中で行なわれます。
なので、提示のコードのようにメインループの外に作ったループの中ではキーの入力は捕捉されないので、`downkey()'も呼ばれません。

この場合はたとえば、downkey()の中で、Spaceが押されたらカウントダウンするなどの処理にするなどすることになるかと。

Comments

[tetuhiroshi]

回答していただいて、ありがとうございました。
tkinter、やっぱもう少しちゃんと勉強しないといけませんね...
精進します！