Skip to content

bpo-42392: [docs] Add deprecated-removed loop labels for asyncio #26357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gpshead merged 2 commits into from
May 26, 2021
Merged

bpo-42392: [docs] Add deprecated-removed loop labels for asyncio #26357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10fa4df
Add deprecated-removed loop labels for all reelvant functions/classes…
Fidget-Spinner May 25, 2021
d459dc5
Create 2021-05-26-11-16-33.bpo-42392.oxRx6E.rst
Fidget-Spinner May 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Doc/library/asyncio-queue.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,13 @@ 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
==============
Expand Down
29 changes: 29 additions & 0 deletions Doc/library/asyncio-stream.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@ and work with streams:

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.


.. coroutinefunction:: start_server(client_connected_cb, host=None, \
port=None, *, limit=None, \
family=socket.AF_UNSPEC, \
Expand Down Expand Up @@ -100,6 +108,13 @@ and work with streams:

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.


.. rubric:: Unix Sockets

Expand All @@ -124,6 +139,13 @@ and work with streams:

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.


.. coroutinefunction:: start_unix_server(client_connected_cb, path=None, \
*, limit=None, sock=None, backlog=100, ssl=None, \
Expand All @@ -145,6 +167,13 @@ and work with streams:

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.


StreamReader
============
Expand Down
14 changes: 14 additions & 0 deletions Doc/library/asyncio-subprocess.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,13 @@ 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.


.. coroutinefunction:: create_subprocess_shell(cmd, stdin=None, \
stdout=None, stderr=None, limit=None, **kwds)
Expand All @@ -99,6 +106,13 @@ 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.

.. note::

Subprocesses are available for Windows if a :class:`ProactorEventLoop` is
Expand Down
31 changes: 31 additions & 0 deletions Doc/library/asyncio-sync.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ 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.

.. coroutinemethod:: acquire()

Acquire the lock.
Expand Down Expand Up @@ -105,6 +111,12 @@ 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.

.. _asyncio_example_sync_event:

Example::
Expand Down Expand Up @@ -177,6 +189,12 @@ 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.

The preferred way to use a Condition is an :keyword:`async with`
statement::

Expand Down Expand Up @@ -273,6 +291,12 @@ 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.

The preferred way to use a Semaphore is an :keyword:`async with`
statement::

Expand Down Expand Up @@ -325,6 +349,13 @@ 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.

---------


Expand Down
69 changes: 69 additions & 0 deletions Doc/library/asyncio-task.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,12 @@ Sleeping
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
Expand All @@ -317,6 +323,14 @@ 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.


Running Tasks Concurrently
==========================

Expand Down Expand Up @@ -349,6 +363,12 @@ 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.

.. _asyncio_example_gather:

Example::
Expand Down Expand Up @@ -400,6 +420,12 @@ 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.

.. deprecated:: 3.10
Deprecation warning is emitted if no positional arguments are provided
or not all positional arguments are Future-like objects
Expand Down Expand Up @@ -442,6 +468,12 @@ 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.

.. deprecated:: 3.10
Deprecation warning is emitted if *aw* is not Future-like object
and there is no running event loop.
Expand Down Expand Up @@ -473,6 +505,12 @@ 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.

.. _asyncio_example_waitfor:

Example::
Expand Down Expand Up @@ -500,6 +538,12 @@ Timeouts
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
==================
Expand Down Expand Up @@ -556,6 +600,12 @@ 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.

.. _asyncio_example_wait_coroutine:
.. note::

Expand Down Expand Up @@ -583,6 +633,13 @@ 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
Expand All @@ -599,12 +656,24 @@ Waiting Primitives
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.
Expand Down
1 change: 1 addition & 0 deletions Doc/whatsnew/3.10.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1578,6 +1578,7 @@ Deprecated
* ``cgi.log()`` is deprecated and slated for removal in Python 3.12.
(Contributed by Inada Naoki in :issue:`41139`.)

.. _whatsnew310-removed:

Removed
=======
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Documentation/2021-05-26-11-16-33.bpo-42392.oxRx6E.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Document the deprecation and removal of the ``loop`` parameter for many
functions and classes in :mod:`asyncio`.