bpo-47061: document module deprecations due to PEP 594 (GH-31984)

Also removed asynchat, asyncore, and smtpd from their respective toctree entries so they are only  in the superceded subtree.

diff --git a/Doc/library/aifc.rst b/Doc/library/aifc.rst
index 2e917cf7321b857bb7a0bcb317e93d2ab88ba443..edb4bf86e5a0aae57c83db8e2d9d14fcfa6cc681 100644 (file)
--- a/Doc/library/aifc.rst
+++ b/Doc/library/aifc.rst
@@ -3,6 +3,7 @@
 
 .. module:: aifc
    :synopsis: Read and write audio files in AIFF or AIFC format.
+   :deprecated:
 
 **Source code:** :source:`Lib/aifc.py`
 
@@ -11,6 +12,10 @@
    single: AIFF
    single: AIFF-C
 
+
+.. deprecated:: 3.11
+   The :mod:`aifc` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 This module provides support for reading and writing AIFF and AIFF-C files.

diff --git a/Doc/library/audioop.rst b/Doc/library/audioop.rst
index bad9da2ec62e565d50bfdd0ed45519251f07ae35..eae206084f09004ffb7cf888ca48efb09437082d 100644 (file)
--- a/Doc/library/audioop.rst
+++ b/Doc/library/audioop.rst
@@ -3,6 +3,10 @@
 
 .. module:: audioop
    :synopsis: Manipulate raw audio data.
+   :deprecated:
+
+.. deprecated:: 3.11
+   The :mod:`audioop` module is deprecated (see :pep:`594` for details).
 
 --------------
 

diff --git a/Doc/library/cgi.rst b/Doc/library/cgi.rst
index a2957ba5a68ad02485a9cdb7a274eea31ad62f5f..7e697408af07bc44a6725816766c9bc7a8a4d69c 100644 (file)
--- a/Doc/library/cgi.rst
+++ b/Doc/library/cgi.rst
@@ -3,6 +3,7 @@
 
 .. module:: cgi
    :synopsis: Helpers for running Python scripts via the Common Gateway Interface.
+   :deprecated:
 
 **Source code:** :source:`Lib/cgi.py`
 
@@ -14,6 +15,9 @@
    single: URL
    single: Common Gateway Interface
 
+.. deprecated:: 3.11
+   The :mod:`cgi` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 Support module for Common Gateway Interface (CGI) scripts.

diff --git a/Doc/library/cgitb.rst b/Doc/library/cgitb.rst
index 5f3a6476dd8cdcf5431425576ea14f3b0c638fd5..349414610bd40a7375b5c4b5436660f3688f8f97 100644 (file)
--- a/Doc/library/cgitb.rst
+++ b/Doc/library/cgitb.rst
@@ -3,6 +3,7 @@
 
 .. module:: cgitb
    :synopsis: Configurable traceback handler for CGI scripts.
+   :deprecated:
 
 .. moduleauthor:: Ka-Ping Yee <ping@lfw.org>
 .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
@@ -15,6 +16,9 @@
    single: exceptions; in CGI scripts
    single: tracebacks; in CGI scripts
 
+.. deprecated:: 3.11
+   The :mod:`cgitb` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 The :mod:`cgitb` module provides a special exception handler for Python scripts.

diff --git a/Doc/library/chunk.rst b/Doc/library/chunk.rst
index 5e24df923ed21024f986d8597921f1ac6938b344..7999420f536d762becefbb06a39589ec0379b1a4 100644 (file)
--- a/Doc/library/chunk.rst
+++ b/Doc/library/chunk.rst
@@ -3,6 +3,7 @@
 
 .. module:: chunk
    :synopsis: Module to read IFF chunks.
+   :deprecated:
 
 .. moduleauthor:: Sjoerd Mullender <sjoerd@acm.org>
 .. sectionauthor:: Sjoerd Mullender <sjoerd@acm.org>
@@ -16,6 +17,9 @@
    single: Real Media File Format
    single: RMFF
 
+.. deprecated:: 3.11
+   The :mod:`chunk` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 This module provides an interface for reading files that use EA IFF 85 chunks.

diff --git a/Doc/library/crypt.rst b/Doc/library/crypt.rst
index d25c626a175854ac5edca4c2f5d30a30bdb60e94..73df87ca0db8d183702102d61568a0037f5f3fe5 100644 (file)
--- a/Doc/library/crypt.rst
+++ b/Doc/library/crypt.rst
@@ -4,6 +4,7 @@
 .. module:: crypt
    :platform: Unix
    :synopsis: The crypt() function used to check Unix passwords.
+   :deprecated:
 
 .. moduleauthor:: Steven D. Majewski <sdm7g@virginia.edu>
 .. sectionauthor:: Steven D. Majewski <sdm7g@virginia.edu>
@@ -15,6 +16,9 @@
    single: crypt(3)
    pair: cipher; DES
 
+.. deprecated:: 3.11
+   The :mod:`crypt` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 This module implements an interface to the :manpage:`crypt(3)` routine, which is

diff --git a/Doc/library/fileformats.rst b/Doc/library/fileformats.rst
index bb099fe2d3d6e306e2581278ba3a4aa1f13667c7..cab82b30ef42d74219c1f4b45591fef5b9c00c96 100644 (file)
--- a/Doc/library/fileformats.rst
+++ b/Doc/library/fileformats.rst
@@ -14,5 +14,4 @@ that aren't markup languages and are not related to e-mail.
    configparser.rst
    tomllib.rst
    netrc.rst
-   xdrlib.rst
    plistlib.rst

diff --git a/Doc/library/imghdr.rst b/Doc/library/imghdr.rst
index 3d7f6de7a1bec045d3a9ca6362bf6e5e2dc8c6e7..084fef73daf28dd474315cac88dd7fd25f00a3c7 100644 (file)
--- a/Doc/library/imghdr.rst
+++ b/Doc/library/imghdr.rst
@@ -3,9 +3,13 @@
 
 .. module:: imghdr
    :synopsis: Determine the type of image contained in a file or byte stream.
+   :deprecated:
 
 **Source code:** :source:`Lib/imghdr.py`
 
+.. deprecated:: 3.11
+   The :mod:`imghdr` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 The :mod:`imghdr` module determines the type of image contained in a file or

diff --git a/Doc/library/internet.rst b/Doc/library/internet.rst
index e745dd1243512e1975803574ed21e61c2a375997..ff58dcf4d89c36f26c9956e936bd6f234ed9514d 100644 (file)
--- a/Doc/library/internet.rst
+++ b/Doc/library/internet.rst
@@ -20,8 +20,6 @@ is currently supported on most popular platforms.  Here is an overview:
 .. toctree::
 
    webbrowser.rst
-   cgi.rst
-   cgitb.rst
    wsgiref.rst
    urllib.rst
    urllib.request.rst
@@ -33,10 +31,7 @@ is currently supported on most popular platforms.  Here is an overview:
    ftplib.rst
    poplib.rst
    imaplib.rst
-   nntplib.rst
    smtplib.rst
-   smtpd.rst
-   telnetlib.rst
    uuid.rst
    socketserver.rst
    http.server.rst

diff --git a/Doc/library/ipc.rst b/Doc/library/ipc.rst
index b88a174eb97f15c0067664902b6aca8cb0185f8b..4849c82f317d97ec704e72f3da037081abaa9cb4 100644 (file)
--- a/Doc/library/ipc.rst
+++ b/Doc/library/ipc.rst
@@ -22,7 +22,5 @@ The list of modules described in this chapter is:
    ssl.rst
    select.rst
    selectors.rst
-   asyncore.rst
-   asynchat.rst
    signal.rst
    mmap.rst

diff --git a/Doc/library/mm.rst b/Doc/library/mm.rst
index c8f79c4de1cdf258d00f4c546b13ea57ade708fa..cd06e9385a26124ed93ee002db8c317182e3b9e7 100644 (file)
--- a/Doc/library/mm.rst
+++ b/Doc/library/mm.rst
@@ -11,12 +11,5 @@ discretion of the installation.  Here's an overview:
 
 .. toctree::
 
-   audioop.rst
-   aifc.rst
-   sunau.rst
    wave.rst
-   chunk.rst
    colorsys.rst
-   imghdr.rst
-   sndhdr.rst
-   ossaudiodev.rst

diff --git a/Doc/library/msilib.rst b/Doc/library/msilib.rst
index 22638852e31ea289c65d24ff0b74dd0f794c6689..b2fa20873fbbf660b6cdcf11f153554140f16480 100644 (file)
--- a/Doc/library/msilib.rst
+++ b/Doc/library/msilib.rst
@@ -4,6 +4,7 @@
 .. module:: msilib
    :platform: Windows
    :synopsis: Creation of Microsoft Installer files, and CAB files.
+   :deprecated:
 
 .. moduleauthor:: Martin v. Löwis <martin@v.loewis.de>
 .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de>
@@ -12,6 +13,9 @@
 
 .. index:: single: msi
 
+.. deprecated:: 3.11
+   The :mod:`msilib` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 The :mod:`msilib` supports the creation of Microsoft Installer (``.msi``) files.

diff --git a/Doc/library/netdata.rst b/Doc/library/netdata.rst
index 16f43a69d68b2b9deca00cc2204808b1621c21ee..8955e859ab634cc5eef6f6970e92f87ad8501c3f 100644 (file)
--- a/Doc/library/netdata.rst
+++ b/Doc/library/netdata.rst
@@ -19,4 +19,3 @@ on the internet.
    base64.rst
    binascii.rst
    quopri.rst
-   uu.rst

diff --git a/Doc/library/nis.rst b/Doc/library/nis.rst
index 10c67cbb81b2f057470ff6f039f37da10336f3a2..f6b6ea83946b0ed496abbea6b4e3cb981bf9435e 100644 (file)
--- a/Doc/library/nis.rst
+++ b/Doc/library/nis.rst
@@ -5,10 +5,14 @@
 .. module:: nis
    :platform: Unix
    :synopsis: Interface to Sun's NIS (Yellow Pages) library.
+   :deprecated:
 
 .. moduleauthor:: Fred Gansevles <Fred.Gansevles@cs.utwente.nl>
 .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
 
+.. deprecated:: 3.11
+   The :mod:`nis` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 The :mod:`nis` module gives a thin wrapper around the NIS library, useful for

diff --git a/Doc/library/nntplib.rst b/Doc/library/nntplib.rst
index e7ec9047e015e6cd66f07ad09160cdb72bad8b4e..2a996e451bf7c535c81f17b05c571e754f3ccc08 100644 (file)
--- a/Doc/library/nntplib.rst
+++ b/Doc/library/nntplib.rst
@@ -3,6 +3,7 @@
 
 .. module:: nntplib
    :synopsis: NNTP protocol client (requires sockets).
+   :deprecated:
 
 **Source code:** :source:`Lib/nntplib.py`
 
@@ -10,6 +11,9 @@
    pair: NNTP; protocol
    single: Network News Transfer Protocol
 
+.. deprecated:: 3.11
+   The :mod:`nntplib` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 This module defines the class :class:`NNTP` which implements the client side of

diff --git a/Doc/library/ossaudiodev.rst b/Doc/library/ossaudiodev.rst
index a7d3dac363cdf24ae0f65e11a05eca9d444fd324..e0f0a6b8259e4f4deb19214e091213a9f53d90d0 100644 (file)
--- a/Doc/library/ossaudiodev.rst
+++ b/Doc/library/ossaudiodev.rst
@@ -4,6 +4,10 @@
 .. module:: ossaudiodev
    :platform: Linux, FreeBSD
    :synopsis: Access to OSS-compatible audio devices.
+   :deprecated:
+
+.. deprecated:: 3.11
+   The :mod:`ossaudiodev` module is deprecated (see :pep:`594` for details).
 
 --------------
 

diff --git a/Doc/library/pipes.rst b/Doc/library/pipes.rst
index 57e27a6acf4b6624137ec7004ac1ab3e5f4b9e36..4de8c51bcae049f9f48176c68937f5718e60e88c 100644 (file)
--- a/Doc/library/pipes.rst
+++ b/Doc/library/pipes.rst
@@ -4,11 +4,15 @@
 .. module:: pipes
    :platform: Unix
    :synopsis: A Python interface to Unix shell pipelines.
+   :deprecated:
 
 .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
 
 **Source code:** :source:`Lib/pipes.py`
 
+.. deprecated:: 3.11
+   The :mod:`pipes` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 The :mod:`pipes` module defines a class to abstract the concept of a *pipeline*

diff --git a/Doc/library/sndhdr.rst b/Doc/library/sndhdr.rst
index 6bfa9a9fd210bef3fee5aaffa7c2054853d7175c..41bce18b9cd849a4fb85630aec5e390033e946a7 100644 (file)
--- a/Doc/library/sndhdr.rst
+++ b/Doc/library/sndhdr.rst
@@ -3,6 +3,7 @@
 
 .. module:: sndhdr
    :synopsis: Determine type of a sound file.
+   :deprecated:
 
 .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
 .. Based on comments in the module source file.
@@ -13,6 +14,9 @@
    single: A-LAW
    single: u-LAW
 
+.. deprecated:: 3.11
+   The :mod:`sndhdr` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 The :mod:`sndhdr` provides utility functions which attempt to determine the type

diff --git a/Doc/library/spwd.rst b/Doc/library/spwd.rst
index c6cad2a3c32849fba0aef2c63d0c242809e06ae7..cb31a10a52e0017a850be468b1dd8197fef9ef74 100644 (file)
--- a/Doc/library/spwd.rst
+++ b/Doc/library/spwd.rst
@@ -4,6 +4,10 @@
 .. module:: spwd
    :platform: Unix
    :synopsis: The shadow password database (getspnam() and friends).
+   :deprecated:
+
+.. deprecated:: 3.11
+   The :mod:`spwd` module is deprecated (see :pep:`594` for details).
 
 --------------
 

diff --git a/Doc/library/sunau.rst b/Doc/library/sunau.rst
index aad6f93b6bff18ebc2f431481fd4d7631ccbbbe1..cfb1257f585484b91a09b95488b9a11650e50254 100644 (file)
--- a/Doc/library/sunau.rst
+++ b/Doc/library/sunau.rst
@@ -3,11 +3,15 @@
 
 .. module:: sunau
    :synopsis: Provide an interface to the Sun AU sound format.
+   :deprecated:
 
 .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
 
 **Source code:** :source:`Lib/sunau.py`
 
+.. deprecated:: 3.11
+   The :mod:`sunau` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 The :mod:`sunau` module provides a convenient interface to the Sun AU sound

diff --git a/Doc/library/superseded.rst b/Doc/library/superseded.rst
index fd23e4d1536d389174d73707a62d90611a2be8eb..e3f9b0d37fe10bdbd9acf86a8f74d6a923108ad9 100644 (file)
--- a/Doc/library/superseded.rst
+++ b/Doc/library/superseded.rst
@@ -10,8 +10,26 @@ backwards compatibility. They have been superseded by other modules.
 
 .. toctree::
 
+   aifc.rst
    asynchat.rst
    asyncore.rst
-   smtpd.rst
+   audioop.rst
+   cgi.rst
+   cgitb.rst
+   chunk.rst
+   crypt.rst
+   imghdr.rst
    imp.rst
+   msilib.rst
+   nntplib.rst
+   nis.rst
    optparse.rst
+   ossaudiodev.rst
+   pipes.rst
+   smtpd.rst
+   sndhdr.rst
+   spwd.rst
+   sunau.rst
+   telnetlib.rst
+   uu.rst
+   xdrlib.rst

diff --git a/Doc/library/telnetlib.rst b/Doc/library/telnetlib.rst
index 48a9aea50dddd1aecdfc102ca99c9fad131aa03b..97b0a713e442238d1e73301112d48aa999acb15a 100644 (file)
--- a/Doc/library/telnetlib.rst
+++ b/Doc/library/telnetlib.rst
@@ -3,6 +3,7 @@
 
 .. module:: telnetlib
    :synopsis: Telnet client class.
+   :deprecated:
 
 .. sectionauthor:: Skip Montanaro <skip@pobox.com>
 
@@ -10,6 +11,9 @@
 
 .. index:: single: protocol; Telnet
 
+.. deprecated:: 3.11
+   The :mod:`telnetlib` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 The :mod:`telnetlib` module provides a :class:`Telnet` class that implements the

diff --git a/Doc/library/unix.rst b/Doc/library/unix.rst
index 04d4081f4a0736ed658a1c51ac9f0bca9d62b11e..4553a104d15a24d16921b856f2ae368e076e28ff 100644 (file)
--- a/Doc/library/unix.rst
+++ b/Doc/library/unix.rst
@@ -13,14 +13,10 @@ of it.  Here's an overview:
 
    posix.rst
    pwd.rst
-   spwd.rst
    grp.rst
-   crypt.rst
    termios.rst
    tty.rst
    pty.rst
    fcntl.rst
-   pipes.rst
    resource.rst
-   nis.rst
    syslog.rst

diff --git a/Doc/library/uu.rst b/Doc/library/uu.rst
index 0bc8021e1bdfc7445aaf4a5ac662ef57f90e7e63..c341bc83dcfed0aca91303c15f6728ffd6961771 100644 (file)
--- a/Doc/library/uu.rst
+++ b/Doc/library/uu.rst
@@ -3,11 +3,15 @@
 
 .. module:: uu
    :synopsis: Encode and decode files in uuencode format.
+   :deprecated:
 
 .. moduleauthor:: Lance Ellinghouse
 
 **Source code:** :source:`Lib/uu.py`
 
+.. deprecated:: 3.11
+   The :mod:`uu` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 This module encodes and decodes files in uuencode format, allowing arbitrary

diff --git a/Doc/library/windows.rst b/Doc/library/windows.rst
index b60d4e4ccf51d9c2a8a192ebb061842ce1bc6883..4d72ead12aadc7f3f6f0a6ccc8144b1715e16d52 100644 (file)
--- a/Doc/library/windows.rst
+++ b/Doc/library/windows.rst
@@ -9,7 +9,6 @@ This chapter describes modules that are only available on MS Windows platforms.
 
 .. toctree::
 
-   msilib.rst
    msvcrt.rst
    winreg.rst
    winsound.rst

diff --git a/Doc/library/xdrlib.rst b/Doc/library/xdrlib.rst
index 42a03a46754d03f0012f1660226eca4ffb863f5f..060b2e2c60df6d6cba3225f1f47dd8577e35cf58 100644 (file)
--- a/Doc/library/xdrlib.rst
+++ b/Doc/library/xdrlib.rst
@@ -3,6 +3,7 @@
 
 .. module:: xdrlib
    :synopsis: Encoders and decoders for the External Data Representation (XDR).
+   :deprecated:
 
 **Source code:** :source:`Lib/xdrlib.py`
 
@@ -10,6 +11,9 @@
    single: XDR
    single: External Data Representation
 
+.. deprecated:: 3.11
+   The :mod:`xdrlib` module is deprecated (see :pep:`594` for details).
+
 --------------
 
 The :mod:`xdrlib` module supports the External Data Representation Standard as

diff --git a/Misc/NEWS.d/next/Library/2022-03-18-13-30-40.bpo-47061.etLHK5.rst b/Misc/NEWS.d/next/Library/2022-03-18-13-30-40.bpo-47061.etLHK5.rst
new file mode 100644 (file)
index 0000000..5445089
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2022-03-18-13-30-40.bpo-47061.etLHK5.rst
@@ -0,0 +1,5 @@
+Deprecate the various modules listed by :pep:`594`:
+
+aifc, asynchat, asyncore, audioop, cgi, cgitb, chunk, crypt,
+imghdr, msilib, nntplib, nis, ossaudiodev, pipes, smtpd,
+sndhdr, spwd, sunau, telnetlib, uu, xdrlib