summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2023-05-26 13:29:45 (GMT)
committerGitHub <noreply@github.com>2023-05-26 13:29:45 (GMT)
commite399f46a77263621610b350453e0f50252c6dc08 (patch)
treec90da37d75dffaba32a031488c406fea1d7db022 /Doc/library
parentba73473f4c18ba4cf7ab18d84d94a47d2d37a0c5 (diff)
downloadcpython-e399f46a77263621610b350453e0f50252c6dc08.zip
cpython-e399f46a77263621610b350453e0f50252c6dc08.tar.gz
cpython-e399f46a77263621610b350453e0f50252c6dc08.tar.bz2
gh-104773: PEP 594: Remove the imghdr module (#104777)
* 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.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/imghdr.rst86
-rw-r--r--Doc/library/superseded.rst1
2 files changed, 0 insertions, 87 deletions
diff --git a/Doc/library/imghdr.rst b/Doc/library/imghdr.rst
deleted file mode 100644
index 630fd70..0000000
--- a/Doc/library/imghdr.rst
+++ /dev/null
@@ -1,86 +0,0 @@
-:mod:`imghdr` --- Determine the type of an image
-================================================
-
-.. module:: imghdr
- :synopsis: Determine the type of image contained in a file or byte stream.
- :deprecated:
-
-**Source code:** :source:`Lib/imghdr.py`
-
-.. deprecated-removed:: 3.11 3.13
- The :mod:`imghdr` module is deprecated
- (see :pep:`PEP 594 <594#imghdr>` for details and alternatives).
-
---------------
-
-The :mod:`imghdr` module determines the type of image contained in a file or
-byte stream.
-
-The :mod:`imghdr` module defines the following function:
-
-
-.. function:: what(file, h=None)
-
- Test the image data contained in the file named *file* and return a
- string describing the image type. If *h* is provided, the *file*
- argument is ignored and *h* is assumed to contain the byte stream to test.
-
- .. versionchanged:: 3.6
- Accepts a :term:`path-like object`.
-
-The following image types are recognized, as listed below with the return value
-from :func:`what`:
-
-+------------+-----------------------------------+
-| Value | Image format |
-+============+===================================+
-| ``'rgb'`` | SGI ImgLib Files |
-+------------+-----------------------------------+
-| ``'gif'`` | GIF 87a and 89a Files |
-+------------+-----------------------------------+
-| ``'pbm'`` | Portable Bitmap Files |
-+------------+-----------------------------------+
-| ``'pgm'`` | Portable Graymap Files |
-+------------+-----------------------------------+
-| ``'ppm'`` | Portable Pixmap Files |
-+------------+-----------------------------------+
-| ``'tiff'`` | TIFF Files |
-+------------+-----------------------------------+
-| ``'rast'`` | Sun Raster Files |
-+------------+-----------------------------------+
-| ``'xbm'`` | X Bitmap Files |
-+------------+-----------------------------------+
-| ``'jpeg'`` | JPEG data in JFIF or Exif formats |
-+------------+-----------------------------------+
-| ``'bmp'`` | BMP files |
-+------------+-----------------------------------+
-| ``'png'`` | Portable Network Graphics |
-+------------+-----------------------------------+
-| ``'webp'`` | WebP files |
-+------------+-----------------------------------+
-| ``'exr'`` | OpenEXR Files |
-+------------+-----------------------------------+
-
-.. versionadded:: 3.5
- The *exr* and *webp* formats were added.
-
-
-You can extend the list of file types :mod:`imghdr` can recognize by appending
-to this variable:
-
-
-.. data:: tests
-
- A list of functions performing the individual tests. Each function takes two
- arguments: the byte-stream and an open file-like object. When :func:`what` is
- called with a byte-stream, the file-like object will be ``None``.
-
- The test function should return a string describing the image type if the test
- succeeded, or ``None`` if it failed.
-
-Example::
-
- >>> import imghdr
- >>> imghdr.what('bass.gif')
- 'gif'
-
diff --git a/Doc/library/superseded.rst b/Doc/library/superseded.rst
index 24e7411..bd17039 100644
--- a/Doc/library/superseded.rst
+++ b/Doc/library/superseded.rst
@@ -10,5 +10,4 @@ backwards compatibility. They have been superseded by other modules.
.. toctree::
- imghdr.rst
optparse.rst