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")

Parser

class PIL.ImageFile.Parser

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

close()

(Consumer) Close the stream.

Returns:An image object.
Raises:IOError – If the parser failed to parse the image file either because it cannot be identified or cannot be decoded.
feed(data)

(Consumer) Feed data to the parser.

Parameters:data – A string buffer.
Raises:IOError – If the parser failed to parse the image file.
reset()

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

PyDecoder

class PIL.ImageFile.PyDecoder

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()

Override to perform decoder specific cleanup

Returns:None
decode(buffer)

Override to perform the decoding process.

Parameters:buffer – A bytes object with the data to be decoded. If handles_eof is set, then buffer will be empty and self.fd will be set.
Returns:A tuple of (bytes consumed, errcode). If finished with decoding return <0 for the bytes consumed. Err codes are from ERRORS
init(args)

Override to perform decoder specific initialization

Parameters:args – Array of args items from the tile entry
Returns:None
set_as_raw(data, rawmode=None)

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)

Called from ImageFile to set the python file-like object

Parameters:fd – A python file-like object
Returns:None
setimage(im, extents=None)

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