Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-47061: document module deprecations due to PEP 594 #31984

Merged
merged 5 commits into from
Mar 21, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Doc/library/aifc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

.. module:: aifc
:synopsis: Read and write audio files in AIFF or AIFC format.
:deprecated:

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

Expand All @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions Doc/library/audioop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).

--------------

Expand Down
4 changes: 4 additions & 0 deletions Doc/library/cgi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

.. module:: cgi
:synopsis: Helpers for running Python scripts via the Common Gateway Interface.
:deprecated:

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

Expand All @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions Doc/library/cgitb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

.. module:: cgitb
:synopsis: Configurable traceback handler for CGI scripts.
:deprecated:

.. moduleauthor:: Ka-Ping Yee <[email protected]>
.. sectionauthor:: Fred L. Drake, Jr. <[email protected]>
Expand All @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions Doc/library/chunk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

.. module:: chunk
:synopsis: Module to read IFF chunks.
:deprecated:

.. moduleauthor:: Sjoerd Mullender <[email protected]>
.. sectionauthor:: Sjoerd Mullender <[email protected]>
Expand All @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions Doc/library/crypt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
.. module:: crypt
:platform: Unix
:synopsis: The crypt() function used to check Unix passwords.
:deprecated:

.. moduleauthor:: Steven D. Majewski <[email protected]>
.. sectionauthor:: Steven D. Majewski <[email protected]>
Expand All @@ -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
Expand Down
1 change: 0 additions & 1 deletion Doc/library/fileformats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions Doc/library/imghdr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 0 additions & 5 deletions Doc/library/internet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 0 additions & 2 deletions Doc/library/ipc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
7 changes: 0 additions & 7 deletions Doc/library/mm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions Doc/library/msilib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
.. module:: msilib
:platform: Windows
:synopsis: Creation of Microsoft Installer files, and CAB files.
:deprecated:

.. moduleauthor:: Martin v. Löwis <[email protected]>
.. sectionauthor:: Martin v. Löwis <[email protected]>
Expand All @@ -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.
Expand Down
1 change: 0 additions & 1 deletion Doc/library/netdata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,3 @@ on the internet.
base64.rst
binascii.rst
quopri.rst
uu.rst
4 changes: 4 additions & 0 deletions Doc/library/nis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@
.. module:: nis
:platform: Unix
:synopsis: Interface to Sun's NIS (Yellow Pages) library.
:deprecated:

.. moduleauthor:: Fred Gansevles <[email protected]>
.. sectionauthor:: Moshe Zadka <[email protected]>

.. 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
Expand Down
4 changes: 4 additions & 0 deletions Doc/library/nntplib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@

.. module:: nntplib
:synopsis: NNTP protocol client (requires sockets).
:deprecated:

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

.. index::
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
Expand Down
4 changes: 4 additions & 0 deletions Doc/library/ossaudiodev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).

--------------

Expand Down
4 changes: 4 additions & 0 deletions Doc/library/pipes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@
.. module:: pipes
:platform: Unix
:synopsis: A Python interface to Unix shell pipelines.
:deprecated:

.. sectionauthor:: Moshe Zadka <[email protected]>

**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*
Expand Down
4 changes: 4 additions & 0 deletions Doc/library/sndhdr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

.. module:: sndhdr
:synopsis: Determine type of a sound file.
:deprecated:

.. sectionauthor:: Fred L. Drake, Jr. <[email protected]>
.. Based on comments in the module source file.
Expand All @@ -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
Expand Down
4 changes: 4 additions & 0 deletions Doc/library/spwd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).

--------------

Expand Down
4 changes: 4 additions & 0 deletions Doc/library/sunau.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,15 @@

.. module:: sunau
:synopsis: Provide an interface to the Sun AU sound format.
:deprecated:

.. sectionauthor:: Moshe Zadka <[email protected]>

**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
Expand Down
20 changes: 19 additions & 1 deletion Doc/library/superseded.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions Doc/library/telnetlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@

.. module:: telnetlib
:synopsis: Telnet client class.
:deprecated:

.. sectionauthor:: Skip Montanaro <[email protected]>

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

.. 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
Expand Down
4 changes: 0 additions & 4 deletions Doc/library/unix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions Doc/library/uu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion Doc/library/windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions Doc/library/xdrlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@

.. module:: xdrlib
:synopsis: Encoders and decoders for the External Data Representation (XDR).
:deprecated:

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

.. index::
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
Expand Down
Loading