Skip to content

Commit

Permalink
Docs: re-create pages for removed modules to document their removal. (p…
Browse files Browse the repository at this point in the history
…ythonGH-126622)

Will also need to change the redirects that were created here:
https://github.com/python/psf-salt/pull/521/files
(cherry picked from commit 036930d)

Co-authored-by: Ned Batchelder <[email protected]>
  • Loading branch information
nedbat authored and miss-islington committed Nov 12, 2024
1 parent e5e70c5 commit 5919d00
Show file tree
Hide file tree
Showing 28 changed files with 451 additions and 0 deletions.
15 changes: 15 additions & 0 deletions Doc/library/aifc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:mod:`!aifc` --- Read and write AIFF and AIFC files
===================================================

.. module:: aifc
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

The last version of Python that provided the :mod:`!aifc` module was
`Python 3.12 <https://docs.python.org/3.12/library/aifc.html>`_.
17 changes: 17 additions & 0 deletions Doc/library/asynchat.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
:mod:`!asynchat` --- Asynchronous socket command/response handler
=================================================================

.. module:: asynchat
:synopsis: Removed in 3.12.
:deprecated:

.. deprecated-removed:: 3.6 3.12

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.12 <whatsnew312-removed>` after
being deprecated in Python 3.6. The removal was decided in :pep:`594`.

Applications should use the :mod:`asyncio` module instead.

The last version of Python that provided the :mod:`!asynchat` module was
`Python 3.11 <https://docs.python.org/3.11/library/asynchat.html>`_.
17 changes: 17 additions & 0 deletions Doc/library/asyncore.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
:mod:`!asyncore` --- Asynchronous socket handler
================================================

.. module:: asyncore
:synopsis: Removed in 3.12.
:deprecated:

.. deprecated-removed:: 3.6 3.12

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.12 <whatsnew312-removed>` after
being deprecated in Python 3.6. The removal was decided in :pep:`594`.

Applications should use the :mod:`asyncio` module instead.

The last version of Python that provided the :mod:`!asyncore` module was
`Python 3.11 <https://docs.python.org/3.11/library/asyncore.html>`_.
15 changes: 15 additions & 0 deletions Doc/library/audioop.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:mod:`!audioop` --- Manipulate raw audio data
=============================================

.. module:: audioop
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

The last version of Python that provided the :mod:`!audioop` module was
`Python 3.12 <https://docs.python.org/3.12/library/audioop.html>`_.
19 changes: 19 additions & 0 deletions Doc/library/cgi.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
:mod:`!cgi` --- Common Gateway Interface support
================================================

.. module:: cgi
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

A fork of the module on PyPI can be used instead: :pypi:`legacy-cgi`.
This is a copy of the cgi module, no longer maintained or supported by the core
Python team.

The last version of Python that provided the :mod:`!cgi` module was
`Python 3.12 <https://docs.python.org/3.12/library/cgi.html>`_.
19 changes: 19 additions & 0 deletions Doc/library/cgitb.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
:mod:`!cgitb` --- Traceback manager for CGI scripts
===================================================

.. module:: cgitb
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

A fork of the module on PyPI can now be used instead: :pypi:`legacy-cgi`.
This is a copy of the cgi module, no longer maintained or supported by the core
Python team.

The last version of Python that provided the :mod:`!cgitb` module was
`Python 3.12 <https://docs.python.org/3.12/library/cgitb.html>`_.
15 changes: 15 additions & 0 deletions Doc/library/chunk.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:mod:`!chunk` --- Read IFF chunked data
=======================================

.. module:: chunk
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

The last version of Python that provided the :mod:`!chunk` module was
`Python 3.12 <https://docs.python.org/3.12/library/chunk.html>`_.
20 changes: 20 additions & 0 deletions Doc/library/crypt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
:mod:`!crypt` --- Function to check Unix passwords
==================================================

.. module:: crypt
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

Applications can use the :mod:`hashlib` module from the standard library.
Other possible replacements are third-party libraries from PyPI:
:pypi:`legacycrypt`, :pypi:`bcrypt`, :pypi:`argon2-cffi`, or :pypi:`passlib`.
These are not supported or maintained by the Python core team.

The last version of Python that provided the :mod:`!crypt` module was
`Python 3.12 <https://docs.python.org/3.12/library/crypt.html>`_.
17 changes: 17 additions & 0 deletions Doc/library/distutils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
:mod:`!distutils` --- Building and installing Python modules
============================================================

.. module:: distutils
:synopsis: Removed in 3.12.
:deprecated:

.. deprecated-removed:: 3.10 3.12

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.12 <whatsnew312-removed-distutils>` after
being deprecated in Python 3.10. The removal was decided in :pep:`632`,
which has `migration advice
<https://peps.python.org/pep-0632/#migration-advice>`_.

The last version of Python that provided the :mod:`!distutils` module was
`Python 3.11 <https://docs.python.org/3.11/library/distutils.html>`_.
19 changes: 19 additions & 0 deletions Doc/library/imghdr.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
:mod:`!imghdr` --- Determine the type of an image
=================================================

.. module:: imghdr
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

Possible replacements are third-party libraries from PyPI:
:pypi:`filetype`, :pypi:`puremagic`, or :pypi:`python-magic`.
These are not supported or maintained by the Python core team.

The last version of Python that provided the :mod:`!imghdr` module was
`Python 3.12 <https://docs.python.org/3.12/library/imghdr.html>`_.
18 changes: 18 additions & 0 deletions Doc/library/imp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
:mod:`!imp` --- Access the import internals
===========================================

.. module:: imp
:synopsis: Removed in 3.12.
:deprecated:

.. deprecated-removed:: 3.4 3.12

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.12 <whatsnew312-removed-imp>` after
being deprecated in Python 3.4.

The :ref:`removal notice <whatsnew312-removed-imp>` includes guidance for
migrating code from :mod:`!imp` to :mod:`importlib`.

The last version of Python that provided the :mod:`!imp` module was
`Python 3.11 <https://docs.python.org/3.11/library/imp.html>`_.
1 change: 1 addition & 0 deletions Doc/library/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,5 @@ the `Python Package Index <https://pypi.org>`_.
unix.rst
cmdline.rst
superseded.rst
removed.rst
security_warnings.rst
15 changes: 15 additions & 0 deletions Doc/library/mailcap.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:mod:`!mailcap` --- Mailcap file handling
=========================================

.. module:: mailcap
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

The last version of Python that provided the :mod:`!mailcap` module was
`Python 3.12 <https://docs.python.org/3.12/library/mailcap.html>`_.
15 changes: 15 additions & 0 deletions Doc/library/msilib.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:mod:`!msilib` --- Read and write Microsoft Installer files
===========================================================

.. module:: msilib
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

The last version of Python that provided the :mod:`!msilib` module was
`Python 3.12 <https://docs.python.org/3.12/library/msilib.html>`_.
15 changes: 15 additions & 0 deletions Doc/library/nis.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:mod:`!nis` --- Interface to Sun’s NIS (Yellow Pages)
=====================================================

.. module:: nis
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

The last version of Python that provided the :mod:`!nis` module was
`Python 3.12 <https://docs.python.org/3.12/library/nis.html>`_.
15 changes: 15 additions & 0 deletions Doc/library/nntplib.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:mod:`!nntplib` --- NNTP protocol client
========================================

.. module:: nntplib
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

The last version of Python that provided the :mod:`!nntplib` module was
`Python 3.12 <https://docs.python.org/3.12/library/nntplib.html>`_.
15 changes: 15 additions & 0 deletions Doc/library/ossaudiodev.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:mod:`!ossaudiodev` --- Access to OSS-compatible audio devices
==============================================================

.. module:: ossaudiodev
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

The last version of Python that provided the :mod:`!ossaudiodev` module was
`Python 3.12 <https://docs.python.org/3.12/library/ossaudiodev.html>`_.
17 changes: 17 additions & 0 deletions Doc/library/pipes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
:mod:`!pipes` --- Interface to shell pipelines
==============================================

.. module:: pipes
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

Applications should use the :mod:`subprocess` module instead.

The last version of Python that provided the :mod:`!pipes` module was
`Python 3.12 <https://docs.python.org/3.12/library/pipes.html>`_.
39 changes: 39 additions & 0 deletions Doc/library/removed.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
:tocdepth: 1

.. _removed:

***************
Removed Modules
***************

The modules described in this chapter have been removed from the Python
standard library. They are documented here to help people find replacements.


.. toctree::
:maxdepth: 1

aifc.rst
asynchat.rst
asyncore.rst
audioop.rst
cgi.rst
cgitb.rst
chunk.rst
crypt.rst
distutils.rst
imghdr.rst
imp.rst
mailcap.rst
msilib.rst
nis.rst
nntplib.rst
ossaudiodev.rst
pipes.rst
smtpd.rst
sndhdr.rst
spwd.rst
sunau.rst
telnetlib.rst
uu.rst
xdrlib.rst
18 changes: 18 additions & 0 deletions Doc/library/smtpd.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
:mod:`!smtpd` --- SMTP Server
=============================

.. module:: smtpd
:synopsis: Removed in 3.12.
:deprecated:

.. deprecated-removed:: 3.6 3.12

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.12 <whatsnew312-removed>` after
being deprecated in Python 3.6. The removal was decided in :pep:`594`.

A possible replacement is the third-party :pypi:`aiosmtpd` library. This
library is not maintained or supported by the Python core team.

The last version of Python that provided the :mod:`!smtpd` module was
`Python 3.11 <https://docs.python.org/3.11/library/smtpd.html>`_.
19 changes: 19 additions & 0 deletions Doc/library/sndhdr.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
:mod:`!sndhdr` --- Determine type of sound file
===============================================

.. module:: sndhdr
:synopsis: Removed in 3.13.
:deprecated:

.. deprecated-removed:: 3.11 3.13

This module is no longer part of the Python standard library.
It was :ref:`removed in Python 3.13 <whatsnew313-pep594>` after
being deprecated in Python 3.11. The removal was decided in :pep:`594`.

Possible replacements are third-party modules from PyPI:
:pypi:`filetype`, :pypi:`puremagic`, or :pypi:`python-magic`.
These are not supported or maintained by the Python core team.

The last version of Python that provided the :mod:`!sndhdr` module was
`Python 3.12 <https://docs.python.org/3.12/library/sndhdr.html>`_.
Loading

0 comments on commit 5919d00

Please sign in to comment.