]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] Docs: re-create pages for removed modules to document their removal, based...
authorNed Batchelder <ned@nedbatchelder.com>
Thu, 14 Nov 2024 00:02:09 +0000 (19:02 -0500)
committerGitHub <noreply@github.com>
Thu, 14 Nov 2024 00:02:09 +0000 (19:02 -0500)
[3.12] Docs: re-create pages for removed modules to document their removal, based on #126622

Doc/library/asynchat.rst [new file with mode: 0644]
Doc/library/asyncore.rst [new file with mode: 0644]
Doc/library/distutils.rst [new file with mode: 0644]
Doc/library/imp.rst [new file with mode: 0644]
Doc/library/index.rst
Doc/library/removed.rst [new file with mode: 0644]
Doc/library/smtpd.rst [new file with mode: 0644]
Doc/whatsnew/3.12.rst

diff --git a/Doc/library/asynchat.rst b/Doc/library/asynchat.rst
new file mode 100644 (file)
index 0000000..5e5c3a9
--- /dev/null
@@ -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>`_.
diff --git a/Doc/library/asyncore.rst b/Doc/library/asyncore.rst
new file mode 100644 (file)
index 0000000..22c9881
--- /dev/null
@@ -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>`_.
diff --git a/Doc/library/distutils.rst b/Doc/library/distutils.rst
new file mode 100644 (file)
index 0000000..af63e03
--- /dev/null
@@ -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>`_.
diff --git a/Doc/library/imp.rst b/Doc/library/imp.rst
new file mode 100644 (file)
index 0000000..3dc4c56
--- /dev/null
@@ -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>`_.
index 0b348ae6f5c8c0af9de243e142dda8b02fd3a7c9..951fbcf13fbb139dc8b50860cb5806f826e6436a 100644 (file)
@@ -75,4 +75,5 @@ the `Python Package Index <https://pypi.org>`_.
    unix.rst
    cmdline.rst
    superseded.rst
+   removed.rst
    security_warnings.rst
diff --git a/Doc/library/removed.rst b/Doc/library/removed.rst
new file mode 100644 (file)
index 0000000..4aafb08
--- /dev/null
@@ -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
diff --git a/Doc/library/smtpd.rst b/Doc/library/smtpd.rst
new file mode 100644 (file)
index 0000000..c704f4a
--- /dev/null
@@ -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>`_.
index e9b5499155dd1bcbd928cc4086fac23ad098e9ab..5cfbe12ab1f66658969f3bcf363fa8e59077d364 100644 (file)
@@ -1352,6 +1352,8 @@ Deprecated
 
 .. include:: ../deprecations/pending-removal-in-future.rst
 
+.. _whatsnew312-removed:
+
 Removed
 =======
 
@@ -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
 ---------
 
@@ -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
 ---