ImageFile Module

The ImageFile module provides support functions for the image open and save functions.

In addition, it provides a Parser class which can be used to decode an image piece by piece (e.g. while receiving it over a network connection). This class implements the same consumer interface as the standard sgmllib and xmllib modules.

Example: Parse an image

from PIL import ImageFile

fp = open("hopper.pgm", "rb")

p = ImageFile.Parser()

while 1:
    s = fp.read(1024)
    if not s:
        break
    p.feed(s)

im = p.close()

im.save("copy.jpg")

Classes

class PIL.ImageFile.Parser[source]

Incremental image parser. This class implements the standard feed/close consumer interface.

close()[source]

(Consumer) Close the stream.

Returns

An image object.

Raises

OSError – If the parser failed to parse the image file either because it cannot be identified or cannot be decoded.

feed(data)[source]

(Consumer) Feed data to the parser.

Parameters

data – A string buffer.

Raises

OSError – If the parser failed to parse the image file.

reset()[source]

(Consumer) Reset the parser. Note that you can only call this method immediately after you’ve created a parser; parser instances cannot be reused.

class PIL.ImageFile.PyDecoder[source]

Python implementation of a format decoder. Override this class and add the decoding logic in the decode() method.

See Writing Your Own File Decoder in Python

cleanup()[source]

Override to perform decoder specific cleanup

Returns

None

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 ImageFile.ERRORS.

init(args)[source]

Override to perform decoder specific initialization

Parameters

args – Array of args items from the tile entry

Returns

None

set_as_raw(data, rawmode=None)[source]

Convenience method to set the internal image from a stream of raw data

Parameters
  • data – Bytes to be set

  • rawmode – The rawmode to be used for the decoder. If not specified, it will default to the mode of the image

Returns

None

setfd(fd)[source]

Called from ImageFile to set the python file-like object

Parameters

fd – A python file-like object

Returns

None

setimage(im, extents=None)[source]

Called from ImageFile to set the core output image for the decoder

Parameters
  • im – A core image object

  • extents – a 4 tuple of (x0, y0, x1, y1) defining the rectangle for this tile

Returns

None

class PIL.ImageFile.ImageFile[source]

Bases: PIL.Image.Image

Base class for image file format handlers.

tile

A list of tile descriptors, or None

get_format_mimetype()[source]
verify()[source]

Check file integrity

load()[source]

Load image data based on tile list

load_prepare()[source]
load_end()[source]
class PIL.ImageFile.StubImageFile[source]

Bases: PIL.ImageFile.ImageFile

Base class for stub image loaders.

A stub loader is an image loader that can identify files of a certain format, but relies on external code to load the file.

load()[source]

Load image data based on tile list

Constants

PIL.ImageFile.LOAD_TRUNCATED_IMAGES = False

Whether or not to load truncated image files. User code may change this.

PIL.ImageFile.ERRORS

Dict of known error codes returned from PyDecoder.decode().