python sleepしているプログラムをやめさせたい

Question

実現したいこと

sleepで待機しているプログラムを途中でやめさせることはできるのでしょうか？
ディスコードで「こんにちは」と送信されたら20秒後に「こんにちは」と返すようにしているのですが
「こんにちは」と送信した人がそのメッセージを消すと「こんにちは」と返さないようにしたいです？

該当のソースコード

#メッセージが送信されたら
async def on_message(message: discord.Message):
    # botを対象からはずす
    if message.author.bot:
        return

　#「こんにちは」と送信されたら
    if message.content == "こんにちは":
        await asyncio.sleep(20)
　　 #「こんにちは」を投稿する
        await message.channel.send("こんにちは")

Answer 1

asyncio.sleep の代わりに asyncio.Event.wait / asyncio.wait_for を使いましょう

asyncio.Event

• wait()

内部フラグが真になるまでブロックします。

• set()

内部フラグを真に設定します。それを待っていたすべてのコルーチンが再開します。wait() を呼び出していたコルーチンへのブロックが解除されます。

asyncioのEvent.waitは timeout 引数を取らないので、
wait_for により timeout することで、sleep と同等の待機をします。
タイムアウト時は asyncio.TimeoutError 例外が投げられる点に注意。

import asyncio


# threading.Event と同じような wait に timeout を設定できるようにする場合 
class Event(asyncio.Event):
    async def wait(self, timeout=None):
        try:
            await asyncio.wait_for(super().wait(), timeout)
        except asyncio.TimeoutError:
            pass



async def main():
    from time import time

    start_time = time()

    event = asyncio.Event()
    loop = asyncio.get_running_loop()

    # 3秒後に解除
    loop.call_later(3, event.set)

    # 5秒間スリープ
    try:
        event.clear()
        await asyncio.wait_for(event.wait(), 5)
    except asyncio.TimeoutError:
        pass
    print(time() - start_time)

    ev = Event()
    loop.call_later(3, ev.set)
    await ev.wait(timeout=5)


if __name__ == '__main__':
    asyncio.run(main())

``'

sleepしたい場所で wait_for/event.wait 
キャンセルしたい場合は、event.set を呼び出し、
event.is_set により、キャンセルされたかどうかを判別できます。

質問のコードに適応させるには、メッセージのキャンセルを受ける側の関数への
event オブジェクトの受け渡しに工夫が必要になると思います。
関数外にuser毎に辞書に格納する、等。

Comments

[ngmg]

sleepではないやり方は全く考えつかなかったです。参考にして勉強したいと思います。
ありがとうございました！

Answer 2

asyncio.sleepを直接キャンセルするような処理は、sleepを使用している全ての処理に影響を与えるため、あまり推奨されません。
識別子を入れる等して回避する方法はありますが複雑になります。
https://stackoverflow.com/questions/37209864/interrupt-all-asyncio-sleep-currently-executing

よりシンプルには、下記のようにasyncio の wait_for と Event を使う方法があります。

• メッセージID に対応したイベントごとに20秒間待ち、その間に削除された場合は、そのメッセージに対する返答をキャンセルします。

• 20秒の間に削除されなかった場合はタイムアウトとなり、返答されることになります。

import discord
import asyncio
from asyncio import wait_for, Event

TOKEN = 'discord botのトークン'
intents = discord.Intents.default()
intents.message_content = True  
client = discord.Client(intents=intents)
events = {}  # メッセージIDに対応するイベントを格納する辞書

@client.event
async def on_message_delete(message):
    if message.id in events:
        # 削除されたメッセージに対応する event を set。
        events[message.id].set()
        print("メッセージが削除されました")


@client.event
async def on_message(message):
    # botを対象からはずす
    if message.author.bot:
        return
    #「こんにちは」と送信されたら
    if message.content == "こんにちは":
        try:
            # 20秒の間、削除を待つ。
            events[message.id] = Event()
            await wait_for(events[message.id].wait(), timeout=20)
        except asyncio.exceptions.TimeoutError:
            # 20秒の間にメッセージが削除されなかった場合、botに返事させる。
            await message.channel.send('こんにちは')
        finally:
            events.pop(message.id)


client.run(TOKEN)

Comments

[teamikl]

on_message_delete へ受け渡す方法までは、思い浮かばなかったけど、
メッセージID の辞書の案よいですね。

[qnoir]

コメントありがとうございます！

teamikl さんの、クラスを継承して汎用化する形も勉強になりました。

今気づいたんですがこの場合 .clear() は必要ないですよね・・・（events.pop(message.id)だけでよい）

[teamikl]

再利用しないなら clear は不要ですね。popの戻り値も不要なので Event() もいらないかも。

若干オフトピで
辞書は、weakref.WeakValueDictionary を使うと
辞書からの削除もGC任せにできて pop も省けます。

wait() 前に、フラグ状態を確定させるために clear() を入れることはあるようです。
(不具合があった場合の安全策として）
今回の場合、直近でインスタンスを作っているので、なくても問題ありません。

[ngmg]

こちらの方法で理想の動作ができました。
理解できるように頑張りたいと思います。
ありがとうございました！