如何使用 asyncio 定期执行函数？

Question

我正在从 tornado 迁移到 asyncio，但我找不到与 tornado 的 PeriodicCallback 等效的 asyncio。 （PeriodicCallback 有两个参数：要运行的函数和调用之间的毫秒数。）

• asyncio 中是否有这样的等价物？
• 如果没有，什么是最干净的方法来实现它，而不会冒着在一段时间后获得RecursionError 的风险？

Answer 1

对于低于 3.5 的 Python 版本：

import asyncio

@asyncio.coroutine
def periodic():
    while True:
        print('periodic')
        yield from asyncio.sleep(1)

def stop():
    task.cancel()

loop = asyncio.get_event_loop()
loop.call_later(5, stop)
task = loop.create_task(periodic())

try:
    loop.run_until_complete(task)
except asyncio.CancelledError:
    pass

对于 Python 3.5 及更高版本：

import asyncio

async def periodic():
    while True:
        print('periodic')
        await asyncio.sleep(1)

def stop():
    task.cancel()

loop = asyncio.get_event_loop()
loop.call_later(5, stop)
task = loop.create_task(periodic())

try:
    loop.run_until_complete(task)
except asyncio.CancelledError:
    pass

Answer 2

当你觉得应该在你的 asyncio 程序的“后台”发生一些事情时，asyncio.Task 可能是一个好方法。您可以阅读this post 了解如何处理任务。

以下是定期执行某些功能的类的可能实现：

import asyncio
from contextlib import suppress


class Periodic:
    def __init__(self, func, time):
        self.func = func
        self.time = time
        self.is_started = False
        self._task = None

    async def start(self):
        if not self.is_started:
            self.is_started = True
            # Start task to call func periodically:
            self._task = asyncio.ensure_future(self._run())

    async def stop(self):
        if self.is_started:
            self.is_started = False
            # Stop task and await it stopped:
            self._task.cancel()
            with suppress(asyncio.CancelledError):
                await self._task

    async def _run(self):
        while True:
            await asyncio.sleep(self.time)
            self.func()

让我们测试一下：

async def main():
    p = Periodic(lambda: print('test'), 1)
    try:
        print('Start')
        await p.start()
        await asyncio.sleep(3.1)

        print('Stop')
        await p.stop()
        await asyncio.sleep(3.1)

        print('Start')
        await p.start()
        await asyncio.sleep(3.1)
    finally:
        await p.stop()  # we should stop task finally


if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

输出：

Start
test
test
test

Stop

Start
test
test
test

[Finished in 9.5s]

正如您在start 上看到的，我们只是启动调用一些函数并在无限循环中休眠一段时间的任务。在stop 上，我们只是取消该任务。请注意，该任务应在程序完成时停止。

更重要的一点是，您的回调不应该花费太多时间来执行（否则它会冻结您的事件循环）。如果您打算调用一些长期运行的func，您可能需要to run it in executor。

Answer 3

没有对定期调用的内置支持，没有。

只需创建您自己的调度程序循环，它会休眠并执行任何已调度的任务：

import math, time

async def scheduler():
    while True:
        # sleep until the next whole second
        now = time.time()
        await asyncio.sleep(math.ceil(now) - now)
       
        # execute any scheduled tasks
        async for task in scheduled_tasks(time.time()):
            await task()

scheduled_tasks() 迭代器应该生成可以在给定时间运行的任务。请注意，从理论上讲，生成时间表和启动所有任务可能需要超过 1 秒的时间；这里的想法是调度程序产生自上次检查以来应该开始的所有任务。

Answer 4

一个可能有用的变体：如果您希望在上次执行结束和下一次执行开始之间每隔 n 秒而不是 n 秒发生一次重复调用，并且您不希望调用在时间上重叠，下面的比较简单：

async def repeat(interval, func, *args, **kwargs):
    """Run func every interval seconds.

    If func has not finished before *interval*, will run again
    immediately when the previous iteration finished.

    *args and **kwargs are passed as the arguments to func.
    """
    while True:
        await asyncio.gather(
            func(*args, **kwargs),
            asyncio.sleep(interval),
        )

以及使用它在后台运行几个任务的示例：

async def f():
    await asyncio.sleep(1)
    print('Hello')


async def g():
    await asyncio.sleep(0.5)
    print('Goodbye')


async def main():
    t1 = asyncio.ensure_future(repeat(3, f))
    t2 = asyncio.ensure_future(repeat(2, g))
    await t1
    await t2

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Answer 5

python 3.7 带有装饰器的替代版本

import asyncio
import time


def periodic(period):
    def scheduler(fcn):

        async def wrapper(*args, **kwargs):

            while True:
                asyncio.create_task(fcn(*args, **kwargs))
                await asyncio.sleep(period)

        return wrapper

    return scheduler


@periodic(2)
async def do_something(*args, **kwargs):
    await asyncio.sleep(5)  # Do some heavy calculation
    print(time.time())


if __name__ == '__main__':
    asyncio.run(do_something('Maluzinha do papai!', secret=42))

Answer 6

基于@A. Jesse Jiryu Davis answer（使用@Torkel Bjørnson-Langen 和@ReWrite cmets），这是一项避免漂移的改进。

import time
import asyncio

@asyncio.coroutine
def periodic(period):
    def g_tick():
        t = time.time()
        count = 0
        while True:
            count += 1
            yield max(t + count * period - time.time(), 0)
    g = g_tick()

    while True:
        print('periodic', time.time())
        yield from asyncio.sleep(next(g))

loop = asyncio.get_event_loop()
task = loop.create_task(periodic(1))
loop.call_later(5, task.cancel)

try:
    loop.run_until_complete(task)
except asyncio.CancelledError:
    pass

Answer 7

此解决方案使用来自Fernando José Esteves de Souza 的装饰概念、来自Wojciech Migda 的漂移解决方法和一个超类，以便生成尽可能优雅的代码来处理异步周期性函数。

无threading.Thread

解决方案由以下文件组成：

• periodic_async_thread.py 带有基类供您子类化
• a_periodic_thread.py 带有示例子类
• run_me.py 带有示例实例化并运行

文件periodic_async_thread.py中的PeriodicAsyncThread类：

import time
import asyncio
import abc

class PeriodicAsyncThread:
    def __init__(self, period):
        self.period = period

    def periodic(self):
        def scheduler(fcn):
            async def wrapper(*args, **kwargs):
                def g_tick():
                    t = time.time()
                    count = 0
                    while True:
                        count += 1
                        yield max(t + count * self.period - time.time(), 0)
                g = g_tick()

                while True:
                    # print('periodic', time.time())
                    asyncio.create_task(fcn(*args, **kwargs))
                    await asyncio.sleep(next(g))
            return wrapper
        return scheduler

    @abc.abstractmethod
    async def run(self, *args, **kwargs):
        return

    def start(self):
        asyncio.run(self.run())

文件a_periodic_thread.py中的简单子类APeriodicThread的示例：

from periodic_async_thread import PeriodicAsyncThread
import time
import asyncio

class APeriodicThread(PeriodicAsyncThread):
    def __init__(self, period):
        super().__init__(period)
        self.run = self.periodic()(self.run)
    
    async def run(self, *args, **kwargs):
        await asyncio.sleep(2)
        print(time.time())

实例化并运行文件run_me.py中的示例类：

from a_periodic_thread import APeriodicThread
apt = APeriodicThread(2)
apt.start()

这段代码代表了一个优雅的解决方案，它还可以缓解其他解决方案的时间漂移​​问题。输出类似于：

1642711285.3898764
1642711287.390698
1642711289.3924973
1642711291.3920736

带threading.Thread

解决方案由以下文件组成：

• async_thread.py 与 canopy 异步线程类。
• periodic_async_thread.py 带有基类供您子类化
• a_periodic_thread.py 带有示例子类
• run_me.py 带有示例实例化并运行

文件async_thread.py中的AsyncThread类：

from threading import Thread
import asyncio
import abc

class AsyncThread(Thread):
    def __init__(self, *args, **kwargs) -> None:
        super().__init__(*args, **kwargs)

    @abc.abstractmethod
    async def async_run(self, *args, **kwargs):
        pass

    def run(self, *args, **kwargs):
        # loop = asyncio.new_event_loop()
        # asyncio.set_event_loop(loop)

        # loop.run_until_complete(self.async_run(*args, **kwargs))
        # loop.close()
        asyncio.run(self.async_run(*args, **kwargs))

文件periodic_async_thread.py中的PeriodicAsyncThread类：

import time
import asyncio
from .async_thread import AsyncThread

class PeriodicAsyncThread(AsyncThread):
    def __init__(self, period, *args, **kwargs):
        self.period = period
        super().__init__(*args, **kwargs)
        self.async_run = self.periodic()(self.async_run)

    def periodic(self):
        def scheduler(fcn):
            async def wrapper(*args, **kwargs):
                def g_tick():
                    t = time.time()
                    count = 0
                    while True:
                        count += 1
                        yield max(t + count * self.period - time.time(), 0)
                g = g_tick()

                while True:
                    # print('periodic', time.time())
                    asyncio.create_task(fcn(*args, **kwargs))
                    await asyncio.sleep(next(g))
            return wrapper
        return scheduler

文件a_periodic_thread.py中的简单子类APeriodicThread的示例：

import time
from threading import current_thread
from .periodic_async_thread import PeriodicAsyncThread
import asyncio

class APeriodicAsyncTHread(PeriodicAsyncThread):
    async def async_run(self, *args, **kwargs):
        print(f"{current_thread().name} {time.time()} Hi!")
        await asyncio.sleep(1)
        print(f"{current_thread().name} {time.time()} Bye!")

实例化并运行文件run_me.py中的示例类：

from .a_periodic_thread import APeriodicAsyncTHread
a = APeriodicAsyncTHread(2, name = "a periodic async thread")
a.start()
a.join()

这段代码代表了一个优雅的解决方案，它还可以缓解其他解决方案的时间漂移​​问题。输出类似于：

a periodic async thread 1643726990.505269 Hi!
a periodic async thread 1643726991.5069854 Bye!
a periodic async thread 1643726992.506919 Hi!
a periodic async thread 1643726993.5089169 Bye!
a periodic async thread 1643726994.5076022 Hi!
a periodic async thread 1643726995.509422 Bye!
a periodic async thread 1643726996.5075526 Hi!
a periodic async thread 1643726997.5093904 Bye!
a periodic async thread 1643726998.5072556 Hi!
a periodic async thread 1643726999.5091035 Bye!

Answer 8

这就是我使用 asyncio 测试我的周期性回调理论所做的。我没有使用 Tornado 的经验，所以我不确定定期回调是如何使用它的。不过，我习惯于在 Tkinter 中使用 after(ms, callback) 方法，这就是我想出的。 While True: 即使它是异步的（比全局变量更是如此），我也觉得它很难看。 call_later(s, callback, *args) 方法使用秒而不是毫秒。

import asyncio
my_var = 0
def update_forever(the_loop):
    global my_var
    print(my_var)
    my_var += 1 
    # exit logic could be placed here
    the_loop.call_later(3, update_forever, the_loop)  # the method adds a delayed callback on completion

event_loop = asyncio.get_event_loop()
event_loop.call_soon(update_forever, event_loop)
event_loop.run_forever()