Skip to content

[3.9] bpo-47022: Document asynchat, asyncore and smtpd removals in 3.12 (GH-31891) #31998

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
merged 1 commit into from
Mar 22, 2022
Merged

[3.9] bpo-47022: Document asynchat, asyncore and smtpd removals in 3.12 (GH-31891) #31998

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions Doc/library/asynchat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@

.. module:: asynchat
:synopsis: Support for asynchronous command/response protocols.
:deprecated:

.. moduleauthor:: Sam Rushing <[email protected]>
.. sectionauthor:: Steve Holden <[email protected]>

**Source code:** :source:`Lib/asynchat.py`

.. deprecated:: 3.6
:mod:`asynchat` will be removed in Python 3.12 (:pep:`594`).
Please use :mod:`asyncio` instead.

--------------
Expand Down
2 changes: 2 additions & 0 deletions Doc/library/asyncore.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
.. module:: asyncore
:synopsis: A base class for developing asynchronous socket handling
services.
:deprecated:

.. moduleauthor:: Sam Rushing <[email protected]>
.. sectionauthor:: Christopher Petrilli <[email protected]>
Expand All @@ -13,6 +14,7 @@
**Source code:** :source:`Lib/asyncore.py`

.. deprecated:: 3.6
:mod:`asyncore` will be removed in Python 3.12 (:pep:`594`).
Please use :mod:`asyncio` instead.

--------------
Expand Down
11 changes: 6 additions & 5 deletions Doc/library/smtpd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

.. module:: smtpd
:synopsis: A SMTP server implementation in Python.
:deprecated:

.. moduleauthor:: Barry Warsaw <[email protected]>
.. sectionauthor:: Moshe Zadka <[email protected]>
Expand All @@ -13,11 +14,11 @@

This module offers several classes to implement SMTP (email) servers.

.. seealso::

The `aiosmtpd <http://aiosmtpd.readthedocs.io/>`_ package is a recommended
replacement for this module. It is based on :mod:`asyncio` and provides a
more straightforward API. :mod:`smtpd` should be considered deprecated.
.. deprecated:: 3.6
:mod:`smtpd` will be removed in Python 3.12 (:pep:`594`).
The `aiosmtpd <https://aiosmtpd.readthedocs.io/>`_ package is a recommended
replacement for this module. It is based on :mod:`asyncio` and provides a
more straightforward API.

Several server implementations are present; one is a generic
do-nothing implementation, which can be overridden, while the other two offer
Expand Down
5 changes: 4 additions & 1 deletion Doc/library/superseded.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,8 @@ backwards compatibility. They have been superseded by other modules.

.. toctree::

optparse.rst
asynchat.rst
asyncore.rst
smtpd.rst
imp.rst
optparse.rst
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2022-03-15-09-29-52.bpo-47022.uaEDcI.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
The :mod:`asynchat`, :mod:`asyncore` and :mod:`smtpd` modules have been
deprecated since at least Python 3.6. Their documentation has now been
updated to note they will removed in Python 3.12 (:pep:`594`).