gh-104773: PEP 594: Remove the imghdr module #104777

vstinner · 2023-05-23T00:15:09Z

Remove the Lib/test/imghdrdata/ directory.
Copy 5 pictures (gif, png, ppm, pgm, xbm) from removed Lib/test/imghdrdata/ to a new Lib/test/tkinterdata/ directory.

Issue: PEP 594: Remove stdlib modules scheduled for deletion in Python 3.13 #104773

📚 Documentation preview 📚: https://cpython-previews--104777.org.readthedocs.build/

vstinner · 2023-05-23T03:16:03Z

The Docs CI job fails with:

Could not import extension sphinx.builders.epub3 (exception: No module named 'imghdr')

Oh. It seems like the Sphinx EPUB builder requires the removed imghdr module.

cc @JulienPalard @deronnax

hugovk · 2023-05-23T06:38:00Z

Sphinx used to depend on imghdr, but no longer does as of Sphinx 6.2.0:

Therefore we'll need to start using Sphinx 6.2.0 for Python 3.13.

cc @AA-Turner @CAM-Gerlach.

JulienPalard · 2023-05-23T08:03:46Z

Therefore we'll need to start using Sphinx 6.2.0 for Python 3.13.

@doko42 would it be managable from a Debian packaging point of view?

Do we have some contacts with other distribs?

I remember the last bump of needs_sphinx raised a lot of concerns.

hugovk · 2023-05-23T09:44:34Z

@encukou Is requiring Sphinx 6.2.0 for Python 3.13 okay for Red Hat?

hugovk

Avoid new Sphinx warnings:

diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
index 7a479c6e56..9b33155c5a 100644
--- a/Doc/whatsnew/3.11.rst
+++ b/Doc/whatsnew/3.11.rst
@@ -1735,7 +1735,7 @@ Modules
   +---------------------+---------------------+---------------------+---------------------+---------------------+
   | :mod:`audioop`      | :mod:`crypt`        | :mod:`nis`          | :mod:`sndhdr`       | :mod:`uu`           |
   +---------------------+---------------------+---------------------+---------------------+---------------------+
-  | :mod:`cgi`          | :mod:`imghdr`       | :mod:`nntplib`      | :mod:`spwd`         | :mod:`xdrlib`       |
+  | :mod:`cgi`          | :mod:`!imghdr`      | :mod:`nntplib`      | :mod:`spwd`         | :mod:`xdrlib`       |
   +---------------------+---------------------+---------------------+---------------------+---------------------+
   | :mod:`cgitb`        | :mod:`mailcap`      | :mod:`ossaudiodev`  | :mod:`sunau`        |                     |
   +---------------------+---------------------+---------------------+---------------------+---------------------+
diff --git a/Doc/whatsnew/3.5.rst b/Doc/whatsnew/3.5.rst
index 14b6425cea..d13036f6fd 100644
--- a/Doc/whatsnew/3.5.rst
+++ b/Doc/whatsnew/3.5.rst
@@ -1252,7 +1252,7 @@ Oberkirch in :issue:`21800`.)
 imghdr
 ------
 
-The :func:`~imghdr.what` function now recognizes the
+The :func:`!imghdr.what` function now recognizes the
 `OpenEXR <https://www.openexr.com>`_ format
 (contributed by Martin Vignali and Claudiu Popa in :issue:`20295`),
 and the `WebP <https://en.wikipedia.org/wiki/WebP>`_ format

hugovk · 2023-05-23T09:45:43Z

Doc/whatsnew/3.12.rst

@@ -809,7 +809,7 @@ Modules (see :pep:`594`):
 * :mod:`cgitb`
 * :mod:`chunk`
 * :mod:`crypt`
-* :mod:`imghdr`
+* ``imghdr``


Suggested change

* ``imghdr``

* :mod:`!imghdr`

hugovk · 2023-05-23T09:45:56Z

Doc/whatsnew/3.13.rst

+  `filetype <https://pypi.org/project/filetype/>`_,
+  `puremagic <https://pypi.org/project/puremagic/>`_,
+  or `python-magic <https://pypi.org/project/python-magic/>`_ instead.
+  (Contributed by Victor Stinner in :gh:`104773`.)


Reference the PEP.

hugovk · 2023-05-23T09:46:09Z

Misc/NEWS.d/next/Library/2023-05-23-02-13-11.gh-issue-104773.JNiEjv.rst

+Remove the ``imghdr`` module, deprecated in Python 3.11: use the projects
+`filetype <https://pypi.org/project/filetype/>`_, `puremagic
+<https://pypi.org/project/puremagic/>`_, or `python-magic
+<https://pypi.org/project/python-magic/>`_ instead. Patch by Victor Stinner.


Reference the PEP.

encukou · 2023-05-23T09:52:24Z

Is requiring Sphinx 6.2.0 for Python 3.13 okay for Red Hat?

Yes. It's OK for Fedora. (And RHEL will follow Fedora after some time.)

AA-Turner · 2023-05-23T13:28:58Z

Avoid new Sphinx warnings:

diff --git a/Doc/whatsnew/3.5.rst b/Doc/whatsnew/3.5.rst
index 14b6425cea..d13036f6fd 100644
--- a/Doc/whatsnew/3.5.rst
+++ b/Doc/whatsnew/3.5.rst
@@ -1252,7 +1252,7 @@ Oberkirch in :issue:`21800`.)
 imghdr
 ------
 
-The :func:`~imghdr.what` function now recognizes the
+The :func:`!imghdr.what` function now recognizes the
...

We should likely prefer :func:`~!imghdr.what` to keep the rendered HTML showing only what.

A

AA-Turner · 2023-05-23T13:32:13Z

Doc/whatsnew/3.13.rst

@@ -102,6 +102,11 @@ Deprecated
 Removed
 =======

+* Remove the ``imghdr`` module, deprecated in Python 3.11: use the projects


Suggested change

* Remove the ``imghdr`` module, deprecated in Python 3.11: use the projects

* Remove the :mod:`!imghdr` module, deprecated in Python 3.11: use the projects

AA-Turner · 2023-05-23T13:33:02Z

Misc/NEWS.d/next/Library/2023-05-23-02-13-11.gh-issue-104773.JNiEjv.rst

@@ -0,0 +1,4 @@
+Remove the ``imghdr`` module, deprecated in Python 3.11: use the projects


Suggested change

Remove the ``imghdr`` module, deprecated in Python 3.11: use the projects

Remove the :mod:`!imghdr` module, deprecated in Python 3.11: use the projects

AA-Turner · 2023-05-23T13:38:51Z

OpenSUSE is using Sphinx 7 for Python 3.12 builds

Debian and Ubuntu are the only remaining distributions from the list we checked last time.

A

vstinner · 2023-05-23T20:46:15Z

I created issue #104818 "Require Sphinx 6.2 to build Python 3.13 documentation". I propose to discuss updating Sphinx (or not) there.

vstinner · 2023-05-25T16:34:40Z

I rebased the PR on the main branch.

* Remove the Lib/test/imghdrdata/ directory. * Copy 5 pictures (gif, png, ppm, pgm, xbm) from removed Lib/test/imghdrdata/ to a new Lib/test/tkinterdata/ directory.

* Update Sphinx from 4.5 to 6.2 in Doc/requirements.txt.

hugovk

Looks good, we can use Sphinx 6.2 for the "normal" docs build and for doctest (both use requirements.txt), and still support 3.2 in Doc/requirements-oldest-sphinx.txt.

vstinner · 2023-05-26T13:27:36Z

Looks good, we can use Sphinx 6.2 for the "normal" docs build and for doctest (both use requirements.txt), and still support 3.2 in Doc/requirements-oldest-sphinx.txt.

Right. I only upgraded Sphinx in the GHA "Doctest" job. It seems like increasing the minimum Sphinx version to build the documentation is not strictly required to remove the imghdr module.

I prefer to decorelate the imghdr removal and increase the minimum Sphinx version to build the Python documentation. So far, still supporting Sphinx 3.2 makes it possible to build Python 3.13 documentation on Debian Stable: #104818 (comment)

bedevere-bot added the awaiting core review label May 23, 2023

bedevere-bot mentioned this pull request May 23, 2023

PEP 594: Remove stdlib modules scheduled for deletion in Python 3.13 #104773

Closed

19 tasks

hugovk self-requested a review May 23, 2023 09:44

hugovk reviewed May 23, 2023

View reviewed changes

AA-Turner reviewed May 23, 2023

View reviewed changes

vstinner mentioned this pull request May 23, 2023

Require Sphinx 6.2 to build Python 3.13 documentation #104818

Closed

vstinner marked this pull request as draft May 24, 2023 12:56

bedevere-bot removed the awaiting core review label May 24, 2023

vstinner changed the title ~~gh-104773: PEP 594: Remove the imghdr module~~ WIP (blocked by Sphinx): gh-104773: PEP 594: Remove the imghdr module May 24, 2023

vstinner force-pushed the remove_imghdr branch from e39d2ed to d2d6d86 Compare May 25, 2023 16:33

vstinner force-pushed the remove_imghdr branch from d2d6d86 to b5dd54d Compare May 26, 2023 12:55

vstinner changed the title ~~WIP (blocked by Sphinx): gh-104773: PEP 594: Remove the imghdr module~~ gh-104773: PEP 594: Remove the imghdr module May 26, 2023

vstinner marked this pull request as ready for review May 26, 2023 12:56

bedevere-bot added the awaiting core review label May 26, 2023

vstinner added 3 commits May 26, 2023 15:00

pythongh-104773: PEP 594: Remove the imghdr module

06b091c

* Remove the Lib/test/imghdrdata/ directory. * Copy 5 pictures (gif, png, ppm, pgm, xbm) from removed Lib/test/imghdrdata/ to a new Lib/test/tkinterdata/ directory.

Upgrade Sphinx

e503fbb

* Update Sphinx from 4.5 to 6.2 in Doc/requirements.txt.

Add a comment explaining Sphinx 6.2 version

7b2c914

vstinner force-pushed the remove_imghdr branch from 21ae588 to 7b2c914 Compare May 26, 2023 13:00

vstinner enabled auto-merge (squash) May 26, 2023 13:14

hugovk approved these changes May 26, 2023

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels May 26, 2023

vstinner merged commit e399f46 into python:main May 26, 2023

bedevere-bot removed the awaiting merge label May 26, 2023

vstinner deleted the remove_imghdr branch May 26, 2023 14:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-104773: PEP 594: Remove the imghdr module #104777

gh-104773: PEP 594: Remove the imghdr module #104777

vstinner commented May 23, 2023 •

edited by github-actions bot

Loading

vstinner commented May 23, 2023

hugovk commented May 23, 2023

JulienPalard commented May 23, 2023

hugovk commented May 23, 2023

hugovk left a comment

hugovk May 23, 2023

hugovk May 23, 2023

hugovk May 23, 2023

encukou commented May 23, 2023

AA-Turner commented May 23, 2023 •

edited

Loading

AA-Turner May 23, 2023

AA-Turner May 23, 2023

AA-Turner commented May 23, 2023

vstinner commented May 23, 2023

vstinner commented May 25, 2023

hugovk left a comment

vstinner commented May 26, 2023

	* Remove the ``imghdr`` module, deprecated in Python 3.11: use the projects
	* Remove the :mod:`!imghdr` module, deprecated in Python 3.11: use the projects

		@@ -0,0 +1,4 @@
		Remove the ``imghdr`` module, deprecated in Python 3.11: use the projects

	Remove the ``imghdr`` module, deprecated in Python 3.11: use the projects
	Remove the :mod:`!imghdr` module, deprecated in Python 3.11: use the projects

gh-104773: PEP 594: Remove the imghdr module #104777

gh-104773: PEP 594: Remove the imghdr module #104777

Conversation

vstinner commented May 23, 2023 • edited by github-actions bot Loading

vstinner commented May 23, 2023

hugovk commented May 23, 2023

JulienPalard commented May 23, 2023

hugovk commented May 23, 2023

hugovk left a comment

Choose a reason for hiding this comment

hugovk May 23, 2023

Choose a reason for hiding this comment

hugovk May 23, 2023

Choose a reason for hiding this comment

hugovk May 23, 2023

Choose a reason for hiding this comment

encukou commented May 23, 2023

AA-Turner commented May 23, 2023 • edited Loading

AA-Turner May 23, 2023

Choose a reason for hiding this comment

AA-Turner May 23, 2023

Choose a reason for hiding this comment

AA-Turner commented May 23, 2023

vstinner commented May 23, 2023

vstinner commented May 25, 2023

hugovk left a comment

Choose a reason for hiding this comment

vstinner commented May 26, 2023

vstinner commented May 23, 2023 •

edited by github-actions bot

Loading

AA-Turner commented May 23, 2023 •

edited

Loading