[Python-checkins] [3.9] bpo-47022: Document asynchat, asyncore and smtpd removals in 3.12 (GH-31891) (#31998)
brettcannon
webhook-mailer at python.org
Tue Mar 22 14:13:04 EDT 2022
https://github.com/python/cpython/commit/af341ebf00d9a45cadea4c07810564d8e8962b96
commit: af341ebf00d9a45cadea4c07810564d8e8962b96
branch: 3.9
author: Hugo van Kemenade <hugovk at users.noreply.github.com>
committer: brettcannon <brett at python.org>
date: 2022-03-22T11:12:39-07:00
summary:
[3.9] bpo-47022: Document asynchat, asyncore and smtpd removals in 3.12 (GH-31891) (#31998)
Document the deprecation of asyncore, asynchat, and smtpd with a slated removal in Python 3.12 thanks to PEP 594..
(cherry picked from commit 77473846439b8a3eae66de1a1cfe931619f38513)
Co-authored-by: Hugo van Kemenade <hugovk at users.noreply.github.com>
files:
A Misc/NEWS.d/next/Library/2022-03-15-09-29-52.bpo-47022.uaEDcI.rst
M Doc/library/asynchat.rst
M Doc/library/asyncore.rst
M Doc/library/smtpd.rst
M Doc/library/superseded.rst
diff --git a/Doc/library/asynchat.rst b/Doc/library/asynchat.rst
index 9e51416b83a57..4354444a1d331 100644
--- a/Doc/library/asynchat.rst
+++ b/Doc/library/asynchat.rst
@@ -3,6 +3,7 @@
.. module:: asynchat
:synopsis: Support for asynchronous command/response protocols.
+ :deprecated:
.. moduleauthor:: Sam Rushing <rushing at nightmare.com>
.. sectionauthor:: Steve Holden <sholden at holdenweb.com>
@@ -10,6 +11,7 @@
**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.
--------------
diff --git a/Doc/library/asyncore.rst b/Doc/library/asyncore.rst
index a86518ebff277..e481e13db76f7 100644
--- a/Doc/library/asyncore.rst
+++ b/Doc/library/asyncore.rst
@@ -4,6 +4,7 @@
.. module:: asyncore
:synopsis: A base class for developing asynchronous socket handling
services.
+ :deprecated:
.. moduleauthor:: Sam Rushing <rushing at nightmare.com>
.. sectionauthor:: Christopher Petrilli <petrilli at amber.org>
@@ -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.
--------------
diff --git a/Doc/library/smtpd.rst b/Doc/library/smtpd.rst
index d84e74a8ceaaf..a39bc024047fd 100644
--- a/Doc/library/smtpd.rst
+++ b/Doc/library/smtpd.rst
@@ -3,6 +3,7 @@
.. module:: smtpd
:synopsis: A SMTP server implementation in Python.
+ :deprecated:
.. moduleauthor:: Barry Warsaw <barry at python.org>
.. sectionauthor:: Moshe Zadka <moshez at moshez.org>
@@ -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
diff --git a/Doc/library/superseded.rst b/Doc/library/superseded.rst
index 50a5983236e76..fd23e4d1536d3 100644
--- a/Doc/library/superseded.rst
+++ b/Doc/library/superseded.rst
@@ -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
diff --git a/Misc/NEWS.d/next/Library/2022-03-15-09-29-52.bpo-47022.uaEDcI.rst b/Misc/NEWS.d/next/Library/2022-03-15-09-29-52.bpo-47022.uaEDcI.rst
new file mode 100644
index 0000000000000..c35da6fb47b05
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2022-03-15-09-29-52.bpo-47022.uaEDcI.rst
@@ -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`).
More information about the Python-checkins
mailing list