Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388)

This commit is contained in:
Serhiy Storchaka 2022-02-18 10:58:48 +02:00 committed by GitHub
parent d85121660e
commit 2923d87ca2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 83 additions and 182 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
Doc/library/asyncio-eventloop.rst
View File

@ -343,7 +343,7 @@ Creating Futures and Tasks
the name of the task using :meth:`Task.set_name`.
.. versionchanged:: 3.8
Added the ``name`` parameter.
Added the *name* parameter.
.. method:: loop.set_task_factory(factory)
@ -456,7 +456,20 @@ Opening network connections
to wait for the TLS handshake to complete before aborting the connection.
``60.0`` seconds if ``None`` (default).
.. versionadded:: 3.8
.. versionchanged:: 3.5
Added support for SSL/TLS in :class:`ProactorEventLoop`.
.. versionchanged:: 3.6
The socket option :py:data:`~socket.TCP_NODELAY` is set by default
for all TCP connections.
.. versionchanged:: 3.7
Added the *ssl_handshake_timeout* parameter.
.. versionchanged:: 3.8
Added the *happy_eyeballs_delay* and *interleave* parameters.
@ -471,19 +484,6 @@ Opening network connections
For more information: https://tools.ietf.org/html/rfc6555
.. versionadded:: 3.7
The *ssl_handshake_timeout* parameter.
.. versionchanged:: 3.6
The socket option :py:data:`~socket.TCP_NODELAY` is set by default
for all TCP connections.
.. versionchanged:: 3.5
Added support for SSL/TLS in :class:`ProactorEventLoop`.
.. seealso::
The :func:`open_connection` function is a high-level alternative
@ -588,12 +588,8 @@ Opening network connections
.. availability:: Unix.
.. versionadded:: 3.7
The *ssl_handshake_timeout* parameter.
.. versionchanged:: 3.7
Added the *ssl_handshake_timeout* parameter.
The *path* parameter can now be a :term:`path-like object`.
@ -672,15 +668,6 @@ Creating network servers
:meth:`Server.serve_forever` to make the server to start accepting
connections.
.. versionadded:: 3.7
Added *ssl_handshake_timeout* and *start_serving* parameters.
.. versionchanged:: 3.6
The socket option :py:data:`~socket.TCP_NODELAY` is set by default
for all TCP connections.
.. versionchanged:: 3.5
Added support for SSL/TLS in :class:`ProactorEventLoop`.
@ -689,6 +676,12 @@ Creating network servers
The *host* parameter can be a sequence of strings.
.. versionchanged:: 3.6
Added *ssl_handshake_timeout* and *start_serving* parameters.
The socket option :py:data:`~socket.TCP_NODELAY` is set by default
for all TCP connections.
.. seealso::
The :func:`start_server` function is a higher-level alternative API
@ -713,12 +706,9 @@ Creating network servers
.. availability:: Unix.
.. versionadded:: 3.7
The *ssl_handshake_timeout* and *start_serving* parameters.
.. versionchanged:: 3.7
Added the *ssl_handshake_timeout* and *start_serving* parameters.
The *path* parameter can now be a :class:`~pathlib.Path` object.
.. coroutinemethod:: loop.connect_accepted_socket(protocol_factory, \
@ -746,12 +736,12 @@ Creating network servers
Returns a ``(transport, protocol)`` pair.
.. versionadded:: 3.7
The *ssl_handshake_timeout* parameter.
.. versionadded:: 3.5.3
.. versionchanged:: 3.7
Added the *ssl_handshake_timeout* parameter.
Transferring files
^^^^^^^^^^^^^^^^^^

2
Doc/library/asyncio-future.rst
View File

@ -194,7 +194,7 @@ Future Object
schedule the callbacks, and return ``True``.
.. versionchanged:: 3.9
Added the ``msg`` parameter.
Added the *msg* parameter.
.. method:: exception()

10
Doc/library/asyncio-queue.rst
View File

@ -36,6 +36,9 @@ Queue
the queue is always known and can be returned by calling the
:meth:`qsize` method.
.. versionchanged:: 3.10
Removed the *loop* parameter.
This class is :ref:`not thread safe <asyncio-multithreading>`.
@ -105,13 +108,6 @@ Queue
Raises :exc:`ValueError` if called more times than there were
items placed in the queue.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
Priority Queue
==============

54
Doc/library/asyncio-stream.rst
View File

@ -66,16 +66,11 @@ and work with streams:
The rest of the arguments are passed directly to
:meth:`loop.create_connection`.
.. versionadded:: 3.7
.. versionchanged:: 3.7
Added the *ssl_handshake_timeout* parameter.
The *ssl_handshake_timeout* parameter.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. coroutinefunction:: start_server(client_connected_cb, host=None, \
@ -104,16 +99,11 @@ and work with streams:
The rest of the arguments are passed directly to
:meth:`loop.create_server`.
.. versionadded:: 3.7
.. versionchanged:: 3.7
Added the *ssl_handshake_timeout* and *start_serving* parameters.
The *ssl_handshake_timeout* and *start_serving* parameters.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. rubric:: Unix Sockets
@ -131,20 +121,12 @@ and work with streams:
.. availability:: Unix.
.. versionadded:: 3.7
The *ssl_handshake_timeout* parameter.
.. versionchanged:: 3.7
Added the *ssl_handshake_timeout* parameter.
The *path* parameter can now be a :term:`path-like object`
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. coroutinefunction:: start_unix_server(client_connected_cb, path=None, \
@ -159,20 +141,12 @@ and work with streams:
.. availability:: Unix.
.. versionadded:: 3.7
The *ssl_handshake_timeout* and *start_serving* parameters.
.. versionchanged:: 3.7
Added the *ssl_handshake_timeout* and *start_serving* parameters.
The *path* parameter can now be a :term:`path-like object`.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
StreamReader

16
Doc/library/asyncio-subprocess.rst
View File

@ -75,12 +75,8 @@ Creating Subprocesses
See the documentation of :meth:`loop.subprocess_exec` for other
parameters.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. coroutinefunction:: create_subprocess_shell(cmd, stdin=None, \
@ -106,12 +102,8 @@ Creating Subprocesses
escape whitespace and special shell characters in strings that are going
to be used to construct shell commands.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. note::

36
Doc/library/asyncio-sync.rst
View File

@ -63,11 +63,8 @@ Lock
finally:
lock.release()
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This class has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. coroutinemethod:: acquire()
@ -111,11 +108,8 @@ Event
:meth:`clear` method. The :meth:`~Event.wait` method blocks until the
flag is set to *true*. The flag is set to *false* initially.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This class has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. _asyncio_example_sync_event:
@ -189,11 +183,8 @@ Condition
``None``. In the latter case a new Lock object is created
automatically.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This class has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
The preferred way to use a Condition is an :keyword:`async with`
statement::
@ -291,11 +282,8 @@ Semaphore
internal counter (``1`` by default). If the given value is
less than ``0`` a :exc:`ValueError` is raised.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This class has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
The preferred way to use a Semaphore is an :keyword:`async with`
statement::
@ -349,12 +337,8 @@ BoundedSemaphore
a :exc:`ValueError` in :meth:`~Semaphore.release` if it
increases the internal counter above the initial *value*.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This class has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
---------

83
Doc/library/asyncio-task.rst
View File

@ -279,7 +279,7 @@ Creating Tasks
.. versionadded:: 3.7
.. versionchanged:: 3.8
Added the ``name`` parameter.
Added the *name* parameter.
Sleeping
@ -319,12 +319,8 @@ Sleeping
asyncio.run(display_date())
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
Running Tasks Concurrently
@ -359,11 +355,8 @@ Running Tasks Concurrently
cancellation of one submitted Task/Future to cause other
Tasks/Futures to be cancelled.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. _asyncio_example_gather:
@ -416,11 +409,8 @@ Running Tasks Concurrently
If the *gather* itself is cancelled, the cancellation is
propagated regardless of *return_exceptions*.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. deprecated:: 3.10
Deprecation warning is emitted if no positional arguments are provided
@ -464,11 +454,8 @@ Shielding From Cancellation
except CancelledError:
res = None
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. deprecated:: 3.10
Deprecation warning is emitted if *aw* is not Future-like object
@ -501,11 +488,8 @@ Timeouts
If the wait is cancelled, the future *aw* is also cancelled.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. _asyncio_example_waitfor:
@ -534,11 +518,8 @@ Timeouts
for *aw* to be cancelled. Previously, it raised
:exc:`TimeoutError` immediately.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
Waiting Primitives
@ -596,11 +577,8 @@ Waiting Primitives
``wait()`` directly is deprecated as it leads to
:ref:`confusing behavior <asyncio_example_wait_coroutine>`.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. _asyncio_example_wait_coroutine:
.. note::
@ -629,18 +607,14 @@ Waiting Primitives
if task in done:
# Everything will work as expected now.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. deprecated-removed:: 3.8 3.11
Passing coroutine objects to ``wait()`` directly is
deprecated.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. function:: as_completed(aws, *, timeout=None)
@ -652,11 +626,8 @@ Waiting Primitives
Raises :exc:`TimeoutError` if the timeout occurs before
all Futures are done.
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
Example::
@ -664,11 +635,8 @@ Waiting Primitives
earliest_result = await coro
# ...
.. deprecated-removed:: 3.8 3.10
The ``loop`` parameter. This function has been implicitly getting the
current running loop since 3.7. See
:ref:`What's New in 3.10's Removed section <whatsnew310-removed>`
for more information.
.. versionchanged:: 3.10
Removed the *loop* parameter.
.. deprecated:: 3.10
Deprecation warning is emitted if not all awaitable objects in the *aws*
@ -851,10 +819,7 @@ Task Object
Added support for the :mod:`contextvars` module.
.. versionchanged:: 3.8
Added the ``name`` parameter.
.. deprecated-removed:: 3.8 3.10
The *loop* parameter.
Added the *name* parameter.
.. deprecated:: 3.10
Deprecation warning is emitted if *loop* is not specified
@ -876,7 +841,7 @@ Task Object
discouraged.
.. versionchanged:: 3.9
Added the ``msg`` parameter.
Added the *msg* parameter.
.. _asyncio_example_task_cancel: