diff options
author | Kyle Stanley <aeros167@gmail.com> | 2019-10-10 23:18:46 (GMT) |
---|---|---|
committer | Yury Selivanov <yury@magic.io> | 2019-10-10 23:18:46 (GMT) |
commit | f900064ac4b35226caad7502abc8a7e64f1c0e9d (patch) | |
tree | 62365d9742710a07f167c66cb65537f8c1df0dce /Doc | |
parent | 320dd504ddf65efe946e6d1e89053ed2d7ebe1e9 (diff) | |
download | cpython-f900064ac4b35226caad7502abc8a7e64f1c0e9d.zip cpython-f900064ac4b35226caad7502abc8a7e64f1c0e9d.tar.gz cpython-f900064ac4b35226caad7502abc8a7e64f1c0e9d.tar.bz2 |
docs: Add asyncio source code links (GH-16640)
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/asyncio-eventloop.rst | 4 | ||||
-rw-r--r-- | Doc/library/asyncio-exceptions.rst | 3 | ||||
-rw-r--r-- | Doc/library/asyncio-future.rst | 5 | ||||
-rw-r--r-- | Doc/library/asyncio-platforms.rst | 6 | ||||
-rw-r--r-- | Doc/library/asyncio-protocol.rst | 8 | ||||
-rw-r--r-- | Doc/library/asyncio-queue.rst | 4 | ||||
-rw-r--r-- | Doc/library/asyncio-stream.rst | 4 | ||||
-rw-r--r-- | Doc/library/asyncio-subprocess.rst | 5 | ||||
-rw-r--r-- | Doc/library/asyncio-sync.rst | 4 | ||||
-rw-r--r-- | Doc/library/asyncio-task.rst | 10 | ||||
-rw-r--r-- | Doc/library/asyncio.rst | 5 |
11 files changed, 54 insertions, 4 deletions
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index 045787e..240d814 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -5,6 +5,10 @@ Event Loop ========== +**Source code:** :source:`Lib/asyncio/events.py`, +:source:`Lib/asyncio/base_events.py` + +------------------------------------ .. rubric:: Preface diff --git a/Doc/library/asyncio-exceptions.rst b/Doc/library/asyncio-exceptions.rst index b1e6ecf..7166d5c 100644 --- a/Doc/library/asyncio-exceptions.rst +++ b/Doc/library/asyncio-exceptions.rst @@ -7,6 +7,9 @@ Exceptions ========== +**Source code:** :source:`Lib/asyncio/exceptions.py` + +---------------------------------------------------- .. exception:: TimeoutError diff --git a/Doc/library/asyncio-future.rst b/Doc/library/asyncio-future.rst index c069471..832d581 100644 --- a/Doc/library/asyncio-future.rst +++ b/Doc/library/asyncio-future.rst @@ -7,6 +7,11 @@ Futures ======= +**Source code:** :source:`Lib/asyncio/futures.py`, +:source:`Lib/asyncio/base_futures.py` + +------------------------------------- + *Future* objects are used to bridge **low-level callback-based code** with high-level async/await code. diff --git a/Doc/library/asyncio-platforms.rst b/Doc/library/asyncio-platforms.rst index 7e4a70f..390ee19 100644 --- a/Doc/library/asyncio-platforms.rst +++ b/Doc/library/asyncio-platforms.rst @@ -23,6 +23,12 @@ All Platforms Windows ======= +**Source code:** :source:`Lib/asyncio/proactor_events.py`, +:source:`Lib/asyncio/windows_events.py`, +:source:`Lib/asyncio/windows_utils.py` + +-------------------------------------- + .. versionchanged:: 3.8 On Windows, :class:`ProactorEventLoop` is now the default event loop. diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index 67ca121..ffac901 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -69,6 +69,10 @@ This documentation page contains the following sections: Transports ========== +**Source code:** :source:`Lib/asyncio/transports.py` + +---------------------------------------------------- + Transports are classes provided by :mod:`asyncio` in order to abstract various kinds of communication channels. @@ -431,6 +435,10 @@ Subprocess Transports Protocols ========= +**Source code:** :source:`Lib/asyncio/protocols.py` + +--------------------------------------------------- + asyncio provides a set of abstract base classes that should be used to implement network protocols. Those classes are meant to be used together with :ref:`transports <asyncio-transport>`. diff --git a/Doc/library/asyncio-queue.rst b/Doc/library/asyncio-queue.rst index e7775da..524560b 100644 --- a/Doc/library/asyncio-queue.rst +++ b/Doc/library/asyncio-queue.rst @@ -6,6 +6,10 @@ Queues ====== +**Source code:** :source:`Lib/asyncio/queues.py` + +------------------------------------------------ + asyncio queues are designed to be similar to classes of the :mod:`queue` module. Although asyncio queues are not thread-safe, they are designed to be used specifically in async/await code. diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst index 471e6e9..bb89971 100644 --- a/Doc/library/asyncio-stream.rst +++ b/Doc/library/asyncio-stream.rst @@ -6,6 +6,10 @@ Streams ======= +**Source code:** :source:`Lib/asyncio/streams.py` + +------------------------------------------------- + Streams are high-level async/await-ready primitives to work with network connections. Streams allow sending and receiving data without using callbacks or low-level protocols and transports. diff --git a/Doc/library/asyncio-subprocess.rst b/Doc/library/asyncio-subprocess.rst index bd92257..1d87d2f 100644 --- a/Doc/library/asyncio-subprocess.rst +++ b/Doc/library/asyncio-subprocess.rst @@ -6,6 +6,11 @@ Subprocesses ============ +**Source code:** :source:`Lib/asyncio/subprocess.py`, +:source:`Lib/asyncio/base_subprocess.py` + +---------------------------------------- + This section describes high-level async/await asyncio APIs to create and manage subprocesses. diff --git a/Doc/library/asyncio-sync.rst b/Doc/library/asyncio-sync.rst index cc8c29d..f080b03 100644 --- a/Doc/library/asyncio-sync.rst +++ b/Doc/library/asyncio-sync.rst @@ -6,6 +6,10 @@ Synchronization Primitives ========================== +**Source code:** :source:`Lib/asyncio/locks.py` + +----------------------------------------------- + asyncio synchronization primitives are designed to be similar to those of the :mod:`threading` module with two important caveats: diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 155887a..d992b00 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -18,9 +18,9 @@ and Tasks. Coroutines ========== -Coroutines declared with async/await syntax is the preferred way of -writing asyncio applications. For example, the following snippet -of code (requires Python 3.7+) prints "hello", waits 1 second, +:term:`Coroutines <coroutine>` declared with the async/await syntax is the +preferred way of writing asyncio applications. For example, the following +snippet of code (requires Python 3.7+) prints "hello", waits 1 second, and then prints "world":: >>> import asyncio @@ -240,6 +240,10 @@ Running an asyncio Program .. versionchanged:: 3.9 Updated to use :meth:`loop.shutdown_default_executor`. + .. note:: + The source code for ``asyncio.run()`` can be found in + :source:`Lib/asyncio/runners.py`. + Creating Tasks ============== diff --git a/Doc/library/asyncio.rst b/Doc/library/asyncio.rst index 6990adb..94a8532 100644 --- a/Doc/library/asyncio.rst +++ b/Doc/library/asyncio.rst @@ -4,7 +4,7 @@ .. module:: asyncio :synopsis: Asynchronous I/O. --------------- +------------------------------- .. sidebar:: Hello World! @@ -91,3 +91,6 @@ Additionally, there are **low-level** APIs for asyncio-api-index.rst asyncio-llapi-index.rst asyncio-dev.rst + +.. note:: + The source code for asyncio can be found in :source:`Lib/asyncio/`. |