高级API索引

此页列出所有高级异步/等待启用的异步API。

任务

用于运行异步程序、创建任务和等待多个超时事件的实用程序。

run()	创建事件循环，运行协程，关闭循环。
create_task()	启动异步任务。
await sleep()	睡几秒钟。
await gather()	同时安排和等待事情。
await wait_for()	超时运行。
await shield()	避免取消。
await wait()	监控完成情况。
current_task()	返回当前任务。
all_tasks()	返回事件循环的所有任务。
Task	任务对象。
to_thread()	在单独的操作系统线程中异步运行函数。
run_coroutine_threadsafe()	从另一个OS线程调度协同程序。
for in as_completed()	用一个 for 循环。

实例

• Using asyncio.gather() to run things in parallel .

• Using asyncio.wait_for() to enforce a timeout .

• Cancellation .

• Using asyncio.sleep() .

• 另见主 Tasks documentation page .

队列

队列应用于在多个异步任务之间分配工作、实现连接池和发布/子模式。

Queue	先进先出队列。
PriorityQueue	优先级队列。
LifoQueue	后进先出队列。

实例

• Using asyncio.Queue to distribute workload between several Tasks .

• 也见 Queues documentation page .

子过程

生成子进程并运行shell命令的实用程序。

await create_subprocess_exec()	创建子流程。
await create_subprocess_shell()	运行shell命令。

实例

• Executing a shell command .

• 也见 subprocess APIs 文档。

流

用于网络IO的高级API。

await open_connection()	建立TCP连接。
await open_unix_connection()	建立一个Unix套接字连接。
await start_server()	启动TCP服务器。
await start_unix_server()	启动Unix Socket服务器。
StreamReader	高级异步/等待对象接收网络数据。
StreamWriter	高级异步/等待对象发送网络数据。

实例

• Example TCP client .

• 也见 streams APIs 文档。

同步

可以在任务中使用的类似于线程的同步原语。

Lock	互斥锁。
Event	事件对象。
Condition	条件对象。
Semaphore	信号量
BoundedSemaphore	有界信号量。

实例

• Using asyncio.Event .

• 另请参见Asyncio的文档 synchronization primitives .

例外情况

asyncio.TimeoutError	在超时时由以下函数引发 wait_for() . 记住 asyncio.TimeoutError 是 无关的 内置的 TimeoutError 例外。
asyncio.CancelledError	任务取消时引发。也见 Task.cancel() .

实例

• Handling CancelledError to run code on cancellation request .

• 另请参见 asyncio-specific exceptions .