【Python tkinter】after()メソッド：関数を指定時間経過後（定期的）に実行する

after()メソッドとは

after()メソッドでは、
指定した時間経過後に関数を実行する機能を提供します。

つまり関数の実行スケジュールを行えるということです。

すべてのウィジェットはafter()メソッドを使用できます。

第一引数delayには時間（ms秒）を指定し、第二引数callbackには関数を指定します。
after()メソッドでこれら引数を指定することで、ms秒後に指定した関数実行することができます。

after()メソッドの戻り値としてIDが返されます。
これはafter()メソッドで登録した関数の実行をafter_cancel()メソッドで取り消しする際に使用します。

またafter()メソッドで実行される関数は、mainloop内で実行されます。

after()メソッドの注意点として、
指定された時間経過後に必ず関数が実行されるわけではないです。

指定した関数はmainloopで実行されるため、アプリケーションがbusy状態の場合、mainloopが実行されずに指定時間を経過しても実行されないという可能性はあります。

after()メソッドの特徴

ここまでで説明してきたafter()メソッドの特徴を以下にまとめます。

• 指定した時間経過後に関数を実行する機能を提供
• すべてのウィジェットに対して使用可能
• 戻り値としてIDが返される（after_cancel()メソッドで実行の取り消しを行う）
• after()メソッドで実行される関数はmainloop内で実行される
• アプリがbusy状態の場合は指定時間経過しても関数が実行されない可能性がある

ラベルに時計を表示

本プログラムでは、tkinterのラベルウィジェットに時計を表示しています。

ラベルウィジェットについては以下記事で詳しく解説していますので、そちらをご参照ください。

【Python/Tkinter】Label（ラベル）の使い方：文字フォント・サイズ・色・配置の設定

【Python】ttk：Label（ラベル）の使い方（フォント・サイズ・色のオプション設定）

現在の時刻を出力

現在の時刻（フォーマット済み）を出力するために、time_string()関数内でtime.strftime()を用いています。

def time_string():
    return time.strftime('%H:%M:%S')

datetimeオブジェクトを文字列に変換するstrftime()メソッドについては以下記事をご参照ください。

datetimeオブジェクトを文字列への変換（strftime()メソッド）

毎秒時計の表示を更新

時計表示を毎秒更新するためにまずはafter()メソッドを用いて、1000ms秒後にupdate()関数を実行します。

label.after(1000, update)

1000秒後に実行されるupdate()関数では、ラベル表示を現在の時刻で更新し、再度1000秒後にupdate()関数を実行するafter()メソッドを実行します。

このafter()メソッドにより定期的（1秒ごと）に処理を実行、つまり時計の表示を変更しているのです。

def update():
    label.configure(text=time_string())
    label.after(1000, update)

after_cancel()メソッドとは

after()メソッドで定期的に関数を実行できますが、途中でその定期実行をストップしたい場合もありますよね。

その場合はafter_cancel()メソッドを用いて定期実行のキャンセルを行うことができます。

引数で指定するidは、after()メソッドの返り値を指定します。

サンプルコード

デジタル時計プログラムの進行を止めるストップボタンを追加したプログラムを以下に記します。

import tkinter as tk
from tkinter import ttk
import time

def time_string():
    return time.strftime('%H:%M:%S')

def update():
    global id
    label.configure(text=time_string())
    id = label.after(1000, update)
def stop_time():
    label.after_cancel(id)

root = tk.Tk()
root.title("Digital Clock")
root.geometry("250x80")
root["bg"] = "black"

style = ttk.Style()
style.configure('TLabel', background='black', foreground='red')

label = ttk.Label(root, text=time_string(), font=('Digital-7', 40))
label.pack(expand=True)

button = ttk.Button(root, text='Stop', command=stop_time)
button.pack()

label.after(1000, update)

root.mainloop()

全コードと比べてボタンウィジェットが追加されました。
追加されたボタンをクリックするとstop_time()関数が実行されます。

ボタンウィジェットについては以下記事で詳しく解説しています。

【Python Tkinter】Button（ボタン）の使い方：オプション引数一覧（サイズ・配置・外観）

【Python】ttk：Button（ボタン）の使い方（外観設定・オプション一覧・スタイル設定）

stop_time()関数内でafter_cancel()メソッドを用いて、関数の実行をキャンセルしています。