diff options
author | Yury Selivanov <yury@magic.io> | 2018-09-14 21:57:39 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-09-14 21:57:39 (GMT) |
commit | 6c7316439d966cdbc76ffcc005e5d9c563064ba2 (patch) | |
tree | 710a5d5b6ed1de38a6c18b7643efe3666e1e83d1 /Doc | |
parent | 5acccfaf680ae737bcd8b09f3a85719e3e904ef2 (diff) | |
download | cpython-6c7316439d966cdbc76ffcc005e5d9c563064ba2.zip cpython-6c7316439d966cdbc76ffcc005e5d9c563064ba2.tar.gz cpython-6c7316439d966cdbc76ffcc005e5d9c563064ba2.tar.bz2 |
bpo-33649: Refresh asyncio docs landing page (GH-9322)
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/asyncio-future.rst | 2 | ||||
-rw-r--r-- | Doc/library/asyncio-queue.rst | 1 | ||||
-rw-r--r-- | Doc/library/asyncio.rst | 59 |
3 files changed, 34 insertions, 28 deletions
diff --git a/Doc/library/asyncio-future.rst b/Doc/library/asyncio-future.rst index 2c41c1c..ff04339 100644 --- a/Doc/library/asyncio-future.rst +++ b/Doc/library/asyncio-future.rst @@ -1,6 +1,8 @@ .. currentmodule:: asyncio +.. _asyncio-futures: + ======= Futures ======= diff --git a/Doc/library/asyncio-queue.rst b/Doc/library/asyncio-queue.rst index a910dc7..fcad751 100644 --- a/Doc/library/asyncio-queue.rst +++ b/Doc/library/asyncio-queue.rst @@ -1,5 +1,6 @@ .. currentmodule:: asyncio +.. _asyncio-queues: ====== Queues diff --git a/Doc/library/asyncio.rst b/Doc/library/asyncio.rst index 2c8ccbb..c1b0408 100644 --- a/Doc/library/asyncio.rst +++ b/Doc/library/asyncio.rst @@ -6,43 +6,46 @@ -------------- -.. TODO: rewrite the introduction section +asyncio is a library to write **concurrent** code using +**async/await** syntax. -This module provides infrastructure for writing single-threaded concurrent -code using coroutines, multiplexing I/O access over sockets and other -resources, running network clients and servers, and other related primitives. -Here is a more detailed list of the package contents: +asyncio is used as a foundation for multiple Python asynchronous +frameworks that provide high-performance network and web-servers, +database connection libraries, distributed task queues, etc. -* a pluggable :ref:`event loop <asyncio-event-loop>` with various system-specific - implementations; +asyncio is often a perfect fit for IO-bound and high-level +**structured** network code. -* :ref:`transport <asyncio-transport>` and :ref:`protocol <asyncio-protocol>` abstractions - (similar to those in `Twisted <https://twistedmatrix.com/trac/>`_); +asyncio provides a set of **high-level** APIs to: -* concrete support for TCP, UDP, SSL, subprocess pipes, delayed calls, and - others (some may be system-dependent); +* :ref:`run Python coroutines <coroutine>` concurrently and + have full control over their execution; -* a :class:`Future` class that mimics the one in the :mod:`concurrent.futures` - module, but adapted for use with the event loop; +* perform :ref:`network IO and IPC <asyncio-streams>`; -* coroutines and tasks based on ``yield from`` (:PEP:`380`), to help write - concurrent code in a sequential fashion; +* control :ref:`subprocesses <asyncio-subprocess>`; -* cancellation support for :class:`Future`\s and coroutines; +* distribute tasks via :ref:`queues <asyncio-queues>`; -* :ref:`synchronization primitives <asyncio-sync>` for use between coroutines in - a single thread, mimicking those in the :mod:`threading` module; +* :ref:`synchronize <asyncio-sync>` concurrent code; -* an interface for passing work off to a threadpool, for times when - you absolutely, positively have to use a library that makes blocking - I/O calls. +as well as **low-level** APIs for *library and framework developers* to: -Asynchronous programming is more complex than classical "sequential" -programming: see the :ref:`Develop with asyncio <asyncio-dev>` page which lists -common traps and explains how to avoid them. :ref:`Enable the debug mode -<asyncio-debug-mode>` during development to detect common issues. +* create and manage :ref:`event loops <asyncio-event-loop>`, which + provide asynchronous APIs for networking, subprocesses, OS signals, + etc; -High-level APIs: +* implement efficient protocols using + :ref:`transports <asyncio-transports-protocols>`; + +* :ref:`bridge <asyncio-futures>` callback-based libraries and code + with async/await syntax. + + +Contents +-------- + +.. rubric:: High-level APIs .. toctree:: :maxdepth: 1 @@ -54,7 +57,7 @@ High-level APIs: asyncio-queue.rst asyncio-exceptions.rst -Low-level APIs: +.. rubric:: Low-level APIs .. toctree:: :maxdepth: 1 @@ -65,7 +68,7 @@ Low-level APIs: asyncio-policy.rst asyncio-platforms.rst -Guides and Tutorials: +.. rubric:: Guides and Tutorials .. toctree:: :maxdepth: 1 |