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

[3.12] Docs: re-create pages for removed modules to document their removal, based on GH-126622 #126781

Merged
merged 1 commit into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
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>`_.
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>`_.
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
20 changes: 20 additions & 0 deletions Doc/library/removed.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
: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

asynchat.rst
asyncore.rst
distutils.rst
imp.rst
smtpd.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>`_.
6 changes: 6 additions & 0 deletions Doc/whatsnew/3.12.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1352,6 +1352,8 @@ Deprecated

.. include:: ../deprecations/pending-removal-in-future.rst

.. _whatsnew312-removed:

Removed
=======

Expand All @@ -1377,6 +1379,8 @@ configparser
* :class:`configparser.ConfigParser` no longer has a ``readfp`` method.
Use :meth:`~configparser.ConfigParser.read_file` instead.

.. _whatsnew312-removed-distutils:

distutils
---------

Expand Down Expand Up @@ -1458,6 +1462,8 @@ importlib
* ``importlib.abc.Finder``, ``pkgutil.ImpImporter``, and ``pkgutil.ImpLoader``
have been removed. (Contributed by Barry Warsaw in :gh:`98040`.)

.. _whatsnew312-removed-imp:

imp
---

Expand Down
Loading