{{ message }}
gh-104773: PEP 594: Remove the imghdr module - #104777
Merged
Merged
Conversation
19 tasks
Member
Author
Member
|
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. |
Member
@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 |
Member
|
@encukou Is requiring Sphinx 6.2.0 for Python 3.13 okay for Red Hat? |
hugovk
self-requested a review
May 23, 2023 09:44
hugovk
reviewed
May 23, 2023
hugovk
left a comment
hugovk
left a comment
Member
There was a problem hiding this comment.
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| * :mod:`chunk` | ||
| * :mod:`crypt` | ||
| * :mod:`imghdr` | ||
| * ``imghdr`` |
Member
There was a problem hiding this comment.
Suggested change
| * ``imghdr`` | |
| * :mod:`!imghdr` |
| `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`.) |
| 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. |
Member
Yes. It's OK for Fedora. (And RHEL will follow Fedora after some time.) |
Member
We should likely prefer A |
AA-Turner
reviewed
May 23, 2023
| Removed | ||
| ======= | ||
|
|
||
| * Remove the ``imghdr`` module, deprecated in Python 3.11: use the projects |
Member
There was a problem hiding this comment.
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
reviewed
May 23, 2023
| @@ -0,0 +1,4 @@ | |||
| Remove the ``imghdr`` module, deprecated in Python 3.11: use the projects | |||
Member
There was a problem hiding this comment.
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 |
Member
|
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 |
Member
Author
|
I created issue #104818 "Require Sphinx 6.2 to build Python 3.13 documentation". I propose to discuss updating Sphinx (or not) there. |
vstinner
marked this pull request as draft
May 24, 2023 12:56
vstinner
changed the title
Member
Author
|
I rebased the PR on the main branch. |
vstinner
changed the title
vstinner
marked this pull request as ready for review
May 26, 2023 12:56
* 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.
vstinner
enabled auto-merge (squash)
May 26, 2023 13:14
hugovk
approved these changes
May 26, 2023
hugovk
left a comment
hugovk
left a comment
Member
There was a problem hiding this comment.
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.
Member
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📚 Documentation preview 📚: https://cpython-previews--104777.org.readthedocs.build/