From 5c91c57a83051f38017cd39e001b37e325a942a1 Mon Sep 17 00:00:00 2001 From: CAM Gerlach Date: Fri, 20 May 2022 15:47:51 -0600 Subject: [PATCH] gh-92611: Clarify planned removal version in PEP 594-deprecated modules (GH-92793) As discussed in GH-92611 and GH-92564 and as a followup to PR GH-92612 , this 3.11+ only PR uses the proper `deprecated-removed` role for the modules deprecated by PEP 593 (PEP-594) to clearly indicate to users that a removal version is planned and what it is, so they can prepare accordingly or voice any unanticipated impacts. Related to GH-92792 ; if we decide to backport that PR, the upgrade to using `deprecated-removed` on those functions can be moved to this one. (cherry picked from commit 31fa41ed689528505c0e0cf25777773b7e81c834) Co-authored-by: CAM Gerlach --- Doc/library/aifc.rst | 2 +- Doc/library/asynchat.rst | 4 ++-- Doc/library/asyncore.rst | 4 ++-- Doc/library/audioop.rst | 2 +- Doc/library/cgi.rst | 2 +- Doc/library/cgitb.rst | 2 +- Doc/library/chunk.rst | 2 +- Doc/library/crypt.rst | 2 +- Doc/library/imghdr.rst | 2 +- Doc/library/imp.rst | 2 +- Doc/library/mailcap.rst | 2 +- Doc/library/msilib.rst | 2 +- Doc/library/nis.rst | 2 +- Doc/library/ossaudiodev.rst | 2 +- Doc/library/pipes.rst | 2 +- Doc/library/smtpd.rst | 4 ++-- Doc/library/sndhdr.rst | 2 +- Doc/library/spwd.rst | 2 +- Doc/library/sunau.rst | 2 +- Doc/library/telnetlib.rst | 2 +- Doc/library/uu.rst | 2 +- Doc/library/xdrlib.rst | 2 +- 22 files changed, 25 insertions(+), 25 deletions(-) diff --git a/Doc/library/aifc.rst b/Doc/library/aifc.rst index fa277857574a3a..9f20a30193fa70 100644 --- a/Doc/library/aifc.rst +++ b/Doc/library/aifc.rst @@ -13,7 +13,7 @@ single: AIFF-C -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`aifc` module is deprecated (see :pep:`PEP 594 <594#aifc>` for details). diff --git a/Doc/library/asynchat.rst b/Doc/library/asynchat.rst index 7cc9d99779bbbb..4eb6a79d4dfbf2 100644 --- a/Doc/library/asynchat.rst +++ b/Doc/library/asynchat.rst @@ -10,8 +10,8 @@ **Source code:** :source:`Lib/asynchat.py` -.. deprecated:: 3.6 - :mod:`asynchat` will be removed in Python 3.12 +.. deprecated-removed:: 3.6 3.12 + The :mod:`asynchat` module is deprecated (see :pep:`PEP 594 <594#asynchat>` for details). Please use :mod:`asyncio` instead. diff --git a/Doc/library/asyncore.rst b/Doc/library/asyncore.rst index a732fd7ba4f152..0084d754419d09 100644 --- a/Doc/library/asyncore.rst +++ b/Doc/library/asyncore.rst @@ -13,8 +13,8 @@ **Source code:** :source:`Lib/asyncore.py` -.. deprecated:: 3.6 - :mod:`asyncore` will be removed in Python 3.12 +.. deprecated-removed:: 3.6 3.12 + The :mod:`asyncore` module is deprecated (see :pep:`PEP 594 <594#asyncore>` for details). Please use :mod:`asyncio` instead. diff --git a/Doc/library/audioop.rst b/Doc/library/audioop.rst index 649c99e796282c..1f96575d08f5b1 100644 --- a/Doc/library/audioop.rst +++ b/Doc/library/audioop.rst @@ -5,7 +5,7 @@ :synopsis: Manipulate raw audio data. :deprecated: -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`audioop` module is deprecated (see :pep:`PEP 594 <594#audioop>` for details). diff --git a/Doc/library/cgi.rst b/Doc/library/cgi.rst index 31c03dee91ea82..5976c90029c22a 100644 --- a/Doc/library/cgi.rst +++ b/Doc/library/cgi.rst @@ -15,7 +15,7 @@ single: URL single: Common Gateway Interface -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`cgi` module is deprecated (see :pep:`PEP 594 <594#cgi>` for details and alternatives). diff --git a/Doc/library/cgitb.rst b/Doc/library/cgitb.rst index 3b0b106abacd50..7f00bcd55c1e53 100644 --- a/Doc/library/cgitb.rst +++ b/Doc/library/cgitb.rst @@ -16,7 +16,7 @@ single: exceptions; in CGI scripts single: tracebacks; in CGI scripts -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`cgitb` module is deprecated (see :pep:`PEP 594 <594#cgitb>` for details). diff --git a/Doc/library/chunk.rst b/Doc/library/chunk.rst index 5a84c8904f7145..3b88e55b147882 100644 --- a/Doc/library/chunk.rst +++ b/Doc/library/chunk.rst @@ -17,7 +17,7 @@ single: Real Media File Format single: RMFF -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`chunk` module is deprecated (see :pep:`PEP 594 <594#chunk>` for details). diff --git a/Doc/library/crypt.rst b/Doc/library/crypt.rst index e795f10f50eec3..efba4236bcbccc 100644 --- a/Doc/library/crypt.rst +++ b/Doc/library/crypt.rst @@ -16,7 +16,7 @@ single: crypt(3) pair: cipher; DES -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`crypt` module is deprecated (see :pep:`PEP 594 <594#crypt>` for details and alternatives). The :mod:`hashlib` module is a potential replacement for certain use cases. diff --git a/Doc/library/imghdr.rst b/Doc/library/imghdr.rst index c17bf897b9be91..318fe650776d2a 100644 --- a/Doc/library/imghdr.rst +++ b/Doc/library/imghdr.rst @@ -7,7 +7,7 @@ **Source code:** :source:`Lib/imghdr.py` -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`imghdr` module is deprecated (see :pep:`PEP 594 <594#imghdr>` for details and alternatives). diff --git a/Doc/library/imp.rst b/Doc/library/imp.rst index 121a730e0c9b4a..000793a7e66cae 100644 --- a/Doc/library/imp.rst +++ b/Doc/library/imp.rst @@ -7,7 +7,7 @@ **Source code:** :source:`Lib/imp.py` -.. deprecated:: 3.4 +.. deprecated-removed:: 3.4 3.12 The :mod:`imp` module is deprecated in favor of :mod:`importlib`. .. index:: statement: import diff --git a/Doc/library/mailcap.rst b/Doc/library/mailcap.rst index e2e5bb34456373..5490c8468d7cf7 100644 --- a/Doc/library/mailcap.rst +++ b/Doc/library/mailcap.rst @@ -7,7 +7,7 @@ **Source code:** :source:`Lib/mailcap.py` -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`mailcap` module is deprecated (see :pep:`PEP 594 <594#mailcap>` for details). The :mod:`mimetypes` module provides an alternative. diff --git a/Doc/library/msilib.rst b/Doc/library/msilib.rst index 1ee8130801cba5..fbe55db9372300 100644 --- a/Doc/library/msilib.rst +++ b/Doc/library/msilib.rst @@ -13,7 +13,7 @@ .. index:: single: msi -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`msilib` module is deprecated (see :pep:`PEP 594 <594#msilib>` for details). diff --git a/Doc/library/nis.rst b/Doc/library/nis.rst index 49fe62954cce8a..fd3c3d9293d247 100644 --- a/Doc/library/nis.rst +++ b/Doc/library/nis.rst @@ -10,7 +10,7 @@ .. moduleauthor:: Fred Gansevles .. sectionauthor:: Moshe Zadka -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`nis` module is deprecated (see :pep:`PEP 594 <594#nis>` for details). diff --git a/Doc/library/ossaudiodev.rst b/Doc/library/ossaudiodev.rst index 728ee3036057dd..e14c1bf8d5367e 100644 --- a/Doc/library/ossaudiodev.rst +++ b/Doc/library/ossaudiodev.rst @@ -6,7 +6,7 @@ :synopsis: Access to OSS-compatible audio devices. :deprecated: -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`ossaudiodev` module is deprecated (see :pep:`PEP 594 <594#ossaudiodev>` for details). diff --git a/Doc/library/pipes.rst b/Doc/library/pipes.rst index 1c5bb8bddaafbc..245dd0d2520881 100644 --- a/Doc/library/pipes.rst +++ b/Doc/library/pipes.rst @@ -10,7 +10,7 @@ **Source code:** :source:`Lib/pipes.py` -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`pipes` module is deprecated (see :pep:`PEP 594 <594#pipes>` for details). Please use the :mod:`subprocess` module instead. diff --git a/Doc/library/smtpd.rst b/Doc/library/smtpd.rst index 121790b5ed0ddf..a0d1fb0aa51529 100644 --- a/Doc/library/smtpd.rst +++ b/Doc/library/smtpd.rst @@ -14,8 +14,8 @@ This module offers several classes to implement SMTP (email) servers. -.. deprecated:: 3.6 - :mod:`smtpd` will be removed in Python 3.12 +.. deprecated-removed:: 3.6 3.12 + The :mod:`smtpd` module is deprecated (see :pep:`PEP 594 <594#smtpd>` for details). The `aiosmtpd `_ package is a recommended replacement for this module. It is based on :mod:`asyncio` and provides a diff --git a/Doc/library/sndhdr.rst b/Doc/library/sndhdr.rst index 3ca36f270dade1..e1dbe4a1a34483 100644 --- a/Doc/library/sndhdr.rst +++ b/Doc/library/sndhdr.rst @@ -14,7 +14,7 @@ single: A-LAW single: u-LAW -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`sndhdr` module is deprecated (see :pep:`PEP 594 <594#sndhdr>` for details and alternatives). diff --git a/Doc/library/spwd.rst b/Doc/library/spwd.rst index 40f50de07babff..87e09167ada427 100644 --- a/Doc/library/spwd.rst +++ b/Doc/library/spwd.rst @@ -6,7 +6,7 @@ :synopsis: The shadow password database (getspnam() and friends). :deprecated: -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`spwd` module is deprecated (see :pep:`PEP 594 <594#spwd>` for details and alternatives). diff --git a/Doc/library/sunau.rst b/Doc/library/sunau.rst index b4d996e67e17cf..c7a38d96ade131 100644 --- a/Doc/library/sunau.rst +++ b/Doc/library/sunau.rst @@ -9,7 +9,7 @@ **Source code:** :source:`Lib/sunau.py` -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`sunau` module is deprecated (see :pep:`PEP 594 <594#sunau>` for details). diff --git a/Doc/library/telnetlib.rst b/Doc/library/telnetlib.rst index 48a927c8ac96b2..70b8c7d1511d09 100644 --- a/Doc/library/telnetlib.rst +++ b/Doc/library/telnetlib.rst @@ -11,7 +11,7 @@ .. index:: single: protocol; Telnet -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`telnetlib` module is deprecated (see :pep:`PEP 594 <594#telnetlib>` for details and alternatives). diff --git a/Doc/library/uu.rst b/Doc/library/uu.rst index 026ec415c9da65..83c4aec47bbefc 100644 --- a/Doc/library/uu.rst +++ b/Doc/library/uu.rst @@ -9,7 +9,7 @@ **Source code:** :source:`Lib/uu.py` -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`uu` module is deprecated (see :pep:`PEP 594 <594#uu-and-the-uu-encoding>` for details). :mod:`base64` is a modern alternative. diff --git a/Doc/library/xdrlib.rst b/Doc/library/xdrlib.rst index a3124a986524bd..39e75573260c50 100644 --- a/Doc/library/xdrlib.rst +++ b/Doc/library/xdrlib.rst @@ -11,7 +11,7 @@ single: XDR single: External Data Representation -.. deprecated:: 3.11 +.. deprecated-removed:: 3.11 3.13 The :mod:`xdrlib` module is deprecated (see :pep:`PEP 594 <594#xdrlib>` for details).