PIL Package (autodoc of remaining modules)

Reference for modules whose documentation has not yet been ported or written can be found here.

PIL Module

exception PIL.UnidentifiedImageError[source]

Bases: OSError

Raised in PIL.Image.open() if an image cannot be opened and identified.

BdfFontFile Module

Parse X Bitmap Distribution Format (BDF)

class PIL.BdfFontFile.BdfFontFile(fp)[source]

Bases: PIL.FontFile.FontFile

Font file plugin for the X11 BDF format.

PIL.BdfFontFile.bdf_char(f)[source]

ContainerIO Module

class PIL.ContainerIO.ContainerIO(file, offset, length)[source]

Bases: object

A file object that provides read access to a part of an existing file (for example a TAR file).

isatty()[source]
read(n=0)[source]

Read data.

Parameters

n – Number of bytes to read. If omitted or zero, read until end of region.

Returns

An 8-bit string.

readline()[source]

Read a line of text.

Returns

An 8-bit string.

readlines()[source]

Read multiple lines of text.

Returns

A list of 8-bit strings.

seek(offset, mode=0)[source]

Move file pointer.

Parameters
  • offset – Offset in bytes.

  • mode – Starting position. Use 0 for beginning of region, 1 for current offset, and 2 for end of region. You cannot move the pointer outside the defined region.

tell()[source]

Get current file pointer.

Returns

Offset from start of region, in bytes.

FontFile Module

class PIL.FontFile.FontFile[source]

Bases: object

Base class for raster font file handlers.

bitmap = None
compile()[source]

Create metrics and bitmap

save(filename)[source]

Save font

PIL.FontFile.puti16(fp, values)[source]

Write network order (big-endian) 16-bit sequence

GdImageFile Module

Note

This format cannot be automatically recognized, so the class is not registered for use with PIL.Image.open(). To open a gd file, use the PIL.GdImageFile.open() function instead.

Warning

THE GD FORMAT IS NOT DESIGNED FOR DATA INTERCHANGE. This implementation is provided for convenience and demonstrational purposes only.

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

Bases: PIL.ImageFile.ImageFile

Image plugin for the GD uncompressed format. Note that this format is not supported by the standard PIL.Image.open() function. To use this plugin, you have to import the PIL.GdImageFile module and use the PIL.GdImageFile.open() function.

format = 'GD'
format_description = 'GD uncompressed images'
PIL.GdImageFile.open(fp, mode='r')[source]

Load texture from a GD image file.

Parameters
  • filename – GD file name, or an opened file handle.

  • mode – Optional mode. In this version, if the mode argument is given, it must be “r”.

Returns

An image instance.

Raises

OSError – If the image could not be read.

GimpGradientFile Module

Stuff to translate curve segments to palette values (derived from the corresponding code in GIMP, written by Federico Mena Quintero. See the GIMP distribution for more information.)

PIL.GimpGradientFile.EPSILON = 1e-10
class PIL.GimpGradientFile.GimpGradientFile(fp)[source]

Bases: PIL.GimpGradientFile.GradientFile

File handler for GIMP’s gradient format.

class PIL.GimpGradientFile.GradientFile[source]

Bases: object

getpalette(entries=256)[source]
gradient = None
PIL.GimpGradientFile.SEGMENTS = [<function linear>, <function curved>, <function sine>, <function sphere_increasing>, <function sphere_decreasing>]
PIL.GimpGradientFile.curved(middle, pos)[source]
PIL.GimpGradientFile.linear(middle, pos)[source]
PIL.GimpGradientFile.sine(middle, pos)[source]
PIL.GimpGradientFile.sphere_decreasing(middle, pos)[source]
PIL.GimpGradientFile.sphere_increasing(middle, pos)[source]

GimpPaletteFile Module

class PIL.GimpPaletteFile.GimpPaletteFile(fp)[source]

Bases: object

File handler for GIMP’s palette format.

getpalette()[source]
rawmode = 'RGB'

ImageDraw2 Module

(Experimental) WCK-style drawing interface operations

See also

PIL.ImageDraw

class PIL.ImageDraw2.Pen(color, width=1, opacity=255)[source]

Bases: object

Stores an outline color and width.

class PIL.ImageDraw2.Brush(color, opacity=255)[source]

Bases: object

Stores a fill color

class PIL.ImageDraw2.Font(color, file, size=12)[source]

Bases: object

Stores a TrueType font and color

class PIL.ImageDraw2.Draw(image, size=None, color=None)[source]

Bases: object

(Experimental) WCK-style drawing interface

flush()[source]
render(op, xy, pen, brush=None)[source]
settransform(offset)[source]

Sets a transformation offset.

arc(xy, start, end, *options)[source]

Draws an arc (a portion of a circle outline) between the start and end angles, inside the given bounding box.

chord(xy, start, end, *options)[source]

Same as arc(), but connects the end points with a straight line.

ellipse(xy, *options)[source]

Draws an ellipse inside the given bounding box.

line(xy, *options)[source]

Draws a line between the coordinates in the xy list.

pieslice(xy, start, end, *options)[source]

Same as arc, but also draws straight lines between the end points and the center of the bounding box.

polygon(xy, *options)[source]

Draws a polygon.

The polygon outline consists of straight lines between the given coordinates, plus a straight line between the last and the first coordinate.

rectangle(xy, *options)[source]

Draws a rectangle.

text(xy, text, font)[source]

Draws the string at the given position.

textsize(text, font)[source]

Return the size of the given string, in pixels.

ImageTransform Module

class PIL.ImageTransform.AffineTransform(data)[source]

Bases: PIL.ImageTransform.Transform

Define an affine image transform.

This function takes a 6-tuple (a, b, c, d, e, f) which contain the first two rows from an affine transform matrix. For each pixel (x, y) in the output image, the new value is taken from a position (a x + b y + c, d x + e y + f) in the input image, rounded to nearest pixel.

This function can be used to scale, translate, rotate, and shear the original image.

See transform()

Parameters

matrix – A 6-tuple (a, b, c, d, e, f) containing the first two rows from an affine transform matrix.

method = 0
class PIL.ImageTransform.ExtentTransform(data)[source]

Bases: PIL.ImageTransform.Transform

Define a transform to extract a subregion from an image.

Maps a rectangle (defined by two corners) from the image to a rectangle of the given size. The resulting image will contain data sampled from between the corners, such that (x0, y0) in the input image will end up at (0,0) in the output image, and (x1, y1) at size.

This method can be used to crop, stretch, shrink, or mirror an arbitrary rectangle in the current image. It is slightly slower than crop, but about as fast as a corresponding resize operation.

See transform()

Parameters

bbox – A 4-tuple (x0, y0, x1, y1) which specifies two points in the input image’s coordinate system. See Coordinate System.

method = 1
class PIL.ImageTransform.MeshTransform(data)[source]

Bases: PIL.ImageTransform.Transform

Define a mesh image transform. A mesh transform consists of one or more individual quad transforms.

See transform()

Parameters

data – A list of (bbox, quad) tuples.

method = 4
class PIL.ImageTransform.QuadTransform(data)[source]

Bases: PIL.ImageTransform.Transform

Define a quad image transform.

Maps a quadrilateral (a region defined by four corners) from the image to a rectangle of the given size.

See transform()

Parameters

xy – An 8-tuple (x0, y0, x1, y1, x2, y2, x3, y3) which contain the upper left, lower left, lower right, and upper right corner of the source quadrilateral.

method = 3
class PIL.ImageTransform.Transform(data)[source]

Bases: PIL.Image.ImageTransformHandler

getdata()[source]
transform(size, image, **options)[source]

PaletteFile Module

class PIL.PaletteFile.PaletteFile(fp)[source]

Bases: object

File handler for Teragon-style palette files.

getpalette()[source]
rawmode = 'RGB'

PcfFontFile Module

class PIL.PcfFontFile.PcfFontFile(fp, charset_encoding='iso8859-1')[source]

Bases: PIL.FontFile.FontFile

Font file plugin for the X11 PCF format.

name = 'name'
PIL.PcfFontFile.sz(s, o)[source]

PngImagePlugin.iTXt Class

class PIL.PngImagePlugin.iTXt(text, lang=None, tkey=None)[source]

Bases: str

Subclass of string to allow iTXt chunks to look like strings while keeping their extra information

__new__(cls, text, lang, tkey)[source]
Parameters
  • value – value for this key

  • lang – language code

  • tkey – UTF-8 version of the key name

PngImagePlugin.PngInfo Class

class PIL.PngImagePlugin.PngInfo[source]

Bases: object

PNG chunk container (for use with save(pnginfo=))

add(cid, data)[source]

Appends an arbitrary chunk. Use with caution.

Parameters
  • cid – a byte string, 4 bytes long.

  • data – a byte string of the encoded data

add_itxt(key, value, lang='', tkey='', zip=False)[source]

Appends an iTXt chunk.

Parameters
  • key – latin-1 encodable text key name

  • value – value for this key

  • lang – language code

  • tkey – UTF-8 version of the key name

  • zip – compression flag

add_text(key, value, zip=False)[source]

Appends a text chunk.

Parameters
  • key – latin-1 encodable text key name

  • value – value for this key, text or an PIL.PngImagePlugin.iTXt instance

  • zip – compression flag

TarIO Module

class PIL.TarIO.TarIO(tarfile, file)[source]

Bases: PIL.ContainerIO.ContainerIO

A file object that provides read access to a given member of a TAR file.

close()[source]

WalImageFile Module

This reader is based on the specification available from: https://www.flipcode.com/archives/Quake_2_BSP_File_Format.shtml and has been tested with a few sample files found using google.

Note

This format cannot be automatically recognized, so the reader is not registered for use with PIL.Image.open(). To open a WAL file, use the PIL.WalImageFile.open() function instead.

PIL.WalImageFile.open(filename)[source]

Load texture from a Quake2 WAL texture file.

By default, a Quake2 standard palette is attached to the texture. To override the palette, use the PIL.Image.Image.putpalette() method.

Parameters

filename – WAL file name, or an opened file handle.

Returns

An image instance.