Doc/library/asyncio-api-index.rst · source-code-analysis/python3.8.1

代码拉取完成,页面将自动刷新

扫描微信二维码支付

取消

支付完成

richgiteeai

Watch

不关注关注所有动态仅关注版本发行动态关注但不提醒动态

1 Star 0 Fork 0

source-code-analysis/python3.8.1

代码 Issues 0 Pull Requests 0 Wiki 统计流水线

服务

加入 Gitee

与超过 1400万开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)

免费加入

已有帐号? 立即登录

文件

master

分支 (1)

管理

master

克隆/下载

HTTPS SSH SVN SVN+SSH 下载ZIP

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置

git config --global user.name userName 
git config --global user.email userEmail

初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置

1 生成 RSA 密钥

2 获取 RSA 公钥内容,并配置到 SSH公钥中

在 Gitee 上使用 SVN,请访问使用指南

使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # 私人令牌

分支 1

标签 0

python3.8.1

Doc

library

asyncio-api-index.rst

asyncio-api-index.rst 4.52 KB

.. currentmodule:: asyncio

====================
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.

.. list-table::
 :widths: 50 50
 :class: full-width-table

* - :func:`run`
 - Create event loop, run a coroutine, close the loop.

* - :func:`create_task`
 - Start an asyncio Task.

* - ``await`` :func:`sleep`
 - Sleep for a number of seconds.

* - ``await`` :func:`gather`
 - Schedule and wait for things concurrently.

* - ``await`` :func:`wait_for`
 - Run with a timeout.

* - ``await`` :func:`shield`
 - Shield from cancellation.

* - ``await`` :func:`wait`
 - Monitor for completion.

* - :func:`current_task`
 - Return the current Task.

* - :func:`all_tasks`
 - Return all tasks for an event loop.

* - :class:`Task`
 - Task object.

* - :func:`run_coroutine_threadsafe`
 - Schedule a coroutine from another OS thread.

* - ``for in`` :func:`as_completed`
 - Monitor for completion with a ``for`` loop.

.. rubric:: Examples

* :ref:`Using asyncio.gather() to run things in parallel
 <asyncio_example_gather>`.

* :ref:`Using asyncio.wait_for() to enforce a timeout
 <asyncio_example_waitfor>`.

* :ref:`Cancellation <asyncio_example_task_cancel>`.

* :ref:`Using asyncio.sleep() <asyncio_example_sleep>`.

* See also the main :ref:`Tasks documentation page <coroutine>`.

Queues
======

Queues should be used to distribute work amongst multiple asyncio Tasks,
implement connection pools, and pub/sub patterns.

.. list-table::
 :widths: 50 50
 :class: full-width-table

* - :class:`Queue`
 - A FIFO queue.

* - :class:`PriorityQueue`
 - A priority queue.

* - :class:`LifoQueue`
 - A LIFO queue.

.. rubric:: Examples

* :ref:`Using asyncio.Queue to distribute workload between several
 Tasks <asyncio_example_queue_dist>`.

* See also the :ref:`Queues documentation page <asyncio-queues>`.

Subprocesses
============

Utilities to spawn subprocesses and run shell commands.

.. list-table::
 :widths: 50 50
 :class: full-width-table

* - ``await`` :func:`create_subprocess_exec`
 - Create a subprocess.

* - ``await`` :func:`create_subprocess_shell`
 - Run a shell command.

.. rubric:: Examples

* :ref:`Executing a shell command <asyncio_example_subprocess_shell>`.

* See also the :ref:`subprocess APIs <asyncio-subprocess>`
 documentation.

Streams
=======

High-level APIs to work with network IO.

.. list-table::
 :widths: 50 50
 :class: full-width-table

* - ``await`` :func:`open_connection`
 - Establish a TCP connection.

* - ``await`` :func:`open_unix_connection`
 - Establish a Unix socket connection.

* - ``await`` :func:`start_server`
 - Start a TCP server.

* - ``await`` :func:`start_unix_server`
 - Start a Unix socket server.

* - :class:`StreamReader`
 - High-level async/await object to receive network data.

* - :class:`StreamWriter`
 - High-level async/await object to send network data.

.. rubric:: Examples

* :ref:`Example TCP client <asyncio_example_stream>`.

* See also the :ref:`streams APIs <asyncio-streams>`
 documentation.

Synchronization
===============

Threading-like synchronization primitives that can be used in Tasks.

.. list-table::
 :widths: 50 50
 :class: full-width-table

* - :class:`Lock`
 - A mutex lock.

* - :class:`Event`
 - An event object.

* - :class:`Condition`
 - A condition object.

* - :class:`Semaphore`
 - A semaphore.

* - :class:`BoundedSemaphore`
 - A bounded semaphore.

.. rubric:: Examples

* :ref:`Using asyncio.Event <asyncio_example_sync_event>`.

* See also the documentation of asyncio
 :ref:`synchronization primitives <asyncio-sync>`.

Exceptions
==========

.. list-table::
 :widths: 50 50
 :class: full-width-table

* - :exc:`asyncio.TimeoutError`
 - Raised on timeout by functions like :func:`wait_for`.
 Keep in mind that ``asyncio.TimeoutError`` is **unrelated**
 to the built-in :exc:`TimeoutError` exception.

* - :exc:`asyncio.CancelledError`
 - Raised when a Task is cancelled. See also :meth:`Task.cancel`.

.. rubric:: Examples

* :ref:`Handling CancelledError to run code on cancellation request
 <asyncio_example_task_cancel>`.

* See also the full list of
 :ref:`asyncio-specific exceptions <asyncio-exceptions>`.

一键复制编辑原始数据按行查看历史

zhangweibo 提交于 2021年11月16日 09:46 +08:00 . git init

.. currentmodule:: asyncio

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.

:func:`run` Create event loop, run a coroutine, close the loop.

:func:`create_task` Start an asyncio Task.

await :func:`sleep` Sleep for a number of seconds.

await :func:`gather` Schedule and wait for things concurrently.

await :func:`wait_for` Run with a timeout.

await :func:`shield` Shield from cancellation.

await :func:`wait` Monitor for completion.

:func:`current_task` Return the current Task.

:func:`all_tasks` Return all tasks for an event loop.

:class:`Task` Task object.

:func:`run_coroutine_threadsafe` Schedule a coroutine from another OS thread.

for in :func:`as_completed` Monitor for completion with a for loop.

Examples

:ref:`Using asyncio.gather() to run things in parallel <asyncio_example_gather>`.
:ref:`Using asyncio.wait_for() to enforce a timeout <asyncio_example_waitfor>`.
:ref:`Cancellation <asyncio_example_task_cancel>`.
:ref:`Using asyncio.sleep() <asyncio_example_sleep>`.
See also the main :ref:`Tasks documentation page <coroutine>`.

Queues

Queues should be used to distribute work amongst multiple asyncio Tasks, implement connection pools, and pub/sub patterns.

:class:`Queue` A FIFO queue.

:class:`PriorityQueue` A priority queue.

:class:`LifoQueue` A LIFO queue.

Examples

:ref:`Using asyncio.Queue to distribute workload between several Tasks <asyncio_example_queue_dist>`.
See also the :ref:`Queues documentation page <asyncio-queues>`.

Subprocesses

Utilities to spawn subprocesses and run shell commands.

await :func:`create_subprocess_exec` Create a subprocess.

await :func:`create_subprocess_shell` Run a shell command.

Examples

:ref:`Executing a shell command <asyncio_example_subprocess_shell>`.
See also the :ref:`subprocess APIs <asyncio-subprocess>` documentation.

Streams

High-level APIs to work with network IO.

await :func:`open_connection` Establish a TCP connection.

await :func:`open_unix_connection` Establish a Unix socket connection.

await :func:`start_server` Start a TCP server.

await :func:`start_unix_server` Start a Unix socket server.

:class:`StreamReader` High-level async/await object to receive network data.

:class:`StreamWriter` High-level async/await object to send network data.

Examples

:ref:`Example TCP client <asyncio_example_stream>`.
See also the :ref:`streams APIs <asyncio-streams>` documentation.

Synchronization

Threading-like synchronization primitives that can be used in Tasks.

:class:`Lock` A mutex lock.

:class:`Event` An event object.

:class:`Condition` A condition object.

:class:`Semaphore` A semaphore.

:class:`BoundedSemaphore` A bounded semaphore.

Examples

:ref:`Using asyncio.Event <asyncio_example_sync_event>`.
See also the documentation of asyncio :ref:`synchronization primitives <asyncio-sync>`.

Exceptions

:exc:`asyncio.TimeoutError` Raised on timeout by functions like :func:`wait_for`. Keep in mind that asyncio.TimeoutError is unrelated to the built-in :exc:`TimeoutError` exception.

:exc:`asyncio.CancelledError` Raised when a Task is cancelled. See also :meth:`Task.cancel`.

Examples