Python 异步: 使用和查询任务(8)

简介: 任务是异步程序的货币。在本节中,我们将仔细研究如何在我们的程序中与它们交互。

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()
相关文章
|
4天前
|
数据采集 Java Python
python并发编程:Python异步IO实现并发爬虫
python并发编程:Python异步IO实现并发爬虫
24 1
|
4天前
|
算法 数据处理 Python
Python并发编程:解密异步IO与多线程
本文将深入探讨Python中的并发编程技术,重点介绍异步IO和多线程两种常见的并发模型。通过对比它们的特点、适用场景和实现方式,帮助读者更好地理解并发编程的核心概念,并掌握在不同场景下选择合适的并发模型的方法。
|
4天前
|
调度 数据库 Python
【专栏】异步IO在处理IO密集型任务中的高效性
【4月更文挑战第27天】本文介绍了Python并发编程和异步IO,包括并发的基本概念(多线程、多进程、协程),线程与进程的实现(threading和multiprocessing模块),协程的使用(asyncio模块),以及异步IO的原理和优势。强调了异步IO在处理IO密集型任务中的高效性,指出应根据任务类型选择合适的并发技术。
|
1天前
|
Python
【Python3 查询手册学习】,完整版PDF开放下载_python速查手册·模块卷(全彩版) pdf(1)
【Python3 查询手册学习】,完整版PDF开放下载_python速查手册·模块卷(全彩版) pdf(1)
|
2天前
|
Java 测试技术 Python
Python的多线程允许在同一进程中并发执行任务
【5月更文挑战第17天】Python的多线程允许在同一进程中并发执行任务。示例1展示了创建5个线程打印"Hello World",每个线程调用同一函数并使用`join()`等待所有线程完成。示例2使用`ThreadPoolExecutor`下载网页,创建线程池处理多个URL,打印出每个网页的大小。Python多线程还可用于线程间通信和同步,如使用Queue和Lock。
16 1
|
4天前
|
SQL 数据采集 数据挖掘
构建高效的Python数据处理流水线:使用Pandas和NumPy优化数据分析任务
在数据科学和分析领域,Python一直是最受欢迎的编程语言之一。本文将介绍如何通过使用Pandas和NumPy库构建高效的数据处理流水线,从而加速数据分析任务的执行。我们将讨论如何优化数据加载、清洗、转换和分析的过程,以及如何利用这些库中的强大功能来提高代码的性能和可维护性。
|
4天前
|
JSON 数据格式 索引
python之JMESPath:JSON 查询语法库示例详解
python之JMESPath:JSON 查询语法库示例详解
16 0
|
4天前
|
API UED Python
使用Python进行异步HTTP请求的实践指南
使用Python进行异步HTTP请求的实践指南
20 4
|
4天前
|
开发者 Python
在Python中查询进程信息的实用指南
在Python中查询进程信息的实用指南
10 2
|
4天前
|
并行计算 数据处理 开发者
Python并发编程:解析异步IO与多线程
本文探讨了Python中的并发编程技术,着重比较了异步IO和多线程两种常见的并发模型。通过详细分析它们的特点、优劣势以及适用场景,帮助读者更好地理解并选择适合自己项目需求的并发编程方式。