Plugin reference¶

`BmpImagePlugin` Module¶

class PIL.BmpImagePlugin.BmpImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

Image plugin for the Windows Bitmap format (BMP)

BITFIELDS = 3¶

COMPRESSIONS = {'BITFIELDS': 3, 'JPEG': 4, 'PNG': 5, 'RAW': 0, 'RLE4': 2, 'RLE8': 1}¶

JPEG = 4¶

PNG = 5¶

RAW = 0¶

RLE4 = 2¶

RLE8 = 1¶

format = 'BMP'¶

format_description = 'Windows Bitmap'¶

class PIL.BmpImagePlugin.DibImageFile(fp=None, filename=None)[source]¶

Bases: PIL.BmpImagePlugin.BmpImageFile

format = 'DIB'¶

format_description = 'Windows Bitmap'¶

`BufrStubImagePlugin` Module¶

class PIL.BufrStubImagePlugin.BufrStubImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.StubImageFile

format = 'BUFR'¶

format_description = 'BUFR'¶

PIL.BufrStubImagePlugin.register_handler(handler)[source]¶

Install application-specific BUFR image handler.

Parameters:	handler – Handler object.

`CurImagePlugin` Module¶

class PIL.CurImagePlugin.CurImageFile(fp=None, filename=None)[source]¶

Bases: PIL.BmpImagePlugin.BmpImageFile

format = 'CUR'¶

format_description = 'Windows Cursor'¶

`DcxImagePlugin` Module¶

class PIL.DcxImagePlugin.DcxImageFile(fp=None, filename=None)[source]¶

Bases: PIL.PcxImagePlugin.PcxImageFile

format = 'DCX'¶

format_description = 'Intel DCX'¶

is_animated¶

n_frames¶

seek(frame)[source]¶

Seeks to the given frame in this sequence file. If you seek beyond the end of the sequence, the method raises an EOFError exception. When a sequence file is opened, the library automatically seeks to frame 0.

See tell().

Parameters:	frame – Frame number, starting at 0.
Raises:	EOFError – If the call attempts to seek beyond the end of the sequence.

tell()[source]¶

Returns the current frame number. See seek().

Returns:	Frame number, starting with 0.

`EpsImagePlugin` Module¶

class PIL.EpsImagePlugin.EpsImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

EPS File Parser for the Python Imaging Library

format = 'EPS'¶

format_description = 'Encapsulated Postscript'¶

load(scale=1)[source]¶: Load image data based on tile list

load_seek(*args, **kwargs)[source]¶

mode_map = {1: 'L', 2: 'LAB', 3: 'RGB', 4: 'CMYK'}¶

PIL.EpsImagePlugin.Ghostscript(tile, size, fp, scale=1)[source]¶: Render an image using Ghostscript

class PIL.EpsImagePlugin.PSFile(fp)[source]¶

Bases: object

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

readline()[source]¶

seek(offset, whence=0)[source]¶

PIL.EpsImagePlugin.has_ghostscript()[source]¶

`FitsStubImagePlugin` Module¶

class PIL.FitsStubImagePlugin.FITSStubImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.StubImageFile

format = 'FITS'¶

format_description = 'FITS'¶

PIL.FitsStubImagePlugin.register_handler(handler)[source]¶

Install application-specific FITS image handler.

Parameters:	handler – Handler object.

`FliImagePlugin` Module¶

class PIL.FliImagePlugin.FliImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'FLI'¶

format_description = 'Autodesk FLI/FLC Animation'¶

is_animated¶

n_frames¶

seek(frame)[source]¶

Seeks to the given frame in this sequence file. If you seek beyond the end of the sequence, the method raises an EOFError exception. When a sequence file is opened, the library automatically seeks to frame 0.

See tell().

Parameters:	frame – Frame number, starting at 0.
Raises:	EOFError – If the call attempts to seek beyond the end of the sequence.

tell()[source]¶

Returns the current frame number. See seek().

Returns:	Frame number, starting with 0.

`FpxImagePlugin` Module¶

class PIL.FpxImagePlugin.FpxImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'FPX'¶

format_description = 'FlashPix'¶

load()[source]¶: Load image data based on tile list

`GbrImagePlugin` Module¶

class PIL.GbrImagePlugin.GbrImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'GBR'¶

format_description = 'GIMP brush file'¶

load()[source]¶: Load image data based on tile list

`GifImagePlugin` Module¶

class PIL.GifImagePlugin.GifImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

data()[source]¶

format = 'GIF'¶

format_description = 'Compuserve GIF'¶

global_palette = None¶

is_animated¶

load_end()[source]¶

n_frames¶

seek(frame)[source]¶

Seeks to the given frame in this sequence file. If you seek beyond the end of the sequence, the method raises an EOFError exception. When a sequence file is opened, the library automatically seeks to frame 0.

See tell().

Parameters:	frame – Frame number, starting at 0.
Raises:	EOFError – If the call attempts to seek beyond the end of the sequence.

tell()[source]¶

Returns the current frame number. See seek().

Returns:	Frame number, starting with 0.

PIL.GifImagePlugin.get_interlace(im)[source]¶

PIL.GifImagePlugin.getdata(im, offset=(0, 0), **params)[source]¶

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)[source]¶

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)[source]¶

Bases: PIL.ImageFile.StubImageFile

format = 'GRIB'¶

format_description = 'GRIB'¶

PIL.GribStubImagePlugin.register_handler(handler)[source]¶

Install application-specific GRIB image handler.

Parameters:	handler – Handler object.

`Hdf5StubImagePlugin` Module¶

class PIL.Hdf5StubImagePlugin.HDF5StubImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.StubImageFile

format = 'HDF5'¶

format_description = 'HDF5'¶

PIL.Hdf5StubImagePlugin.register_handler(handler)[source]¶

Install application-specific HDF5 image handler.

Parameters:	handler – Handler object.

`IcnsImagePlugin` Module¶

class PIL.IcnsImagePlugin.IcnsFile(fobj)[source]¶

Bases: object

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

bestsize()[source]¶

dataforsize(size)[source]¶: 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)[source]¶

itersizes()[source]¶

class PIL.IcnsImagePlugin.IcnsImageFile(fp=None, filename=None)[source]¶

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()[source]¶: Load image data based on tile list

size¶

PIL.IcnsImagePlugin.nextheader(fobj)[source]¶

PIL.IcnsImagePlugin.read_32(fobj, start_length, size)[source]¶: 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)[source]¶

PIL.IcnsImagePlugin.read_mk(fobj, start_length, size)[source]¶

PIL.IcnsImagePlugin.read_png_or_jpeg2000(fobj, start_length, size)[source]¶

`IcoImagePlugin` Module¶

class PIL.IcoImagePlugin.IcoFile(buf)[source]¶

Bases: object

frame(idx)[source]¶: Get an image from frame idx

getimage(size, bpp=False)[source]¶: Get an image from the icon

sizes()[source]¶: Get a list of all available icon sizes and color depths.

class PIL.IcoImagePlugin.IcoImageFile(fp=None, filename=None)[source]¶

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()[source]¶: Load image data based on tile list

load_seek()[source]¶

size¶

`ImImagePlugin` Module¶

class PIL.ImImagePlugin.ImImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'IM'¶

format_description = 'IFUNC Image Memory'¶

is_animated¶

n_frames¶

seek(frame)[source]¶

Seeks to the given frame in this sequence file. If you seek beyond the end of the sequence, the method raises an EOFError exception. When a sequence file is opened, the library automatically seeks to frame 0.

See tell().

Parameters:	frame – Frame number, starting at 0.
Raises:	EOFError – If the call attempts to seek beyond the end of the sequence.

tell()[source]¶

Returns the current frame number. See seek().

Returns:	Frame number, starting with 0.

PIL.ImImagePlugin.number(s)[source]¶

`ImtImagePlugin` Module¶

class PIL.ImtImagePlugin.ImtImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'IMT'¶

format_description = 'IM Tools'¶

`IptcImagePlugin` Module¶

class PIL.IptcImagePlugin.IptcImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

field()[source]¶

format = 'IPTC'¶

format_description = 'IPTC/NAA'¶

getint(key)[source]¶

load()[source]¶: Load image data based on tile list

PIL.IptcImagePlugin.dump(c)[source]¶

PIL.IptcImagePlugin.getiptcinfo(im)[source]¶

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)[source]¶

`JpegImagePlugin` Module¶

PIL.JpegImagePlugin.APP(self, marker)[source]¶

PIL.JpegImagePlugin.COM(self, marker)[source]¶

PIL.JpegImagePlugin.DQT(self, marker)[source]¶

class PIL.JpegImagePlugin.JpegImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

draft(mode, size)[source]¶: Set draft mode

format = 'JPEG'¶

format_description = 'JPEG (ISO 10918)'¶

load_djpeg()[source]¶

load_read(read_bytes)[source]¶: internal: read more image data For premature EOF and LOAD_TRUNCATED_IMAGES adds EOI marker so libjpeg can finish decoding

PIL.JpegImagePlugin.SOF(self, marker)[source]¶

PIL.JpegImagePlugin.Skip(self, marker)[source]¶

PIL.JpegImagePlugin.convert_dict_qtables(qtables)[source]¶

PIL.JpegImagePlugin.get_sampling(im)[source]¶

PIL.JpegImagePlugin.jpeg_factory(fp=None, filename=None)[source]¶

`Jpeg2KImagePlugin` Module¶

class PIL.Jpeg2KImagePlugin.Jpeg2KImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'JPEG2000'¶

format_description = 'JPEG 2000 (ISO 15444)'¶

load()[source]¶: Load image data based on tile list

`McIdasImagePlugin` Module¶

class PIL.McIdasImagePlugin.McIdasImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'MCIDAS'¶

format_description = 'McIdas area file'¶

`MicImagePlugin` Module¶

class PIL.MicImagePlugin.MicImageFile(fp=None, filename=None)[source]¶

Bases: PIL.TiffImagePlugin.TiffImageFile

format = 'MIC'¶

format_description = 'Microsoft Image Composer'¶

is_animated¶

n_frames¶

seek(frame)[source]¶: Select a given frame as current image

tell()[source]¶: Return the current frame number

`MpegImagePlugin` Module¶

class PIL.MpegImagePlugin.BitStream(fp)[source]¶

Bases: object

next()[source]¶

peek(bits)[source]¶

read(bits)[source]¶

skip(bits)[source]¶

class PIL.MpegImagePlugin.MpegImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'MPEG'¶

format_description = 'MPEG'¶

`MspImagePlugin` Module¶

class PIL.MspImagePlugin.MspDecoder(mode, *args)[source]¶

Bases: PIL.ImageFile.PyDecoder

decode(buffer)[source]¶

Override to perform the decoding process.

Parameters:	buffer – A bytes object with the data to be decoded.
Returns:	A tuple of (bytes consumed, errcode). If finished with decoding return <0 for the bytes consumed. Err codes are from ERRORS

class PIL.MspImagePlugin.MspImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'MSP'¶

format_description = 'Windows Paint'¶

`PalmImagePlugin` Module¶

PIL.PalmImagePlugin.build_prototype_image()[source]¶

`PcdImagePlugin` Module¶

class PIL.PcdImagePlugin.PcdImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'PCD'¶

format_description = 'Kodak PhotoCD'¶

load_end()[source]¶

`PcxImagePlugin` Module¶

class PIL.PcxImagePlugin.PcxImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'PCX'¶

format_description = 'Paintbrush'¶

`PdfImagePlugin` Module¶

`PixarImagePlugin` Module¶

class PIL.PixarImagePlugin.PixarImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'PIXAR'¶

format_description = 'PIXAR raster image'¶

`PngImagePlugin` Module¶

class PIL.PngImagePlugin.PngImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

load_end()[source]¶: internal: finished reading image data

load_prepare()[source]¶: internal: prepare to read PNG file

load_read(read_bytes)[source]¶: internal: read more image data

verify()[source]¶: Verify PNG file

PIL.PngImagePlugin.getchunks(im, **params)[source]¶: Return a list of PNG chunks representing this image.

PIL.PngImagePlugin.is_cid()¶: Matches zero or more characters at the beginning of the string.

PIL.PngImagePlugin.putchunk(fp, cid, *data)[source]¶: Write a PNG chunk (including CRC field)

class PIL.PngImagePlugin.ChunkStream(fp)[source]¶

Bases: object

call(cid, pos, length)[source]¶: Call the appropriate chunk handler

close()[source]¶

crc(cid, data)[source]¶: Read and verify checksum

crc_skip(cid, data)[source]¶: Read checksum. Used if the C module is not present

push(cid, pos, length)[source]¶

read()[source]¶: Fetch a new chunk. Returns header information.

verify(endchunk=b'IEND')[source]¶

class PIL.PngImagePlugin.PngImageFile(fp=None, filename=None)[source]

Bases: PIL.ImageFile.ImageFile

format = 'PNG'¶

format_description = 'Portable network graphics'¶

getexif()[source]¶

load_end()[source]: internal: finished reading image data

load_prepare()[source]: internal: prepare to read PNG file

load_read(read_bytes)[source]: internal: read more image data

text¶

verify()[source]: Verify PNG file

class PIL.PngImagePlugin.PngStream(fp)[source]¶

Bases: PIL.PngImagePlugin.ChunkStream

check_text_memory(chunklen)[source]¶

chunk_IDAT(pos, length)[source]¶

chunk_IEND(pos, length)[source]¶

chunk_IHDR(pos, length)[source]¶

chunk_PLTE(pos, length)[source]¶

chunk_acTL(pos, length)[source]¶

chunk_cHRM(pos, length)[source]¶

chunk_eXIf(pos, length)[source]¶

chunk_gAMA(pos, length)[source]¶

chunk_iCCP(pos, length)[source]¶

chunk_iTXt(pos, length)[source]¶

chunk_pHYs(pos, length)[source]¶

chunk_sRGB(pos, length)[source]¶

chunk_tEXt(pos, length)[source]¶

chunk_tRNS(pos, length)[source]¶

chunk_zTXt(pos, length)[source]¶

`PpmImagePlugin` Module¶

class PIL.PpmImagePlugin.PpmImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'PPM'¶

format_description = 'Pbmplus image'¶

`PsdImagePlugin` Module¶

class PIL.PsdImagePlugin.PsdImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'PSD'¶

format_description = 'Adobe Photoshop'¶

is_animated¶

load_prepare()[source]¶

n_frames¶

seek(layer)[source]¶

Seeks to the given frame in this sequence file. If you seek beyond the end of the sequence, the method raises an EOFError exception. When a sequence file is opened, the library automatically seeks to frame 0.

See tell().

Parameters:	frame – Frame number, starting at 0.
Raises:	EOFError – If the call attempts to seek beyond the end of the sequence.

tell()[source]¶

Returns the current frame number. See seek().

Returns:	Frame number, starting with 0.

`SgiImagePlugin` Module¶

class PIL.SgiImagePlugin.SGI16Decoder(mode, *args)[source]¶

Bases: PIL.ImageFile.PyDecoder

decode(buffer)[source]¶

Override to perform the decoding process.

Parameters:	buffer – A bytes object with the data to be decoded.
Returns:	A tuple of (bytes consumed, errcode). If finished with decoding return <0 for the bytes consumed. Err codes are from ERRORS

class PIL.SgiImagePlugin.SgiImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'SGI'¶

format_description = 'SGI Image File Format'¶

`SpiderImagePlugin` Module¶

class PIL.SpiderImagePlugin.SpiderImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

convert2byte(depth=255)[source]¶

format = 'SPIDER'¶

format_description = 'Spider 2D image'¶

is_animated¶

n_frames¶

seek(frame)[source]¶

Seeks to the given frame in this sequence file. If you seek beyond the end of the sequence, the method raises an EOFError exception. When a sequence file is opened, the library automatically seeks to frame 0.

See tell().

Parameters:	frame – Frame number, starting at 0.
Raises:	EOFError – If the call attempts to seek beyond the end of the sequence.

tell()[source]¶

Returns the current frame number. See seek().

Returns:	Frame number, starting with 0.

tkPhotoImage()[source]¶

PIL.SpiderImagePlugin.isInt(f)[source]¶

PIL.SpiderImagePlugin.isSpiderHeader(t)[source]¶

PIL.SpiderImagePlugin.isSpiderImage(filename)[source]¶

PIL.SpiderImagePlugin.loadImageSeries(filelist=None)[source]¶: create a list of Image objects for use in a montage

PIL.SpiderImagePlugin.makeSpiderHeader(im)[source]¶

`SunImagePlugin` Module¶

class PIL.SunImagePlugin.SunImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'SUN'¶

format_description = 'Sun Raster File'¶

`TgaImagePlugin` Module¶

class PIL.TgaImagePlugin.TgaImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'TGA'¶

format_description = 'Targa'¶

`TiffImagePlugin` Module¶

class PIL.TiffImagePlugin.AppendingTiffWriter(fn, new=False)[source]¶

Bases: object

Tags = {273, 288, 324, 519, 520, 521}¶

close()[source]¶

fieldSizes = [0, 1, 1, 2, 4, 8, 1, 1, 2, 4, 8, 4, 8]¶

finalize()[source]¶

fixIFD()[source]¶

fixOffsets(count, isShort=False, isLong=False)[source]¶

goToEnd()[source]¶

newFrame()[source]¶

readLong()[source]¶

readShort()[source]¶

rewriteLastLong(value)[source]¶

rewriteLastShort(value)[source]¶

rewriteLastShortToLong(value)[source]¶

seek(offset, whence=0)[source]¶

setEndian(endian)[source]¶

setup()[source]¶

skipIFDs()[source]¶

tell()[source]¶

write(data)[source]¶

writeLong(value)[source]¶

writeShort(value)[source]¶

class PIL.TiffImagePlugin.IFDRational(value, denominator=1)[source]¶

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)[source]¶

Parameters:	max_denominator – Integer, the maximum denominator value
Returns:	Tuple of (numerator, denominator)

numerator¶

PIL.TiffImagePlugin.ImageFileDirectory¶: alias of PIL.TiffImagePlugin.ImageFileDirectory_v1

class PIL.TiffImagePlugin.ImageFileDirectory_v1(*args, **kwargs)[source]¶

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] = TiffTags.ASCII
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)[source]¶

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()[source]¶

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=b'II*x00x00x00x00x00', prefix=None)[source]¶

Bases: collections.abc.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] = TiffTags.ASCII
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.

legacy_api¶

load(fp)[source]¶

load_byte(data, legacy_api=True)[source]¶

load_double(data, legacy_api=True)¶

load_float(data, legacy_api=True)¶

load_long(data, legacy_api=True)¶

load_rational(data, legacy_api=True)[source]¶

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)[source]¶

load_signed_short(data, legacy_api=True)¶

load_string(data, legacy_api=True)[source]¶

load_undefined(data, legacy_api=True)[source]¶

named()[source]¶

Returns:	dict of name\|key: value

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

offset¶

prefix¶

reset()[source]¶

save(fp)[source]¶

tobytes(offset=0)[source]¶

write_byte(data)[source]¶

write_double(*values)¶

write_float(*values)¶

write_long(*values)¶

write_rational(*values)[source]¶

write_short(*values)¶

write_signed_byte(*values)¶

write_signed_long(*values)¶

write_signed_rational(*values)[source]¶

write_signed_short(*values)¶

write_string(value)[source]¶

write_undefined(value)[source]¶

class PIL.TiffImagePlugin.TiffImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'TIFF'¶

format_description = 'Adobe TIFF'¶

is_animated¶

load()[source]¶: Load image data based on tile list

load_end()[source]¶

n_frames¶

seek(frame)[source]¶: Select a given frame as current image

size¶

tell()[source]¶: Return the current frame number

`WebPImagePlugin` Module¶

class PIL.WebPImagePlugin.WebPImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'WEBP'¶

format_description = 'WebP image'¶

is_animated¶

load()[source]¶: Load image data based on tile list

n_frames¶

seek(frame)[source]¶

Seeks to the given frame in this sequence file. If you seek beyond the end of the sequence, the method raises an EOFError exception. When a sequence file is opened, the library automatically seeks to frame 0.

See tell().

Parameters:	frame – Frame number, starting at 0.
Raises:	EOFError – If the call attempts to seek beyond the end of the sequence.

tell()[source]¶

Returns the current frame number. See seek().

Returns:	Frame number, starting with 0.

`WmfImagePlugin` Module¶

class PIL.WmfImagePlugin.WmfStubImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.StubImageFile

format = 'WMF'¶

format_description = 'Windows Metafile'¶

PIL.WmfImagePlugin.register_handler(handler)[source]¶

Install application-specific WMF image handler.

Parameters:	handler – Handler object.

`XVThumbImagePlugin` Module¶

class PIL.XVThumbImagePlugin.XVThumbImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'XVThumb'¶

format_description = 'XV thumbnail image'¶

`XbmImagePlugin` Module¶

class PIL.XbmImagePlugin.XbmImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'XBM'¶

format_description = 'X11 Bitmap'¶

`XpmImagePlugin` Module¶

class PIL.XpmImagePlugin.XpmImageFile(fp=None, filename=None)[source]¶

Bases: PIL.ImageFile.ImageFile

format = 'XPM'¶

format_description = 'X11 Pixel Map'¶

load_read(bytes)[source]¶

Plugin reference¶

BmpImagePlugin Module¶

BufrStubImagePlugin Module¶

CurImagePlugin Module¶

DcxImagePlugin Module¶

EpsImagePlugin Module¶

FitsStubImagePlugin Module¶

FliImagePlugin Module¶

FpxImagePlugin Module¶

GbrImagePlugin Module¶

GifImagePlugin Module¶

GribStubImagePlugin Module¶

Hdf5StubImagePlugin Module¶

IcnsImagePlugin Module¶

IcoImagePlugin Module¶

ImImagePlugin Module¶

ImtImagePlugin Module¶

IptcImagePlugin Module¶

JpegImagePlugin Module¶

Jpeg2KImagePlugin Module¶

McIdasImagePlugin Module¶

MicImagePlugin Module¶

MpegImagePlugin Module¶

MspImagePlugin Module¶

PalmImagePlugin Module¶

PcdImagePlugin Module¶

PcxImagePlugin Module¶

PdfImagePlugin Module¶

PixarImagePlugin Module¶

PngImagePlugin Module¶

PpmImagePlugin Module¶

PsdImagePlugin Module¶

SgiImagePlugin Module¶

SpiderImagePlugin Module¶

SunImagePlugin Module¶

TgaImagePlugin Module¶

TiffImagePlugin Module¶

WebPImagePlugin Module¶

WmfImagePlugin Module¶

XVThumbImagePlugin Module¶

XbmImagePlugin Module¶

XpmImagePlugin Module¶

`BmpImagePlugin` Module¶

`BufrStubImagePlugin` Module¶

`CurImagePlugin` Module¶

`DcxImagePlugin` Module¶

`EpsImagePlugin` Module¶

`FitsStubImagePlugin` Module¶

`FliImagePlugin` Module¶

`FpxImagePlugin` Module¶

`GbrImagePlugin` Module¶

`GifImagePlugin` Module¶

`GribStubImagePlugin` Module¶

`Hdf5StubImagePlugin` Module¶

`IcnsImagePlugin` Module¶

`IcoImagePlugin` Module¶

`ImImagePlugin` Module¶

`ImtImagePlugin` Module¶

`IptcImagePlugin` Module¶

`JpegImagePlugin` Module¶

`Jpeg2KImagePlugin` Module¶

`McIdasImagePlugin` Module¶

`MicImagePlugin` Module¶

`MpegImagePlugin` Module¶

`MspImagePlugin` Module¶

`PalmImagePlugin` Module¶

`PcdImagePlugin` Module¶

`PcxImagePlugin` Module¶

`PdfImagePlugin` Module¶

`PixarImagePlugin` Module¶

`PngImagePlugin` Module¶

`PpmImagePlugin` Module¶

`PsdImagePlugin` Module¶

`SgiImagePlugin` Module¶

`SpiderImagePlugin` Module¶

`SunImagePlugin` Module¶

`TgaImagePlugin` Module¶

`TiffImagePlugin` Module¶

`WebPImagePlugin` Module¶

`WmfImagePlugin` Module¶

`XVThumbImagePlugin` Module¶

`XbmImagePlugin` Module¶

`XpmImagePlugin` Module¶