乐趣区

关于程序员:Python-异步-使用和查询任务8

jiezi

工作是异步程序的货币。在本节中，咱们将认真钻研如何在咱们的程序中与它们交互。

1. 工作生命周期

异步工作具备生命周期。首先，工作是从协程创立的。而后安顿在事件循环中独立执行。在某个时候，它会运行。

在运行时它可能会被挂起，例如期待另一个协程或工作。它可能失常实现并返回后果或因异样而失败。

另一个协程可能会染指并勾销工作。最终，它将实现并且无奈再次执行。

咱们能够将这个生命周期总结如下：

  1. 创立

  2. 预约

    1. 勾销

  3. 运行

    1. 暂停
    2. 后果
    3. Exception
    4. 勾销
  4. 实现

请留神，Suspended、Result、Exception 和 Canceled 自身并不是状态，它们是正在运行的工作的重要转换点。

下图总结了此生命周期，显示了每个阶段之间的转换。

当初咱们曾经从高层次上相熟了工作的生命周期，让咱们认真看看每个阶段。

2. 如何查看工作状态

创立工作后，咱们能够查看工作的状态。咱们可能要查看两种状态，它们是：

  • 工作是否实现
  • 工作是否勾销

让咱们顺次认真看看每一个。

2.1. 查看工作是否实现

咱们能够通过 done() 办法查看工作是否实现。如果工作实现，该办法返回 True，否则返回 False。

# check if a task is done
if task.done():
    # ...

如果工作有机会运行但当初不再运行，则该工作已实现。已安顿的工作未实现。同样，正在运行的工作未实现。

如果呈现以下状况，则实现工作：

  1. 协程失常完结。
  2. 协程显式返回。
  3. 协程中出现意外谬误或异样
  4. 工作被勾销。

2.2. 查看工作是否勾销

咱们能够通过 cancelled() 办法查看工作是否被勾销。如果工作被勾销，该办法返回 True，否则返回 False。

...
# check if a task was canceled
if task.cancelled():
    # ...

如果在工作上调用 cancel() 办法并胜利实现，则工作被勾销，例如 cancel() 返回 True。

如果未调用 cancel() 办法，或者调用了 cancel() 办法但未能勾销工作，则不会勾销工作。

3. 如何获取工作后果

咱们能够通过 result() 办法获取工作的后果。这将返回由 Task 包装的协程的返回值，如果包装的协程没有显式返回值，则返回 None。

...
# get the return value from the wrapped coroutine
value = task.result()

如果协程引发未解决的谬误或异样，则在调用 result() 办法时会从新引发，并且可能须要解决。

...
try:
    # get the return value from the wrapped coroutine
    value = task.result()
except Exception:
    # task failed and there is no result

如果工作被勾销，则在调用 result() 办法时会引发 CancelledError 异样，可能须要进行解决。

...
try:
    # get the return value from the wrapped coroutine
    value = task.result()
except asyncio.CancelledError:
    # task was canceled

因而，最好先查看工作是否已勾销。

...
# check if the task was not canceled
if not task.cancelled():
    # get the return value from the wrapped coroutine
    value = task.result()
else:
    # task was canceled

如果工作尚未实现，则在调用 result() 办法时会引发 InvalidStateError 异样，可能须要进行解决。

...
try:
    # get the return value from the wrapped coroutine
    value = task.result()
except asyncio.InvalidStateError:
    # task is not yet done

因而，最好先查看工作是否已实现。

...
# check if the task is not done
if not task.done():
    await task
# get the return value from the wrapped coroutine
value = task.result()

4. 如何获取工作异样

工作包装的协程可能会引发未解决的异样。这实际上会勾销工作。

咱们能够通过 exception() 办法在工作包装的协程中检索未解决的异样。

...
# get the exception raised by a task
exception = task.exception()

如果包装协程中未引发未解决的异样，则返回 None 值。

如果工作被勾销，则在调用 exception() 办法时会引发 CancelledError 异样，可能须要对其进行解决。

...
try:
    # get the exception raised by a task
    exception = task.exception()
except asyncio.CancelledError:
    # task was canceled

因而，最好先查看工作是否已勾销。

...
# check if the task was not canceled
if not task.cancelled():
    # get the exception raised by a task
    exception = task.exception()
else:
    # task was canceled

如果工作尚未实现，则在调用 exception() 办法时会引发 InvalidStateError 异样，可能须要进行解决。

...
try:
    # get the exception raised by a task
    exception = task.exception()
except asyncio.InvalidStateError:
    # task is not yet done

因而，最好先查看工作是否已实现。

...
# check if the task is not done
if not task.done():
    await task
# get the exception raised by a task
exception = task.exception()

5. 如何勾销工作

咱们能够通过 cancel() 办法勾销打算工作。如果工作被勾销，则 cancel 办法返回 True，否则返回 False。

...
# cancel the task
was_cancelled = task.cancel()

如果工作曾经实现，则无奈勾销，cancel() 办法将返回 False，工作不会处于已勾销状态。

下次工作有机会运行时，它将引发 CancelledError 异样。如果 CancelledError 异样未在包装协程内解决，工作将被勾销。否则，如果在包装协程内解决了 CancelledError 异样，工作将不会被勾销。

cancel() 办法还能够承受一个音讯参数，该参数将在 CancelledError 的内容中应用。

6. 如何在工作中应用回调

咱们能够通过 add_done_callback() 办法向工作增加实现回调函数。此办法采纳工作实现时要调用的函数的名称。回调函数必须将 Task 实例作为参数。

# done callback function
def handle(task):
    print(task)
 
...
# register a done callback function
task.add_done_callback(handle)

回忆一下，当包装的协程返回时失常实现、引发未解决的异样或勾销工作时，工作可能会实现。add_done_callback() 办法可用于增加或注册任意数量的 done 回调函数。

咱们还能够通过 remove_done_callback() 函数删除或登记回调函数。

...
# remove a done callback function
task.remove_done_callback(handle)

7. 如何设置工作名称

一个工作可能有一个名字。如果多个工作是从同一个协程创立的，那么这个名称会很有用，咱们须要一些办法以编程形式辨别它们。当通过“名称”参数从协程创立工作时，能够设置名称。

...
# create a task from a coroutine
task = asyncio.create_task(task_coroutine(), name='MyTask')

工作的名称也能够通过 set_name() 办法设置。

...
# set the name of the task
task.set_name('MyTask')

咱们能够通过 get_name() 办法检索工作的名称。

...
# get the name of a task
name = task.get_name()

本文由 mdnice 多平台公布

退出移动版