PIL Package (autodoc of remaining modules)

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

BdfFontFile Module

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

Bases: PIL.FontFile.FontFile


ContainerIO Module

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

Bases: object


Read data.

Parameters:n – Number of bytes to read. If omitted or zero, read until end of region.
Returns:An 8-bit string.

Read a line of text.

Returns:An 8-bit string.

Read multiple lines of text.

Returns:A list of 8-bit strings.
seek(offset, mode=0)[source]

Move file pointer.

  • 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.

Get current file pointer.

Returns:Offset from start of region, in bytes.

FontFile Module

class PIL.FontFile.FontFile[source]

Bases: object

bitmap = None

Create metrics and bitmap


Save font

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

GdImageFile Module

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

Bases: PIL.ImageFile.ImageFile

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

Load texture from a GD image file.

  • 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”.

An image instance.


OSError – If the image could not be read.

GimpGradientFile Module

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

Bases: PIL.GimpGradientFile.GradientFile

class PIL.GimpGradientFile.GradientFile[source]

Bases: object

gradient = None
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

rawmode = 'RGB'

ImageDraw2 Module

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

Bases: object

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

Bases: object

arc(xy, start, end, *options)[source]
chord(xy, start, end, *options)[source]
ellipse(xy, *options)[source]
line(xy, *options)[source]
pieslice(xy, start, end, *options)[source]
polygon(xy, *options)[source]
rectangle(xy, *options)[source]
render(op, xy, pen, brush=None)[source]
text(xy, text, font)[source]
textsize(text, font)[source]
class PIL.ImageDraw2.Font(color, file, size=12)[source]

Bases: object

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

Bases: object

ImageShow Module

class PIL.ImageShow.DisplayViewer[source]

Bases: PIL.ImageShow.UnixViewer

get_command_ex(file, **options)[source]
class PIL.ImageShow.EogViewer[source]

Bases: PIL.ImageShow.UnixViewer

get_command_ex(file, **options)[source]
class PIL.ImageShow.UnixViewer[source]

Bases: PIL.ImageShow.Viewer

format = 'PNG'
get_command(file, **options)[source]
options = {'compress_level': 1}
show_file(file, **options)[source]

Display given file

class PIL.ImageShow.Viewer[source]

Bases: object

Base class for viewers.

format = None
get_command(file, **options)[source]

Return format name, or None to save as PGM/PPM

options = {}

Save to temporary file, and return filename

show(image, **options)[source]
show_file(file, **options)[source]

Display given file

show_image(image, **options)[source]

Display given image

class PIL.ImageShow.XVViewer[source]

Bases: PIL.ImageShow.UnixViewer

get_command_ex(file, title=None, **options)[source]
PIL.ImageShow.register(viewer, order=1)[source]
PIL.ImageShow.show(image, title=None, **options)[source]

Display a given image.

  • image – An image object.
  • title – Optional title. Not all viewers can display the title.
  • **options – Additional viewer options.

True if a suitable viewer was found, false otherwise.

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

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

JpegPresets Module

JPEG quality settings equivalent to the Photoshop settings.

More presets can be added to the presets dict if needed.

Can be use when saving JPEG file.

To apply the preset, specify:


To apply only the quantization table:


To apply only the subsampling setting:



im.save("image_name.jpg", quality="web_high")


Subsampling is the practice of encoding images by implementing less resolution for chroma information than for luma information. (ref.: https://en.wikipedia.org/wiki/Chroma_subsampling)

Possible subsampling values are 0, 1 and 2 that correspond to 4:4:4, 4:2:2 and 4:2:0.

You can get the subsampling of a JPEG with the JpegImagePlugin.get_sampling(im) function.

In JPEG compressed data a JPEG marker is used instead of an EXIF tag. (ref.: https://www.exiv2.org/tags.html)

Quantization tables

They are values use by the DCT (Discrete cosine transform) to remove unnecessary information from the image (the lossy part of the compression). (ref.: https://en.wikipedia.org/wiki/Quantization_matrix#Quantization_matrices, https://en.wikipedia.org/wiki/JPEG#Quantization)

You can get the quantization tables of a JPEG with:


This will return a dict with a number of arrays. You can pass this dict directly as the qtables argument when saving a JPEG.

The tables format between im.quantization and quantization in presets differ in 3 ways:

  1. The base container of the preset is a list with sublists instead of dict. dict[0] -> list[0], dict[1] -> list[1], …
  2. Each table in a preset is a list instead of an array.
  3. The zigzag order is remove in the preset (needed by libjpeg >= 6a).

You can convert the dict format to the preset format with the JpegImagePlugin.convert_dict_qtables(dict_qtables) function.

Libjpeg ref.: https://web.archive.org/web/20120328125543/http://www.jpegcameras.com/libjpeg/libjpeg-3.html

PaletteFile Module

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

Bases: object

rawmode = 'RGB'

PcfFontFile Module

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

Bases: PIL.FontFile.FontFile

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

PngImagePlugin.iTXt Class

class PIL.PngImagePlugin.iTXt[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]
  • 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.

  • 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.

  • 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.

  • 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


WalImageFile Module


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 <b>putpalette</b> method.

Parameters:filename – WAL file name, or an opened file handle.
Returns:An image instance.

_binary Module

PIL._binary.i16be(c, o=0)[source]
PIL._binary.i16le(c, o=0)[source]

Converts a 2-bytes (16 bits) string to an unsigned integer.

  • c – string containing bytes to convert
  • o – offset of bytes to convert in string
PIL._binary.i32be(c, o=0)[source]
PIL._binary.i32le(c, o=0)[source]

Converts a 4-bytes (32 bits) string to an unsigned integer.

  • c – string containing bytes to convert
  • o – offset of bytes to convert in string
PIL._binary.si16le(c, o=0)[source]

Converts a 2-bytes (16 bits) string to a signed integer.

  • c – string containing bytes to convert
  • o – offset of bytes to convert in string
PIL._binary.si32le(c, o=0)[source]

Converts a 4-bytes (32 bits) string to a signed integer.

  • c – string containing bytes to convert
  • o – offset of bytes to convert in string