High-level API Index
Python 3.14 Docs · نسخهٔ 3.14.10 · PSF License
====================
High-level API Index
This page lists all high-level async/await enabled asyncio APIs.
Tasks
Utilities to run asyncio programs, create Tasks, and await on multiple things with timeouts.
:widths: 50 50 :class: full-width-table
- -
run - Create event loop, run a coroutine, close the loop.
- -
Runner - A context manager that simplifies multiple async function calls.
- -
Task - Task object.
- -
TaskGroup - A context manager that holds a group of tasks. Provides
a convenient and reliable way to wait for all tasks in the group to finish.
- -
create_task - Start an asyncio Task, then returns it.
- -
current_task - Return the current Task.
- -
all_tasks - Return all tasks that are not yet finished for an event loop.
- - `
awaitsleep` - Sleep for a number of seconds.
- - `
awaitgather` - Schedule and wait for things concurrently.
- - `
awaitwait_for` - Run with a timeout.
- - `
awaitshield` - Shield from cancellation.
- - `
awaitwait` - Monitor for completion.
- -
timeout - Run with a timeout. Useful in cases when `
wait_for` is not suitable.
- -
to_thread - Asynchronously run a function in a separate OS thread.
- -
run_coroutine_threadsafe - Schedule a coroutine from another OS thread.
- - `
for inas_completed` - Monitor for completion with a `
for` loop.
- :ref:`Using asyncio.gather() to run things in parallel
<asyncio_example_gather>`.
- :ref:`Using asyncio.wait_for() to enforce a timeout
<asyncio_example_waitfor>`.
Cancellation <asyncio_example_task_cancel>.
Using asyncio.sleep() <asyncio_example_sleep>.
- See also the main
Tasks documentation page <coroutine>.
Queues
Queues should be used to distribute work amongst multiple asyncio Tasks, implement connection pools, and pub/sub patterns.
:widths: 50 50 :class: full-width-table
- -
Queue - A FIFO queue.
- -
PriorityQueue - A priority queue.
- -
LifoQueue - A LIFO queue.
- :ref:`Using asyncio.Queue to distribute workload between several
Tasks <asyncio_example_queue_dist>`.
- See also the
Queues documentation page <asyncio-queues>.
Subprocesses
Utilities to spawn subprocesses and run shell commands.
:widths: 50 50 :class: full-width-table
- - `
awaitcreate_subprocess_exec` - Create a subprocess.
- - `
awaitcreate_subprocess_shell` - Run a shell command.
Executing a shell command <asyncio_example_subprocess_shell>.
- See also the
subprocess APIs <asyncio-subprocess>
documentation.
Streams
High-level APIs to work with network IO.
:widths: 50 50 :class: full-width-table
- - `
awaitopen_connection` - Establish a TCP connection.
- - `
awaitopen_unix_connection` - Establish a Unix socket connection.
- - `
awaitstart_server` - Start a TCP server.
- - `
awaitstart_unix_server` - Start a Unix socket server.
- -
StreamReader - High-level async/await object to receive network data.
- -
StreamWriter - High-level async/await object to send network data.
Example TCP client <asyncio_example_stream>.
- See also the
streams APIs <asyncio-streams>
documentation.
Synchronization
Threading-like synchronization primitives that can be used in Tasks.
:widths: 50 50 :class: full-width-table
- -
Lock - A mutex lock.
- -
Event - An event object.
- -
Condition - A condition object.
- -
Semaphore - A semaphore.
- -
BoundedSemaphore - A bounded semaphore.
- -
Barrier - A barrier object.
Using asyncio.Event <asyncio_example_sync_event>.
Using asyncio.Barrier <asyncio_example_barrier>.
- See also the documentation of asyncio
synchronization primitives <asyncio-sync>.
Exceptions
:widths: 50 50 :class: full-width-table
- -
asyncio.CancelledError - Raised when a Task is cancelled. See also
Task.cancel.
- -
asyncio.BrokenBarrierError - Raised when a Barrier is broken. See also
Barrier.wait.
- :ref:`Handling CancelledError to run code on cancellation request
<asyncio_example_task_cancel>`.
- See also the full list of
asyncio-specific exceptions <asyncio-exceptions>.