ImageFile Module (original) (raw)

Toggle table of contents sidebar

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 sgmlliband xmllib modules.

Example: Parse an image¶

from PIL import ImageFile

fp = open("hopper.ppm", "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._Tile[source]¶

Bases: NamedTuple

_Tile(codec_name, extents, offset, args)

codec_name_: str_¶

Alias for field number 0

extents_: tuple[int, int, int, int] | None_¶

Alias for field number 1

offset_: int_¶

Alias for field number 2

args_: tuple[Any, ...] | str | None_¶

Alias for field number 3

class PIL.ImageFile.Parser[source]¶

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

close() → Image [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: bytes) → None [source]¶

(Consumer) Feed data to the parser.

Parameters:

data – A string buffer.

Raises:

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

reset() → None [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.PyCodec[source]¶

cleanup() → None [source]¶

Override to perform codec specific cleanup

Returns:

None

init(args: tuple[Any, ...]) → None [source]¶

Override to perform codec specific initialization

Parameters:

args – Tuple of arg items from the tile entry

Returns:

None

setfd(fd: IO[bytes]) → None [source]¶

Called from ImageFile to set the Python file-like object

Parameters:

fd – A Python file-like object

Returns:

None

setimage(im: Image.core.ImagingCore, extents: tuple[int, int, int, int] | None = None) → None [source]¶

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

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

Bases: PyCodec

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

See Writing Your Own File Codec in Python

decode(buffer: bytes | SupportsArrayInterface) → tuple[int, int][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 -1 for the bytes consumed. Err codes are from ImageFile.ERRORS.

set_as_raw(data: bytes, rawmode: str | None = None, extra: tuple[Any, ...] = ()) → 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
extra – Extra arguments for the decoder.

Returns:

None

class PIL.ImageFile.PyEncoder[source]¶

Bases: PyCodec

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

See Writing Your Own File Codec in Python

encode(bufsize: int) → tuple[int, int, bytes][source]¶

Override to perform the encoding process.

Parameters:

bufsize – Buffer size.

Returns:

A tuple of (bytes encoded, errcode, bytes). If finished with encoding return 1 for the error code. Err codes are from ImageFile.ERRORS.

encode_to_file(fh: int, bufsize: int) → int [source]¶

Parameters:

fh – File handle.
bufsize – Buffer size.

Returns:

If finished successfully, return 0. Otherwise, return an error code. Err codes are fromImageFile.ERRORS.

encode_to_pyfd() → tuple[int, int][source]¶

If pushes_fd is True, then this method will be used, and encode() will only be called once.

Returns:

A tuple of (bytes consumed, errcode). Err codes are from ImageFile.ERRORS.

class PIL.ImageFile.ImageFile[source]¶

Bases: Image

Base class for image file format handlers.

tile_: list[_Tile]_¶

A list of tile descriptors

close() → None [source]¶

Closes the file pointer, if possible.

This operation will destroy the image core and release its memory. The image data will be unusable afterward.

This function is required to close images that have multiple frames or have not had their file read and closed by theload() method. See File Handling in Pillow for more information.

get_child_images() → list[ImageFile][source]¶

get_format_mimetype() → str | None [source]¶

verify() → None [source]¶

Check file integrity

load() → Image.core.PixelAccess | None [source]¶

Load image data based on tile list

load_prepare() → None [source]¶

load_end() → None [source]¶

class PIL.ImageFile.StubHandler[source]¶

Bases: ABC

class PIL.ImageFile.StubImageFile[source]¶

Bases: ImageFile