Plugin reference

BmpImagePlugin Module

class PIL.BmpImagePlugin.BmpImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

Image plugin for the Windows Bitmap format (BMP)

BITFIELDS = 3
COMPRESSIONS = {'RLE4': 2, 'JPEG': 4, 'BITFIELDS': 3, 'RAW': 0, 'RLE8': 1, 'PNG': 5}
JPEG = 4
PNG = 5
RAW = 0
RLE4 = 2
RLE8 = 1
format = 'BMP'
format_description = 'Windows Bitmap'
class PIL.BmpImagePlugin.DibImageFile(fp=None, filename=None)

Bases: PIL.BmpImagePlugin.BmpImageFile

format = 'DIB'
format_description = 'Windows Bitmap'

BufrStubImagePlugin Module

class PIL.BufrStubImagePlugin.BufrStubImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.StubImageFile

format = 'BUFR'
format_description = 'BUFR'
PIL.BufrStubImagePlugin.register_handler(handler)

Install application-specific BUFR image handler.

Parameters:handler – Handler object.

CurImagePlugin Module

class PIL.CurImagePlugin.CurImageFile(fp=None, filename=None)

Bases: PIL.BmpImagePlugin.BmpImageFile

format = 'CUR'
format_description = 'Windows Cursor'

DcxImagePlugin Module

class PIL.DcxImagePlugin.DcxImageFile(fp=None, filename=None)

Bases: PIL.PcxImagePlugin.PcxImageFile

format = 'DCX'
format_description = 'Intel DCX'
is_animated
n_frames
seek(frame)
tell()

EpsImagePlugin Module

class PIL.EpsImagePlugin.EpsImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

EPS File Parser for the Python Imaging Library

format = 'EPS'
format_description = 'Encapsulated Postscript'
load(scale=1)
load_seek(*args, **kwargs)
mode_map = {1: 'L', 2: 'LAB', 3: 'RGB', 4: 'CMYK'}
PIL.EpsImagePlugin.Ghostscript(tile, size, fp, scale=1)

Render an image using Ghostscript

class PIL.EpsImagePlugin.PSFile(fp)

Bases: object

Wrapper for bytesio object that treats either CR or LF as end of line.

readline()
seek(offset, whence=0)
PIL.EpsImagePlugin.has_ghostscript()

FitsStubImagePlugin Module

class PIL.FitsStubImagePlugin.FITSStubImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.StubImageFile

format = 'FITS'
format_description = 'FITS'
PIL.FitsStubImagePlugin.register_handler(handler)

Install application-specific FITS image handler.

Parameters:handler – Handler object.

FliImagePlugin Module

class PIL.FliImagePlugin.FliImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'FLI'
format_description = 'Autodesk FLI/FLC Animation'
is_animated
n_frames
seek(frame)
tell()

FpxImagePlugin Module

class PIL.FpxImagePlugin.FpxImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'FPX'
format_description = 'FlashPix'
load()

GbrImagePlugin Module

class PIL.GbrImagePlugin.GbrImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'GBR'
format_description = 'GIMP brush file'
load()

GifImagePlugin Module

class PIL.GifImagePlugin.GifImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

data()
format = 'GIF'
format_description = 'Compuserve GIF'
global_palette = None
is_animated
load_end()
n_frames
seek(frame)
tell()
PIL.GifImagePlugin.get_interlace(im)
PIL.GifImagePlugin.getdata(im, offset=(0, 0), **params)

Legacy Method

Return a list of strings representing this image. The first string is a local image header, the rest contains encoded image data.

Parameters:
  • im – Image object
  • offset – Tuple of (x, y) pixels. Defaults to (0,0)
  • **params

    E.g. duration or other encoder info parameters

Returns:

List of Bytes containing gif encoded frame data

PIL.GifImagePlugin.getheader(im, palette=None, info=None)

Legacy Method to get Gif data from image.

Warning:: May modify image data.

Parameters:
  • im – Image object
  • palette – bytes object containing the source palette, or ....
  • info – encoderinfo
Returns:

tuple of(list of header items, optimized palette)

GribStubImagePlugin Module

class PIL.GribStubImagePlugin.GribStubImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.StubImageFile

format = 'GRIB'
format_description = 'GRIB'
PIL.GribStubImagePlugin.register_handler(handler)

Install application-specific GRIB image handler.

Parameters:handler – Handler object.

Hdf5StubImagePlugin Module

class PIL.Hdf5StubImagePlugin.HDF5StubImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.StubImageFile

format = 'HDF5'
format_description = 'HDF5'
PIL.Hdf5StubImagePlugin.register_handler(handler)

Install application-specific HDF5 image handler.

Parameters:handler – Handler object.

IcnsImagePlugin Module

class PIL.IcnsImagePlugin.IcnsFile(fobj)

Bases: object

SIZES = {(256, 256, 1): [('ic08', <function read_png_or_jpeg2000 at 0x7f234597f5f0>)], (128, 128, 2): [('ic13', <function read_png_or_jpeg2000 at 0x7f234597f5f0>)], (64, 64, 1): [('icp6', <function read_png_or_jpeg2000 at 0x7f234597f5f0>)], (128, 128, 1): [('ic07', <function read_png_or_jpeg2000 at 0x7f234597f5f0>), ('it32', <function read_32t at 0x7f234597f488>), ('t8mk', <function read_mk at 0x7f234597f578>)], (32, 32, 1): [('icp5', <function read_png_or_jpeg2000 at 0x7f234597f5f0>), ('il32', <function read_32 at 0x7f234597f500>), ('l8mk', <function read_mk at 0x7f234597f578>)], (16, 16, 2): [('ic11', <function read_png_or_jpeg2000 at 0x7f234597f5f0>)], (512, 512, 2): [('ic10', <function read_png_or_jpeg2000 at 0x7f234597f5f0>)], (512, 512, 1): [('ic09', <function read_png_or_jpeg2000 at 0x7f234597f5f0>)], (48, 48, 1): [('ih32', <function read_32 at 0x7f234597f500>), ('h8mk', <function read_mk at 0x7f234597f578>)], (256, 256, 2): [('ic14', <function read_png_or_jpeg2000 at 0x7f234597f5f0>)], (16, 16, 1): [('icp4', <function read_png_or_jpeg2000 at 0x7f234597f5f0>), ('is32', <function read_32 at 0x7f234597f500>), ('s8mk', <function read_mk at 0x7f234597f578>)], (32, 32, 2): [('ic12', <function read_png_or_jpeg2000 at 0x7f234597f5f0>)]}
bestsize()
dataforsize(size)

Get an icon resource as {channel: array}. Note that the arrays are bottom-up like windows bitmaps and will likely need to be flipped or transposed in some way.

getimage(size=None)
itersizes()
class PIL.IcnsImagePlugin.IcnsImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

PIL image support for Mac OS .icns files. Chooses the best resolution, but will possibly load a different size image if you mutate the size attribute before calling ‘load’.

The info dictionary has a key ‘sizes’ that is a list of sizes that the icns file has.

format = 'ICNS'
format_description = 'Mac OS icns resource'
load()
PIL.IcnsImagePlugin.nextheader(fobj)
PIL.IcnsImagePlugin.read_32(fobj, start_length, size)

Read a 32bit RGB icon resource. Seems to be either uncompressed or an RLE packbits-like scheme.

PIL.IcnsImagePlugin.read_32t(fobj, start_length, size)
PIL.IcnsImagePlugin.read_mk(fobj, start_length, size)
PIL.IcnsImagePlugin.read_png_or_jpeg2000(fobj, start_length, size)

IcoImagePlugin Module

class PIL.IcoImagePlugin.IcoFile(buf)

Bases: object

frame(idx)

Get an image from frame idx

getimage(size, bpp=False)

Get an image from the icon

sizes()

Get a list of all available icon sizes and color depths.

class PIL.IcoImagePlugin.IcoImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

PIL read-only image support for Microsoft Windows .ico files.

By default the largest resolution image in the file will be loaded. This can be changed by altering the ‘size’ attribute before calling ‘load’.

The info dictionary has a key ‘sizes’ that is a list of the sizes available in the icon file.

Handles classic, XP and Vista icon formats.

This plugin is a refactored version of Win32IconImagePlugin by Bryan Davis <casadebender@gmail.com>. https://code.google.com/archive/p/casadebender/wikis/Win32IconImagePlugin.wiki

format = 'ICO'
format_description = 'Windows Icon'
load()
load_seek()

ImImagePlugin Module

class PIL.ImImagePlugin.ImImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'IM'
format_description = 'IFUNC Image Memory'
is_animated
n_frames
seek(frame)
tell()
PIL.ImImagePlugin.number(s)

ImtImagePlugin Module

class PIL.ImtImagePlugin.ImtImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'IMT'
format_description = 'IM Tools'

IptcImagePlugin Module

class PIL.IptcImagePlugin.IptcImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

field()
format = 'IPTC'
format_description = 'IPTC/NAA'
getint(key)
load()
PIL.IptcImagePlugin.dump(c)
PIL.IptcImagePlugin.getiptcinfo(im)

Get IPTC information from TIFF, JPEG, or IPTC file.

Parameters:im – An image containing IPTC data.
Returns:A dictionary containing IPTC information, or None if no IPTC information block was found.
PIL.IptcImagePlugin.i(c)

JpegImagePlugin Module

PIL.JpegImagePlugin.APP(self, marker)
PIL.JpegImagePlugin.COM(self, marker)
PIL.JpegImagePlugin.DQT(self, marker)
class PIL.JpegImagePlugin.JpegImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

draft(mode, size)
format = 'JPEG'
format_description = 'JPEG (ISO 10918)'
load_djpeg()
PIL.JpegImagePlugin.SOF(self, marker)
PIL.JpegImagePlugin.Skip(self, marker)
PIL.JpegImagePlugin.convert_dict_qtables(qtables)
PIL.JpegImagePlugin.get_sampling(im)
PIL.JpegImagePlugin.jpeg_factory(fp=None, filename=None)

Jpeg2KImagePlugin Module

class PIL.Jpeg2KImagePlugin.Jpeg2KImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'JPEG2000'
format_description = 'JPEG 2000 (ISO 15444)'
load()

McIdasImagePlugin Module

class PIL.McIdasImagePlugin.McIdasImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'MCIDAS'
format_description = 'McIdas area file'

MicImagePlugin Module

class PIL.MicImagePlugin.MicImageFile(fp=None, filename=None)

Bases: PIL.TiffImagePlugin.TiffImageFile

format = 'MIC'
format_description = 'Microsoft Image Composer'
is_animated
n_frames
seek(frame)
tell()

MpegImagePlugin Module

class PIL.MpegImagePlugin.BitStream(fp)

Bases: object

next()
peek(bits)
read(bits)
skip(bits)
class PIL.MpegImagePlugin.MpegImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'MPEG'
format_description = 'MPEG'

MspImagePlugin Module

class PIL.MspImagePlugin.MspDecoder(mode, *args)

Bases: PIL.ImageFile.PyDecoder

decode(buffer)
class PIL.MspImagePlugin.MspImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'MSP'
format_description = 'Windows Paint'

PalmImagePlugin Module

PIL.PalmImagePlugin.build_prototype_image()

PcdImagePlugin Module

class PIL.PcdImagePlugin.PcdImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'PCD'
format_description = 'Kodak PhotoCD'
load_end()

PcxImagePlugin Module

class PIL.PcxImagePlugin.PcxImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'PCX'
format_description = 'Paintbrush'

PdfImagePlugin Module

PixarImagePlugin Module

class PIL.PixarImagePlugin.PixarImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'PIXAR'
format_description = 'PIXAR raster image'

PngImagePlugin Module

PIL.PngImagePlugin.getchunks(im, **params)

Return a list of PNG chunks representing this image.

PIL.PngImagePlugin.is_cid()

match(string[, pos[, endpos]]) –> match object or None. Matches zero or more characters at the beginning of the string

PIL.PngImagePlugin.putchunk(fp, cid, *data)

Write a PNG chunk (including CRC field)

class PIL.PngImagePlugin.ChunkStream(fp)

Bases: object

call(cid, pos, length)

Call the appropriate chunk handler

close()
crc(cid, data)

Read and verify checksum

crc_skip(cid, data)

Read checksum. Used if the C module is not present

push(cid, pos, length)
read()

Fetch a new chunk. Returns header information.

verify(endchunk='IEND')
class PIL.PngImagePlugin.PngImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'PNG'
format_description = 'Portable network graphics'
load_end()

internal: finished reading image data

load_prepare()

internal: prepare to read PNG file

load_read(read_bytes)

internal: read more image data

verify()

Verify PNG file

class PIL.PngImagePlugin.PngStream(fp)

Bases: PIL.PngImagePlugin.ChunkStream

check_text_memory(chunklen)
chunk_IDAT(pos, length)
chunk_IEND(pos, length)
chunk_IHDR(pos, length)
chunk_PLTE(pos, length)
chunk_gAMA(pos, length)
chunk_iCCP(pos, length)
chunk_iTXt(pos, length)
chunk_pHYs(pos, length)
chunk_tEXt(pos, length)
chunk_tRNS(pos, length)
chunk_zTXt(pos, length)

PpmImagePlugin Module

class PIL.PpmImagePlugin.PpmImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'PPM'
format_description = 'Pbmplus image'

PsdImagePlugin Module

class PIL.PsdImagePlugin.PsdImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'PSD'
format_description = 'Adobe Photoshop'
is_animated
load_prepare()
n_frames
seek(layer)
tell()

SgiImagePlugin Module

class PIL.SgiImagePlugin.SgiImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'SGI'
format_description = 'SGI Image File Format'

SpiderImagePlugin Module

class PIL.SpiderImagePlugin.SpiderImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

convert2byte(depth=255)
format = 'SPIDER'
format_description = 'Spider 2D image'
is_animated
n_frames
seek(frame)
tell()
tkPhotoImage()
PIL.SpiderImagePlugin.isInt(f)
PIL.SpiderImagePlugin.isSpiderHeader(t)
PIL.SpiderImagePlugin.isSpiderImage(filename)
PIL.SpiderImagePlugin.loadImageSeries(filelist=None)

create a list of Image.images for use in montage

PIL.SpiderImagePlugin.makeSpiderHeader(im)

SunImagePlugin Module

class PIL.SunImagePlugin.SunImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'SUN'
format_description = 'Sun Raster File'

TgaImagePlugin Module

class PIL.TgaImagePlugin.TgaImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'TGA'
format_description = 'Targa'

TiffImagePlugin Module

class PIL.TiffImagePlugin.AppendingTiffWriter(fn, new=False)
Tags = set([288, 324, 519, 520, 521, 273])
close()
fieldSizes = [0, 1, 1, 2, 4, 8, 1, 1, 2, 4, 8, 4, 8]
finalize()
fixIFD()
fixOffsets(count, isShort=False, isLong=False)
goToEnd()
newFrame()
readLong()
readShort()
rewriteLastLong(value)
rewriteLastShort(value)
rewriteLastShortToLong(value)
seek(offset, whence)
setEndian(endian)
setup()
skipIFDs()
tell()
write(data)
writeLong(value)
writeShort(value)
class PIL.TiffImagePlugin.IFDRational(value, denominator=1)

Bases: numbers.Rational

Implements a rational class where 0/0 is a legal value to match the in the wild use of exif rationals.

e.g., DigitalZoomRatio - 0.00/0.00 indicates that no digital zoom was used

denominator
limit_rational(max_denominator)
Parameters:max_denominator – Integer, the maximum denominator value
Returns:Tuple of (numerator, denominator)
numerator
PIL.TiffImagePlugin.ImageFileDirectory

alias of ImageFileDirectory_v1

class PIL.TiffImagePlugin.ImageFileDirectory_v1(*args, **kwargs)

Bases: PIL.TiffImagePlugin.ImageFileDirectory_v2

This class represents the legacy interface to a TIFF tag directory.

Exposes a dictionary interface of the tags in the directory:

ifd = ImageFileDirectory_v1()
ifd[key] = 'Some Data'
ifd.tagtype[key] = 2
print(ifd[key])
('Some Data',)

Also contains a dictionary of tag types as read from the tiff image file, ~PIL.TiffImagePlugin.ImageFileDirectory_v1.tagtype.

Values are returned as a tuple.

Deprecated since version 3.0.0.

classmethod from_v2(original)

Returns an ImageFileDirectory_v1 instance with the same data as is contained in the original ImageFileDirectory_v2 instance.

Returns:ImageFileDirectory_v1
tagdata
tags
to_v2()

Returns an ImageFileDirectory_v2 instance with the same data as is contained in the original ImageFileDirectory_v1 instance.

Returns:ImageFileDirectory_v2
class PIL.TiffImagePlugin.ImageFileDirectory_v2(ifh='II*x00x00x00x00x00', prefix=None)

Bases: _abcoll.MutableMapping

This class represents a TIFF tag directory. To speed things up, we don’t decode tags unless they’re asked for.

Exposes a dictionary interface of the tags in the directory:

ifd = ImageFileDirectory_v2()
ifd[key] = 'Some Data'
ifd.tagtype[key] = 2
print(ifd[key])
'Some Data'

Individual values are returned as the strings or numbers, sequences are returned as tuples of the values.

The tiff metadata type of each item is stored in a dictionary of tag types in ~PIL.TiffImagePlugin.ImageFileDirectory_v2.tagtype. The types are read from a tiff file, guessed from the type added, or added manually.

Data Structures:

  • self.tagtype = {}
    • Key: numerical tiff tag number
    • Value: integer corresponding to the data type from ~PIL.TiffTags.TYPES

New in version 3.0.0.

as_dict()

Return a dictionary of the image’s tags.

Deprecated since version 3.0.0.

has_key(tag)
legacy_api
load(fp)
load_byte(data, legacy_api=True)
load_double(data, legacy_api=True)
load_float(data, legacy_api=True)
load_long(data, legacy_api=True)
load_rational(data, legacy_api=True)
load_short(data, legacy_api=True)
load_signed_byte(data, legacy_api=True)
load_signed_long(data, legacy_api=True)
load_signed_rational(data, legacy_api=True)
load_signed_short(data, legacy_api=True)
load_string(data, legacy_api=True)
load_undefined(data, legacy_api=True)
named()
Returns:dict of name|key: value

Returns the complete tag dictionary, with named tags where possible.

offset
prefix
reset()
save(fp)
write_byte(data)
write_double(*values)
write_float(*values)
write_long(*values)
write_rational(*values)
write_short(*values)
write_signed_byte(*values)
write_signed_long(*values)
write_signed_rational(*values)
write_signed_short(*values)
write_string(value)
write_undefined(value)
class PIL.TiffImagePlugin.TiffImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'TIFF'
format_description = 'Adobe TIFF'
is_animated
load()
load_end()
n_frames
seek(frame)

Select a given frame as current image

tell()

Return the current frame number

WebPImagePlugin Module

class PIL.WebPImagePlugin.WebPImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'WEBP'
format_description = 'WebP image'

WmfImagePlugin Module

class PIL.WmfImagePlugin.WmfStubImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.StubImageFile

format = 'WMF'
format_description = 'Windows Metafile'
PIL.WmfImagePlugin.register_handler(handler)

Install application-specific WMF image handler.

Parameters:handler – Handler object.

XVThumbImagePlugin Module

class PIL.XVThumbImagePlugin.XVThumbImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'XVThumb'
format_description = 'XV thumbnail image'

XbmImagePlugin Module

class PIL.XbmImagePlugin.XbmImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'XBM'
format_description = 'X11 Bitmap'

XpmImagePlugin Module

class PIL.XpmImagePlugin.XpmImageFile(fp=None, filename=None)

Bases: PIL.ImageFile.ImageFile

format = 'XPM'
format_description = 'X11 Pixel Map'
load_read(bytes)