Lines Matching +full:async +full:- +full:io
5 High-level API Index
8 This page lists all high-level async/await enabled asyncio APIs.
17 .. list-table::
19 :class: full-width-table
21 * - :func:`run`
22 - Create event loop, run a coroutine, close the loop.
24 * - :class:`Runner`
25 - A context manager that simplifies multiple async function calls.
27 * - :class:`Task`
28 - Task object.
30 * - :class:`TaskGroup`
31 - A context manager that holds a group of tasks. Provides
35 * - :func:`create_task`
36 - Start an asyncio Task, then returns it.
38 * - :func:`current_task`
39 - Return the current Task.
41 * - :func:`all_tasks`
42 - Return all tasks that are not yet finished for an event loop.
44 * - ``await`` :func:`sleep`
45 - Sleep for a number of seconds.
47 * - ``await`` :func:`gather`
48 - Schedule and wait for things concurrently.
50 * - ``await`` :func:`wait_for`
51 - Run with a timeout.
53 * - ``await`` :func:`shield`
54 - Shield from cancellation.
56 * - ``await`` :func:`wait`
57 - Monitor for completion.
59 * - :func:`timeout`
60 - Run with a timeout. Useful in cases when ``wait_for`` is not suitable.
62 * - :func:`to_thread`
63 - Asynchronously run a function in a separate OS thread.
65 * - :func:`run_coroutine_threadsafe`
66 - Schedule a coroutine from another OS thread.
68 * - ``for in`` :func:`as_completed`
69 - Monitor for completion with a ``for`` loop.
94 .. list-table::
96 :class: full-width-table
98 * - :class:`Queue`
99 - A FIFO queue.
101 * - :class:`PriorityQueue`
102 - A priority queue.
104 * - :class:`LifoQueue`
105 - A LIFO queue.
113 * See also the :ref:`Queues documentation page <asyncio-queues>`.
121 .. list-table::
123 :class: full-width-table
125 * - ``await`` :func:`create_subprocess_exec`
126 - Create a subprocess.
128 * - ``await`` :func:`create_subprocess_shell`
129 - Run a shell command.
136 * See also the :ref:`subprocess APIs <asyncio-subprocess>`
143 High-level APIs to work with network IO.
145 .. list-table::
147 :class: full-width-table
149 * - ``await`` :func:`open_connection`
150 - Establish a TCP connection.
152 * - ``await`` :func:`open_unix_connection`
153 - Establish a Unix socket connection.
155 * - ``await`` :func:`start_server`
156 - Start a TCP server.
158 * - ``await`` :func:`start_unix_server`
159 - Start a Unix socket server.
161 * - :class:`StreamReader`
162 - High-level async/await object to receive network data.
164 * - :class:`StreamWriter`
165 - High-level async/await object to send network data.
172 * See also the :ref:`streams APIs <asyncio-streams>`
179 Threading-like synchronization primitives that can be used in Tasks.
181 .. list-table::
183 :class: full-width-table
185 * - :class:`Lock`
186 - A mutex lock.
188 * - :class:`Event`
189 - An event object.
191 * - :class:`Condition`
192 - A condition object.
194 * - :class:`Semaphore`
195 - A semaphore.
197 * - :class:`BoundedSemaphore`
198 - A bounded semaphore.
200 * - :class:`Barrier`
201 - A barrier object.
211 :ref:`synchronization primitives <asyncio-sync>`.
217 .. list-table::
219 :class: full-width-table
222 * - :exc:`asyncio.CancelledError`
223 - Raised when a Task is cancelled. See also :meth:`Task.cancel`.
225 * - :exc:`asyncio.BrokenBarrierError`
226 - Raised when a Barrier is broken. See also :meth:`Barrier.wait`.
235 :ref:`asyncio-specific exceptions <asyncio-exceptions>`.