[Python-checkins] [3.9] bpo-47061: document module deprecations due to PEP 594 (GH-31984) (GH-32082)
miss-islington
webhook-mailer at python.org
Wed Mar 23 16:13:18 EDT 2022
https://github.com/python/cpython/commit/e513b8188af4d2f43ab2b96b51bc45bd4f6fd5b6
commit: e513b8188af4d2f43ab2b96b51bc45bd4f6fd5b6
branch: 3.9
author: Hugo van Kemenade <hugovk at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-03-23T13:13:08-07:00
summary:
[3.9] bpo-47061: document module deprecations due to PEP 594 (GH-31984) (GH-32082)
Also removed asynchat, asyncore, and smtpd from their respective toctree entries so they are only in the superceded subtree.
(cherry picked from commit 9ac2de922a0f783bd43b8e026e4fb70fd1888572)
Co-authored-by: Brett Cannon <brett at python.org>
Automerge-Triggered-By: GH:brettcannon
files:
A Misc/NEWS.d/next/Library/2022-03-18-13-30-40.bpo-47061.etLHK5.rst
M Doc/library/aifc.rst
M Doc/library/audioop.rst
M Doc/library/cgi.rst
M Doc/library/cgitb.rst
M Doc/library/chunk.rst
M Doc/library/crypt.rst
M Doc/library/fileformats.rst
M Doc/library/imghdr.rst
M Doc/library/internet.rst
M Doc/library/ipc.rst
M Doc/library/mm.rst
M Doc/library/msilib.rst
M Doc/library/netdata.rst
M Doc/library/nis.rst
M Doc/library/nntplib.rst
M Doc/library/ossaudiodev.rst
M Doc/library/pipes.rst
M Doc/library/sndhdr.rst
M Doc/library/spwd.rst
M Doc/library/sunau.rst
M Doc/library/superseded.rst
M Doc/library/telnetlib.rst
M Doc/library/unix.rst
M Doc/library/uu.rst
M Doc/library/windows.rst
M Doc/library/xdrlib.rst
diff --git a/Doc/library/aifc.rst b/Doc/library/aifc.rst
index 2e917cf7321b8..edb4bf86e5a0a 100644
--- 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 bad9da2ec62e5..eae206084f090 100644
--- 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 3ec919e9ccd00..80c4d8033130c 100644
--- 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 5f3a6476dd8cd..349414610bd40 100644
--- 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 at lfw.org>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake at 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 5e24df923ed21..7999420f536d7 100644
--- 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 at acm.org>
.. sectionauthor:: Sjoerd Mullender <sjoerd at 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 d25c626a17585..73df87ca0db8d 100644
--- 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 at virginia.edu>
.. sectionauthor:: Steven D. Majewski <sdm7g at 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 e9c2e1fbbdf3e..7b33b3364572d 100644
--- a/Doc/library/fileformats.rst
+++ b/Doc/library/fileformats.rst
@@ -13,5 +13,4 @@ that aren't markup languages and are not related to e-mail.
csv.rst
configparser.rst
netrc.rst
- xdrlib.rst
plistlib.rst
diff --git a/Doc/library/imghdr.rst b/Doc/library/imghdr.rst
index 800e919599d9c..f63a0fa56fd26 100644
--- 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 b8950bb6cb8c2..c8bab2a5836ad 100644
--- 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 b88a174eb97f1..4849c82f317d9 100644
--- 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 c8f79c4de1cdf..cd06e9385a261 100644
--- 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 83b3d4973bf0d..5ce18a1f75fc2 100644
--- 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 at v.loewis.de>
.. sectionauthor:: Martin v. Löwis <martin at 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 491501665e3d7..8a3ad68753a53 100644
--- a/Doc/library/netdata.rst
+++ b/Doc/library/netdata.rst
@@ -20,4 +20,3 @@ on the Internet.
binhex.rst
binascii.rst
quopri.rst
- uu.rst
diff --git a/Doc/library/nis.rst b/Doc/library/nis.rst
index 10c67cbb81b2f..f6b6ea83946b0 100644
--- 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 at cs.utwente.nl>
.. sectionauthor:: Moshe Zadka <moshez at 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 e7ec9047e015e..2a996e451bf7c 100644
--- 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 a7d3dac363cdf..e0f0a6b8259e4 100644
--- 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 0a22da1f555bc..25f808566ecf9 100644
--- 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 at 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 6bfa9a9fd210b..41bce18b9cd84 100644
--- 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 at 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 c6cad2a3c3284..cb31a10a52e00 100644
--- 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 aad6f93b6bff1..cfb1257f58548 100644
--- 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 at 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 fd23e4d1536d3..e3f9b0d37fe10 100644
--- 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 48a9aea50dddd..97b0a713e4422 100644
--- 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 at 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 04d4081f4a073..4553a104d15a2 100644
--- 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 0bc8021e1bdfc..c341bc83dcfed 100644
--- 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 b60d4e4ccf51d..4d72ead12aadc 100644
--- 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 42a03a46754d0..060b2e2c60df6 100644
--- 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
index 0000000000000..5445089e53c39
--- /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
More information about the Python-checkins
mailing list