[3.10] bpo-42392: [docs] Add deprecated-removed loop labels for asyncio (GH-26357) (GH-26390)
* Add deprecated-removed loop labels for all reelvant functions/classes in asyncio
(cherry picked from commit d8fd8c8568cbc2f53c1abeda3596a89a46f0e3d7)
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
Automerge-Triggered-By: GH:gpshead
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index 69e965c..bbdef33 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -297,6 +297,12 @@
tasks to run. This can be used by long-running functions to avoid
blocking the event loop for the full duration of the function call.
+ .. 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.
+
.. _asyncio_example_sleep:
Example of coroutine displaying the current date every second
@@ -317,6 +323,14 @@
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.
+
+
Running Tasks Concurrently
==========================
@@ -349,6 +363,12 @@
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.
+
.. _asyncio_example_gather:
Example::
@@ -400,6 +420,12 @@
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.
+
.. deprecated:: 3.10
Deprecation warning is emitted if no positional arguments are provided
or not all positional arguments are Future-like objects
@@ -442,6 +468,12 @@
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.
+
.. deprecated:: 3.10
Deprecation warning is emitted if *aw* is not Future-like object
and there is no running event loop.
@@ -473,6 +505,12 @@
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.
+
.. _asyncio_example_waitfor:
Example::
@@ -500,6 +538,12 @@
for *aw* to be cancelled. Previously, it raised
:exc:`asyncio.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.
+
Waiting Primitives
==================
@@ -556,6 +600,12 @@
``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.
+
.. _asyncio_example_wait_coroutine:
.. note::
@@ -583,6 +633,13 @@
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
@@ -599,12 +656,24 @@
Raises :exc:`asyncio.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.
+
Example::
for coro in as_completed(aws):
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.
+
.. deprecated:: 3.10
Deprecation warning is emitted if not all awaitable objects in the *aws*
iterable are Future-like objects and there is no running event loop.