8000 bpo-47061: document module deprecations due to PEP 594 (GH-31984) · python/cpython@9ac2de9 · GitHub
[go: up one dir, main page]
Skip to content

Navigation Menu

Sign in

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 9ac2de9

Browse files
brettcannonbrettcannon
authored
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.
1 parent d5d6251 commit 9ac2de9

27 files changed

+97
-22
lines changed

‎Doc/library/aifc.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
.. module:: aifc
55
:synopsis: Read and write audio files in AIFF or AIFC format.
6+
:deprecated:
67

78
**Source code:** :source:`Lib/aifc.py`
89

@@ -11,6 +12,10 @@
1112
single: AIFF
1213
single: AIFF-C
1314

15+
16+
.. deprecated:: 3.11
17+
The :mod:`aifc` module is deprecated (see :pep:`594` for details).
18+
1419
--------------
1520

1621
This module provides support for reading and writing AIFF and AIFF-C files.

‎Doc/library/audioop.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
.. module:: audioop
55
:synopsis: Manipulate raw audio data.
6+
:deprecated:
7+
8+
.. deprecated:: 3.11
9+
The :mod:`audioop` module is deprecated (see :pep:`594` for details).
610

711
--------------
812

‎Doc/library/cgi.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
.. module:: cgi
55
:synopsis: Helpers for running Python scripts via the Common Gateway Interface.
6+
:deprecated:
67

78
**Source code:** :source:`Lib/cgi.py`
89

@@ -14,6 +15,9 @@
1415
single: URL
1516
single: Common Gateway Interface
1617

18+
.. deprecated:: 3.11
19+
The :mod:`cgi` module is deprecated (see :pep:`594` for details).
20+
1721
--------------
1822

1923
Support module for Common Gateway Interface (CGI) scripts.

‎Doc/library/cgitb.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
.. module:: cgitb
55
:synopsis: Configurable traceback handler for CGI scripts.
6+
:deprecated:
67

78
.. moduleauthor:: Ka-Ping Yee <ping@lfw.org>
89
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
@@ -15,6 +16,9 @@
1516
single: exceptions; in CGI scripts
1617
single: tracebacks; in CGI scripts
1718

19+
.. deprecated:: 3.11
20+
The :mod:`cgitb` module is deprecated (see :pep:`594` for details).
21+
1822
--------------
1923

2024
The :mod:`cgitb` module provides a special exception handler for Python scripts.

‎Doc/library/chunk.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
.. module:: chunk
55
:synopsis: Module to read IFF chunks.
6+
:deprecated:
67

78
.. moduleauthor:: Sjoerd Mullender <sjoerd@acm.org>
89
.. sectionauthor:: Sjoerd Mullender <sjoerd@acm.org>
@@ -16,6 +17,9 @@
1617
single: Real Media File Format
1718
single: RMFF
1819

20+
.. deprecated:: 3.11
21+
The :mod:`chunk` module is deprecated (see :pep:`594` for details).
22+
1923
--------------
2024

2125
This module provides an interface for reading files that use EA IFF 85 chunks.

‎Doc/library/crypt.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
.. module:: crypt
55
:platform: Unix
66
:synopsis: The crypt() function used to check Unix passwords.
7+
:deprecated:
78

89
.. moduleauthor:: Steven D. Majewski <sdm7g@virginia.edu>
910
.. sectionauthor:: Steven D. Majewski <sdm7g@virginia.edu>
@@ -15,6 +16,9 @@
1516
single: crypt(3)
1617
pair: cipher; DES
1718

19+
.. deprecated:: 3.11
20+
The :mod:`crypt` module is deprecated (see :pep:`594` for details).
21+
1822
--------------
1923

2024
This module implements an interface to the :manpage:`crypt(3)` routine, which is

‎Doc/library/fileformats.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,4 @@ that aren't markup languages and are not related to e-mail.
1414
configparser.rst
1515
tomllib.rst
1616
netrc.rst
17-
xdrlib.rst
1817
plistlib.rst

‎Doc/library/imghdr.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,13 @@
33

44
.. module:: imghdr
55
:synopsis: Determine the type of image contained in a file or byte stream.
6+
:deprecated:
67

78
**Source code:** :source:`Lib/imghdr.py`
89

10+
.. deprecated:: 3.11
11+
The :mod:`imghdr` module is deprecated (see :pep:`594` for details).
12+
913
--------------
1014

1115
The :mod:`imghdr` module determines the type of image contained in a file or

‎Doc/library/internet.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ is currently supported on most popular platforms. Here is an overview:
2020
.. toctree::
2121

2222
webbrowser.rst
23-
cgi.rst
24-
cgitb.rst
2523
wsgiref.rst
2624
urllib.rst
2725
urllib.request.rst
@@ -33,10 +31,7 @@ is currently supported on most popular platforms. Here is an overview:
3331
ftplib.rst
3432
poplib.rst
3533
imaplib.rst
36-
nntplib.rst
3734
smtplib.rst
38-
smtpd.rst
39-
telnetlib.rst
4035
uuid.rst
4136
socketserver.rst
4237
http.server.rst

‎Doc/library/ipc.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,5 @@ The list of modules described in this chapter is:
2222
ssl.rst
2323
select.rst
2424
selectors.rst
25-
asyncore.rst
26-
asynchat.rst
2725
signal.rst
2826
mmap.rst

‎Doc/library/mm.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,5 @@ discretion of the installation. Here's an overview:
1111

1212
.. toctree::
1313

14-
audioop.rst
15-
aifc.rst
16-
sunau.rst
1714
wave.rst
18-
chunk.rst
1915
colorsys.rst
20-
imghdr.rst
21-
sndhdr.rst
22-
ossaudiodev.rst

‎Doc/library/msilib.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
.. module:: msilib
55
:platform: Windows
66
:synopsis: Creation of Microsoft Installer files, and CAB files.
7+
:deprecated:
78

89
.. moduleauthor:: Martin v. Löwis <martin@v.loewis.de>
910
.. sectionauthor:: Martin v. Löwis <martin@v.loewis.de>
@@ -12,6 +13,9 @@
1213

1314
.. index:: single: msi
1415

16+
.. deprecated:: 3.11
17+
The :mod:`msilib` module is deprecated (see :pep:`594` for details).
18+
1519
--------------
1620

1721
The :mod:`msilib` supports the creation of Microsoft Installer (``.msi``) files.

‎Doc/library/netdata.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,3 @@ on the internet.
1919
base64.rst
2020
binascii.rst
2121
quopri.rst
22-
uu.rst

‎Doc/library/nis.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@
55
.. module:: nis
66
:platform: Unix
77
:synopsis: Interface to Sun's NIS (Yellow Pages) library.
8+
:deprecated:
89

910
.. moduleauthor:: Fred Gansevles <Fred.Gansevles@cs.utwente.nl>
1011
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
1112

13+
.. deprecated:: 3.11
14+
The :mod:`nis` module is deprecated (see :pep:`594` for details).
15+
1216
--------------
1317

1418
The :mod:`nis` module gives a thin wrapper around the NIS library, useful for

‎Doc/library/nntplib.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,17 @@
33

44
.. module:: nntplib
55
:synopsis: NNTP protocol client (requires sockets).
6+
:deprecated:
67

78
**Source code:** :source:`Lib/nntplib.py`
89

910
.. index::
1011
pair: NNTP; protocol
1112
single: Network News Transfer Protocol
1213

14+
.. deprecated:: 3.11
15+
The :mod:`nntplib` module is deprecated (see :pep:`594` for details).
16+
1317
--------------
1418

1519
This module defines the class :class:`NNTP` which implements the client side of

‎Doc/library/ossaudiodev.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
.. module:: ossaudiodev
55
:platform: Linux, FreeBSD
66
:synopsis: Access to OSS-compatible audio devices.
7+
:deprecated:
8+
9+
.. deprecated:: 3.11
10+
The :mod:`ossaudiodev` module is deprecated (see :pep:`594` for details).
711

812
--------------
913

‎Doc/library/pipes.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,15 @@
44
.. module:: pipes
55
:platform: Unix
66
:synopsis: A Python interface to Unix shell pipelines.
7+
:deprecated:
78

89
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
910

1011
**Source code:** :source:`Lib/pipes.py`
1112

13+
.. deprecated:: 3.11
14+
The :mod:`pipes` module is deprecated (see :pep:`594` for details).
15+
1216
--------------
1317

1418
The :mod:`pipes` module defines a class to abstract the concept of a *pipeline*

‎Doc/library/sndhdr.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
.. module:: sndhdr
55
:synopsis: Determine type of a sound file.
6+
:deprecated:
67

78
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
89
.. Based on comments in the module source file.
@@ -13,6 +14,9 @@
1314
single: A-LAW
1415
single: u-LAW
1516

17+
.. deprecated:: 3.11
18+
The :mod:`sndhdr` module is deprecated (see :pep:`594` for details).
19+
1620
--------------
1721

1822
The :mod:`sndhdr` provides utility functions which attempt to determine the type

‎Doc/library/spwd.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
.. module:: spwd
55
:platform: Unix
66
:synopsis: The shadow password database (getspnam() and friends).
7+
:deprecated:
8+
9+
.. deprecated:: 3.11
10+
The :mod:`spwd` module is deprecated (see :pep:`594` for details).
711

812
--------------
913

‎Doc/library/sunau.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@
33

44
.. module:: sunau
55
:synopsis: Provide an interface to the Sun AU sound format.
6+
:deprecated:
67

78
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
89

910
**Source code:** :source:`Lib/sunau.py`
1011

12+
.. deprecated:: 3.11
13+
The :mod:`sunau` module is deprecated (see :pep:`594` for details).
14+
1115
--------------
1216

1317
The :mod:`sunau` module provides a convenient interface to the Sun AU sound

‎Doc/library/superseded.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,26 @@ backwards compatibility. They have been superseded by other modules.
1010

1111
.. toctree::
1212

13+
aifc.rst
1314
asynchat.rst
1415
asyncore.rst
15-
smtpd.rst
16+
audioop.rst
17+
cgi.rst
18+
cgitb.rst
19+
chunk.rst
20+
crypt.rst
21+
imghdr.rst
1622
imp.rst
23+
msilib.rst
24+
nntplib.rst
25+
nis.rst
1726
optparse.rst
27+
ossaudiodev.rst
28+
pipes.rst
29+
smtpd.rst
30+
sndhdr.rst
31+
spwd.rst
32+
sunau.rst
33+
telnetlib.rst
34+
uu.rst
35+
xdrlib.rst

‎Doc/library/telnetlib.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,17 @@
33

44
.. module:: telnetlib
55
:synopsis: Telnet client class.
6+
:deprecated:
67

78
.. sectionauthor:: Skip Montanaro <skip@pobox.com>
89

910
**Source code:** :source:`Lib/telnetlib.py`
1011

1112
.. index:: single: protocol; Telnet
1213

14+
.. deprecated:: 3.11
15+
The :mod:`telnetlib` module is deprecated (see :pep:`594` for details).
16+
1317
--------------
1418

1519
The :mod:`telnetlib` module provides a :class:`Telnet` class that implements the

‎Doc/library/unix.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,10 @@ of it. Here's an overview:
1313

1414
posix.rst
1515
pwd.rst
16-
spwd.rst
1716
grp.rst
18-
crypt.rst
1917
termios.rst
2018
tty.rst
2119
pty.rst
2220
fcntl.rst
23-
pipes.rst
2421
resource.rst
25-
nis.rst
2622
syslog.rst

‎Doc/library/uu.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@
33

44
.. module:: uu
55
:synopsis: Encode and decode files in uuencode format.
6+
:deprecated:
67

78
.. moduleauthor:: Lance Ellinghouse
89

910
**Source code:** :source:`Lib/uu.py`
1011

12+
.. deprecated:: 3.11
13+
The :mod:`uu` module is deprecated (see :pep:`594` for details).
14+
1115
--------------
1216

1317
This module encodes and decodes files in uuencode format, allowing arbitrary

‎Doc/library/windows.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ This chapter describes modules that are only available on MS Windows platforms.
99

1010
.. toctree::
1111

12-
msilib.rst
1312
msvcrt.rst
1413
winreg.rst
1514
winsound.rst

‎Doc/library/xdrlib.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,17 @@
33

44
.. module:: xdrlib
55
:synopsis: Encoders and decoders for the External Data Representation (XDR).
6+
:deprecated:
67

78
**Source code:** :source:`Lib/xdrlib.py`
89

910
.. index::
1011
single: XDR
1112
single: External Data Representation
1213

14+
.. deprecated:: 3.11
15+
The :mod:`xdrlib` module is deprecated (see :pep:`594` for details).
16+
1317
--------------
1418

1519
The :mod:`xdrlib` module supports the External Data Representation Standard as

‎Misc/NEWS.d/next/Library/2022-03-18-13-30-40.bpo-47061.etLHK5.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Deprecate the various modules listed by :pep:`594`:
2+
3+
aifc, asynchat, asyncore, audioop, cgi, cgitb, chunk, crypt,
4+
imghdr, msilib, nntplib, nis, ossaudiodev, pipes, smtpd,
5+
sndhdr, spwd, sunau, telnetlib, uu, xdrlib

0 commit comments

Comments
 (0)
0