imghdr — Determine the type of an image

Source code:Lib/imghdr.py

Deprecated since version 3.11, will be removed in version 3.13:Theimghdr module is deprecated(seePEP 594 for details and alternatives).

Theimghdr module determines the type of image contained in a file orbyte stream.

Theimghdr module defines the following function:

imghdr.what(file,h=None)

Tests the image data contained in the file named byfile, and returns astring describing the image type. If optionalh is provided, thefileargument is ignored andh is assumed to contain the byte stream to test.

Changed in version 3.6:Accepts apath-like object.

The following image types are recognized, as listed below with the return valuefromwhat():

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

New in version 3.5:Theexr andwebp formats were added.

You can extend the list of file typesimghdr can recognize by appendingto this variable:

imghdr.tests

A list of functions performing the individual tests. Each function takes twoarguments: the byte-stream and an open file-like object. Whenwhat() iscalled with a byte-stream, the file-like object will beNone.

The test function should return a string describing the image type if the testsucceeded, orNone if it failed.

Example:

>>>importimghdr>>>imghdr.what('bass.gif')'gif'