GH-120804: add docs for removal for asyncio child watchers (#120895)

Co-authored-by: Alex Waygood <alex.waygood@gmail.com>
This commit is contained in:
Kumar Aditya 2024-06-23 18:44:12 +05:30 committed by GitHub
parent 9d2e1ea386
commit 18b6ca9660
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 31 additions and 214 deletions

View file

@ -652,14 +652,14 @@ asyncio
making some use-cases 2x to 5x faster.
(Contributed by Jacob Bower & Itamar Oren in :gh:`102853`, :gh:`104140`, and :gh:`104138`)
* On Linux, :mod:`asyncio` uses :class:`asyncio.PidfdChildWatcher` by default
* On Linux, :mod:`asyncio` uses :class:`!asyncio.PidfdChildWatcher` by default
if :func:`os.pidfd_open` is available and functional instead of
:class:`asyncio.ThreadedChildWatcher`.
:class:`!asyncio.ThreadedChildWatcher`.
(Contributed by Kumar Aditya in :gh:`98024`.)
* The event loop now uses the best available child watcher for each platform
(:class:`asyncio.PidfdChildWatcher` if supported and
:class:`asyncio.ThreadedChildWatcher` otherwise), so manually
(:class:`!asyncio.PidfdChildWatcher` if supported and
:class:`!asyncio.ThreadedChildWatcher` otherwise), so manually
configuring a child watcher is not recommended.
(Contributed by Kumar Aditya in :gh:`94597`.)
@ -1162,15 +1162,15 @@ Deprecated
* :mod:`asyncio`:
* The child watcher classes :class:`asyncio.MultiLoopChildWatcher`,
:class:`asyncio.FastChildWatcher`, :class:`asyncio.AbstractChildWatcher`
and :class:`asyncio.SafeChildWatcher` are deprecated and
* The child watcher classes :class:`!asyncio.MultiLoopChildWatcher`,
:class:`!asyncio.FastChildWatcher`, :class:`!asyncio.AbstractChildWatcher`
and :class:`!asyncio.SafeChildWatcher` are deprecated and
will be removed in Python 3.14.
(Contributed by Kumar Aditya in :gh:`94597`.)
* :func:`asyncio.set_child_watcher`, :func:`asyncio.get_child_watcher`,
:meth:`asyncio.AbstractEventLoopPolicy.set_child_watcher` and
:meth:`asyncio.AbstractEventLoopPolicy.get_child_watcher` are deprecated
* :func:`!asyncio.set_child_watcher`, :func:`!asyncio.get_child_watcher`,
:meth:`!asyncio.AbstractEventLoopPolicy.set_child_watcher` and
:meth:`!asyncio.AbstractEventLoopPolicy.get_child_watcher` are deprecated
and will be removed in Python 3.14.
(Contributed by Kumar Aditya in :gh:`94597`.)

View file

@ -173,6 +173,26 @@ ast
(Contributed by Alex Waygood in :gh:`119562`.)
asyncio
-------
* Remove the following classes and functions. They were all deprecated and
emitted deprecation warnings since Python 3.12:
* :class:`!asyncio.AbstractChildWatcher`
* :class:`!asyncio.SafeChildWatcher`
* :class:`!asyncio.MultiLoopChildWatcher`
* :class:`!asyncio.FastChildWatcher`
* :class:`!asyncio.ThreadedChildWatcher`
* :class:`!asyncio.PidfdChildWatcher`
* :meth:`!asyncio.AbstractEventLoopPolicy.get_child_watcher`
* :meth:`!asyncio.AbstractEventLoopPolicy.set_child_watcher`
* :func:`!asyncio.get_child_watcher`
* :func:`!asyncio.set_child_watcher`
(Contributed by Kumar Aditya in :gh:`120804`.)
collections.abc
---------------

View file

@ -352,7 +352,7 @@ that schedules a shutdown for the default executor that waits on the
:func:`asyncio.run` has been updated to use the new :term:`coroutine`.
(Contributed by Kyle Stanley in :issue:`34037`.)
Added :class:`asyncio.PidfdChildWatcher`, a Linux-specific child watcher
Added :class:`!asyncio.PidfdChildWatcher`, a Linux-specific child watcher
implementation that polls process file descriptors. (:issue:`38692`)
Added a new :term:`coroutine` :func:`asyncio.to_thread`. It is mainly used for