discord.pyでの指定時刻処理について

Question

前提・実現したいこと

私はいま、指定時刻（２３時）に、辞書のすべての値を-1しようと思っています
しかし、whileなどで、書くとそのあとにある、コードが実行されなくて困っています（ずっとループしてしまうため）。これを両立させることはできないのでしょうか？調べても、期待していたものとは違うものばかりだったので、教えてください。（つい最近pythonを始めました。）

該当のソースコード

dt_now = datetime.datetime.now()
if dt_now.hour == 23:
    point_check()

こんな感じに書いてみたのですがうまく行きません
point_checkは自作関数です。

試したこと

whileでループさせてみた。ifで現在時刻と比較させてみた。

補足情報（FW/ツールのバージョンなど）

python3.8.2 windows

Answer 1

discord.py のwindowsでのエラー(SSL証明の更新)にはまって
なかなか動作確認が出来なかったけど、サンプルコードです。

あまりデバッグはしてないので、このまま実用できるコードかどうかは怪しいです。
必要な情報のみ参考にして下さい。(指定時間の計算等は実際には確認出来てません)
動作確認したPythonのバージョンは3.8.3 / win10 64bit

• (1) discord.py: tasks.loop で一定時間毎に実行
• (2) asyncio: 任意のループを組み込む方法 (asyncio での作法で書く必要があります)
• (3) asyncio: call_later, call_at で指定日時に関数を実行
• (4) 1 と 3 を組み合わせたお勧めの方法

1.2 は、自分のループを両立させる方法のデモで、毎分チャンネルに何か発言します5回
3.4 は、本題の指定時間に毎日実行です。4番がお勧めの方法。

何れの方法を取るとしても、ループで毎分時間をチェックするよりも、
指定時間に関数を実行のcall_laterを起点にするとよいです。

---

import asyncio
import datetime
import discord
from discord.ext import tasks


# ※ 必須設定
BOT_TOKEN = "XXXXXXXX"
CHANNEL_ID = 99999999



def get_next_time(now, hour=23):
    # 既に23時過ぎの場合、翌日の23時迄の秒数を返す
    next_time = datetime.datetime(now.year, now.month, now.day, hour, 0, 0)
    delta = next_time.timestamp() - now.timestamp() # 23時から現在時刻を引く
    return delta if delta > 0 else (delta + 1*24*60*60) # マイナスであれば一日加算


def main():
    client = discord.Client()

    @client.event
    async def on_ready():
        loop = asyncio.get_running_loop()
        channel = client.get_channel(CHANNEL_ID)

        # テスト用フラグ
        USE_TEST1 = True
        USE_TEST2 = False
        USE_TEST3 = False
        USE_TEST4 = True

        # (1) discordの提供する、一定時間に起動する関数 (60秒毎に5回)
        #     前後の処理(before_loop,after_loop)が不要であれば、一番手軽な方法です。
        # https://discordpy.readthedocs.io/ja/latest/ext/tasks/
        if USE_TEST1:
            @tasks.loop(seconds=60.0, count=5)
            async def task_loop_func():
                await channel.send("TEST1")
                pass

            @task_loop_func.before_loop
            async def on_task_loop_before():
                print("START TEST1")

            @task_loop_func.after_loop # <-- このタスクはキャンセルされたときも呼び出される
            async def on_task_loop_after():
                print("DONE TEST1")

            # タスクを起動
            task_loop_func.start()

        # (2) 非同期のループを起動する方法 (asyncio)
        if USE_TEST2:
            # asyncio でのループの記述の仕方
            # time.sleepやループは、イベントループ(discord通信等)を止めてしまうので
            # 必ず asynci.sleep を使います。
            async def my_loop_func(channel, seconds=60.0, count=5):
                print("START TEST2")
                for _ in range(count):
                    await channel.send("TEST2")
                    await asyncio.sleep(seconds)
                print("DONE TEST2") # <-- キャンセルされた場合中断されます

            asyncio.ensure_future(my_loop_func(channel))

        # (3) call_at, call_later で指定時間に処理
        # 注意点:
        #   call_at は loop.time() を基準とした秒数,
        #   call_later は loop.time() を抜いた秒数なので、 (例: call_later(5, func) 5秒後に実行)
        #   この場合、call_later の方が使いやすいのですが、サンプルの為 解り辛い call_at の使い方を解説。
        if USE_TEST3:
            async def test3_func(channel):
                await channel.send("TEST3")
                loop.call_later(1*24*60*60, lambda:asyncio.ensure_future(test3_func(channel)))

            next_time = get_next_time(datetime.datetime.now())
            when = loop.time() + next_time
            handle = loop.call_at(when, lambda:asyncio.ensure_future(test3_func(channel)))


        # (4) 上記を組み合わせた方法
        #
        # 1. tasks.loop で24時間毎に実行するタスクを作る
        # 2. call_later で指定時にタスクを開始
        if USE_TEST4:
            @tasks.loop(hours=24)
            async def test4_func():
                await channel.send("TEST4")

            next_time = get_next_time(datetime.datetime.now())
            loop.call_later(next_time, test4_func.start)

    client.run(BOT_TOKEN)


if __name__ == '__main__':
    try:
        main()
    except KeyboardInterrupt:
        pass

Answer 2

念の為確認しますが、discord.py のバージョンは何でしょう？

古いものでなければ、discord.py は asyncio というライブラリ上で動いているので、
このライブラリの作法で書く必要があります。(async/await等の理解が必須です)

---

両立させることはできないのでしょうか？

可能ですが、一度の実行で良いならcall_later, call_at で指定日時に関数を実行できます。

参考: discord.py 時間を比較し数日後にBANを解除する

Comments

[siroRabi]

version 1.4.0aでした失礼しました。
1度ではなく毎日23時に実行したい時はどうすれば良いでしょうか？

[teamikl]

一度実行した時に、24時間後に同じ関数を実行するようにします。
call_later(1*24*60*60, func, args)

追記: 一度で～というのは、「辞書のすべての値を-1」についてでした。
ループで書くと ２３ 時にずっと -1 し続けてまうので、合わせて他の対策が必要です。

[teamikl]

他の方法思いついたのでメモ

IFTTT 等で指定時間にメッセージを発言するように設定できれば、(出来るのか確認はしてません)
bot 側では通常のメッセージを拾って指定時間に実行と出来ますね。
環境整備が少し大掛かりになりますが。