Image Module (original) (raw)

The Image module provides a class with the same name which is used to represent a PIL image. The module also provides a number of factory functions, including functions to load images from files, and to create new images.

Examples

Open, rotate, and display an image (using the default viewer)

The following script loads an image, rotates it 45 degrees, and displays it using an external viewer (usually xv on Unix, and the Paint program on Windows).

from PIL import Image with Image.open("hopper.jpg") as im: im.rotate(45).show()

Create thumbnails

The following script creates nice thumbnails of all JPEG images in the current directory preserving aspect ratios with 128x128 max resolution.

from PIL import Image import glob, os

size = 128, 128

for infile in glob.glob("*.jpg"): file, ext = os.path.splitext(infile) with Image.open(infile) as im: im.thumbnail(size) im.save(file + ".thumbnail", "JPEG")

Functions

PIL.Image.open(fp: StrOrBytesPath | IO[bytes], mode: Literal['r'] = 'r', formats: list[str] | tuple[str, ...] | None = None) → ImageFile.ImageFile[source]

Opens and identifies the given image file.

This is a lazy operation; this function identifies the file, but the file remains open and the actual image data is not read from the file until you try to process the data (or call theload() method). Seenew(). See File Handling in Pillow.

Parameters:

Returns:

An Image object.

Raises:

Warning

To protect against potential DOS attacks caused by “decompression bombs” (i.e. malicious files which decompress into a huge amount of data and are designed to crash or cause disruption by using up a lot of memory), Pillow will issue a DecompressionBombWarning if the number of pixels in an image is over a certain limit, MAX_IMAGE_PIXELS.

This threshold can be changed by setting MAX_IMAGE_PIXELS. It can be disabled by setting Image.MAX_IMAGE_PIXELS = None.

If desired, the warning can be turned into an error withwarnings.simplefilter('error', Image.DecompressionBombWarning) or suppressed entirely withwarnings.simplefilter('ignore', Image.DecompressionBombWarning). See alsothe logging documentation to have warnings output to the logging facility instead of stderr.

If the number of pixels is greater than twice MAX_IMAGE_PIXELS, then aDecompressionBombError will be raised instead.

Image processing

PIL.Image.alpha_composite(im1: Image, im2: Image) → Image[source]

Alpha composite im2 over im1.

Parameters:

Returns:

An Image object.

PIL.Image.blend(im1: Image, im2: Image, alpha: float) → Image[source]

Creates a new image by interpolating between two input images, using a constant alpha:

out = image1 * (1.0 - alpha) + image2 * alpha

Parameters:

Returns:

An Image object.

PIL.Image.composite(image1: Image, image2: Image, mask: Image) → Image[source]

Create composite image by blending images using a transparency mask.

Parameters:

PIL.Image.eval(image: Image, *args: Callable[[int], float]) → Image[source]

Applies the function (which should take one argument) to each pixel in the given image. If the image has more than one band, the same function is applied to each band. Note that the function is evaluated once for each possible pixel value, so you cannot use random components or other generators.

Parameters:

Returns:

An Image object.

PIL.Image.merge(mode: str, bands: Sequence[Image]) → Image[source]

Merge a set of single band images into a new multiband image.

Parameters:

Returns:

An Image object.

Constructing images

PIL.Image.new(mode: str, size: tuple[int, int] | list[int], color: float | tuple[float, ...] | str | None = 0) → Image[source]

Creates a new image with the given mode and size.

Parameters:

Returns:

An Image object.

PIL.Image.fromarray(obj: SupportsArrayInterface, mode: str | None = None) → Image[source]

Creates an image memory from an object exporting the array interface (using the buffer protocol):

from PIL import Image import numpy as np a = np.zeros((5, 5)) im = Image.fromarray(a)

If obj is not contiguous, then the tobytes method is called and frombuffer() is used.

In the case of NumPy, be aware that Pillow modes do not always correspond to NumPy dtypes. Pillow modes only offer 1-bit pixels, 8-bit pixels, 32-bit signed integer pixels, and 32-bit floating point pixels.

Pillow images can also be converted to arrays:

from PIL import Image import numpy as np im = Image.open("hopper.jpg") a = np.asarray(im)

When converting Pillow images to arrays however, only pixel values are transferred. This means that P and PA mode images will lose their palette.

Parameters:

Returns:

An image object.

Added in version 1.1.6.

PIL.Image.fromarrow(obj: SupportsArrowArrayInterface, mode: str, size: tuple[int, int]) → Image[source]

Creates an image with zero-copy shared memory from an object exporting the arrow_c_array interface protocol:

from PIL import Image import pyarrow as pa arr = pa.array([0](55*4), type=pa.uint8()) im = Image.fromarrow(arr, 'RGBA', (5, 5))

If the data representation of the obj is not compatible with Pillow internal storage, a ValueError is raised.

Pillow images can also be converted to Arrow objects:

from PIL import Image import pyarrow as pa im = Image.open('hopper.jpg') arr = pa.array(im)

As with array support, when converting Pillow images to arrays, only pixel values are transferred. This means that P and PA mode images will lose their palette.

Parameters:

Returns:

An Image object

Note that according to the Arrow spec, both the producer and the consumer should consider the exported array to be immutable, as unsynchronized updates will potentially cause inconsistent data.

See: Arrow Support for more detailed information

Added in version 11.2.1.

PIL.Image.frombytes(mode: str, size: tuple[int, int], data: bytes | bytearray | SupportsArrayInterface, decoder_name: str = 'raw', *args: Any) → Image[source]

Creates a copy of an image memory from pixel data in a buffer.

In its simplest form, this function takes three arguments (mode, size, and unpacked pixel data).

You can also use any pixel decoder supported by PIL. For more information on available decoders, see the sectionWriting Your Own File Codec.

Note that this function decodes pixel data only, not entire images. If you have an entire image in a string, wrap it in aBytesIO object, and use open() to load it.

Parameters:

Returns:

An Image object.

PIL.Image.frombuffer(mode: str, size: tuple[int, int], data: bytes | SupportsArrayInterface, decoder_name: str = 'raw', *args: Any) → Image[source]

Creates an image memory referencing pixel data in a byte buffer.

This function is similar to frombytes(), but uses data in the byte buffer, where possible. This means that changes to the original buffer object are reflected in this image). Not all modes can share memory; supported modes include “L”, “RGBX”, “RGBA”, and “CMYK”.

Note that this function decodes pixel data only, not entire images. If you have an entire image file in a string, wrap it in aBytesIO object, and use open() to load it.

The default parameters used for the “raw” decoder differs from that used forfrombytes(). This is a bug, and will probably be fixed in a future release. The current release issues a warning if you do this; to disable the warning, you should provide the full set of parameters. See below for details.

Parameters:

Returns:

An Image object.

Added in version 1.1.4.

Generating images

PIL.Image.effect_mandelbrot(size: tuple[int, int], extent: tuple[float, float, float, float], quality: int) → Image[source]

Generate a Mandelbrot set covering the given extent.

Parameters:

PIL.Image.effect_noise(size: tuple[int, int], sigma: float) → Image[source]

Generate Gaussian noise centered around 128.

Parameters:

PIL.Image.linear_gradient(mode: str) → Image[source]

Generate 256x256 linear gradient from black to white, top to bottom.

Parameters:

mode – Input mode.

PIL.Image.radial_gradient(mode: str) → Image[source]

Generate 256x256 radial gradient from black to white, centre to edge.

Parameters:

mode – Input mode.

Registering plugins

PIL.Image.preinit() → None[source]

Explicitly loads BMP, GIF, JPEG, PPM and PPM file format drivers.

It is called when opening or saving images.

PIL.Image.init() → bool[source]

Explicitly initializes the Python Imaging Library. This function loads all available file format drivers.

It is called when opening or saving images if preinit() is insufficient, and by pilinfo().

Note

These functions are for use by plugin authors. They are called when a plugin is loaded as part of preinit() or init(). Application authors can ignore them.

PIL.Image.register_open(id: str, factory: Callable[[IO[bytes], str | bytes], ImageFile.ImageFile] | type[ImageFile.ImageFile], accept: Callable[[bytes], bool | str] | None = None) → None[source]

Register an image file plugin. This function should not be used in application code.

Parameters:

PIL.Image.register_mime(id: str, mimetype: str) → None[source]

Registers an image MIME type by populating Image.MIME. This function should not be used in application code.

Image.MIME provides a mapping from image format identifiers to mime formats, but get_format_mimetype() can provide a different result for specific images.

Parameters:

PIL.Image.register_save(id: str, driver: Callable[[Image, IO[bytes], str | bytes], None]) → None[source]

Registers an image save function. This function should not be used in application code.

Parameters:

PIL.Image.register_save_all(id: str, driver: Callable[[Image, IO[bytes], str | bytes], None]) → None[source]

Registers an image function to save all the frames of a multiframe format. This function should not be used in application code.

Parameters:

PIL.Image.register_extension(id: str, extension: str) → None[source]

Registers an image extension. This function should not be used in application code.

Parameters:

PIL.Image.register_extensions(id: str, extensions: list[str]) → None[source]

Registers image extensions. This function should not be used in application code.

Parameters:

PIL.Image.registered_extensions() → dict[str, str][source]

Returns a dictionary containing all file extensions belonging to registered plugins

PIL.Image.register_decoder(name: str, decoder: type[ImageFile.PyDecoder]) → None[source]

Registers an image decoder. This function should not be used in application code.

Parameters:

Added in version 4.1.0.

PIL.Image.register_encoder(name: str, encoder: type[ImageFile.PyEncoder]) → None[source]

Registers an image encoder. This function should not be used in application code.

Parameters:

Added in version 4.1.0.

The Image Class

class PIL.Image.Image[source]

This class represents an image object. To createImage objects, use the appropriate factory functions. There’s hardly ever any reason to call the Image constructor directly.

An instance of the Image class has the following methods. Unless otherwise stated, all methods return a new instance of theImage class, holding the resulting image.

Image.alpha_composite(im: Image, dest: Sequence[int] = (0, 0), source: Sequence[int] = (0, 0)) → None[source]

‘In-place’ analog of Image.alpha_composite. Composites an image onto this image.

Parameters:

Performance Note: Not currently implemented in-place in the core layer.

Image.apply_transparency() → None[source]

If a P mode image has a “transparency” key in the info dictionary, remove the key and instead apply the transparency to the palette. Otherwise, the image is unchanged.

Image.convert(mode: str | None = None, matrix: tuple[float, ...] | None = None, dither: Dither | None = None, palette: Palette = Palette.WEB, colors: int = 256) → Image[source]

Returns a converted copy of this image. For the “P” mode, this method translates pixels through the palette. If mode is omitted, a mode is chosen so that all information in the image and the palette can be represented without a palette.

This supports all possible conversions between “L”, “RGB” and “CMYK”. Thematrix argument only supports “L” and “RGB”.

When translating a color image to grayscale (mode “L”), the library uses the ITU-R 601-2 luma transform:

L = R * 299/1000 + G * 587/1000 + B * 114/1000

The default method of converting a grayscale (“L”) or “RGB” image into a bilevel (mode “1”) image uses Floyd-Steinberg dither to approximate the original image luminosity levels. If dither is None, all values larger than 127 are set to 255 (white), all other values to 0 (black). To use other thresholds, use thepoint() method.

When converting from “RGBA” to “P” without a matrix argument, this passes the operation to quantize(), and dither and palette are ignored.

When converting from “PA”, if an “RGBA” palette is present, the alpha channel from the image will be used instead of the values from the palette.

Parameters:

Return type:

Image

Returns:

An Image object.

The following example converts an RGB image (linearly calibrated according to ITU-R 709, using the D65 luminant) to the CIE XYZ color space:

rgb2xyz = ( 0.412453, 0.357580, 0.180423, 0, 0.212671, 0.715160, 0.072169, 0, 0.019334, 0.119193, 0.950227, 0) out = im.convert("RGB", rgb2xyz)

Image.copy() → Image[source]

Copies this image. Use this method if you wish to paste things into an image, but still retain the original.

Return type:

Image

Returns:

An Image object.

Image.crop(box: tuple[float, float, float, float] | None = None) → Image[source]

Returns a rectangular region from this image. The box is a 4-tuple defining the left, upper, right, and lower pixel coordinate. See Coordinate System.

Note: Prior to Pillow 3.4.0, this was a lazy operation.

Parameters:

box – The crop rectangle, as a (left, upper, right, lower)-tuple.

Return type:

Image

Returns:

An Image object.

This crops the input image with the provided coordinates:

from PIL import Image

with Image.open("hopper.jpg") as im:

# The crop method from the Image module takes four coordinates as input.
# The right can also be represented as (left+width)
# and lower can be represented as (upper+height).
(left, upper, right, lower) = (20, 20, 100, 100)

# Here the image "im" is cropped and assigned to new variable im_crop
im_crop = im.crop((left, upper, right, lower))

Image.draft(mode: str | None, size: tuple[int, int] | None) → tuple[str, tuple[int, int, float, float]] | None[source]

Configures the image file loader so it returns a version of the image that as closely as possible matches the given mode and size. For example, you can use this method to convert a color JPEG to grayscale while loading it.

If any changes are made, returns a tuple with the chosen mode andbox with coordinates of the original image within the altered one.

Note that this method modifies the Image object in place. If the image has already been loaded, this method has no effect.

Note: This method is not implemented for most images. It is currently implemented only for JPEG and MPO images.

Parameters:

Image.effect_spread(distance: int) → Image[source]

Randomly spread pixels in an image.

Parameters:

distance – Distance to spread pixels.

Image.entropy(mask: Image | None = None, extrema: tuple[float, float] | None = None) → float[source]

Calculates and returns the entropy for the image.

A bilevel image (mode “1”) is treated as a grayscale (“L”) image by this method.

If a mask is provided, the method employs the histogram for those parts of the image where the mask image is non-zero. The mask image must have the same size as the image, and be either a bi-level image (mode “1”) or a grayscale image (“L”).

Parameters:

Returns:

A float value representing the image entropy

Image.filter(filter: ImageFilter.Filter | type[ImageFilter.Filter]) → Image[source]

Filters this image using the given filter. For a list of available filters, see the ImageFilter module.

Parameters:

filter – Filter kernel.

Returns:

An Image object.

This blurs the input image using a filter from the ImageFilter module:

from PIL import Image, ImageFilter

with Image.open("hopper.jpg") as im:

# Blur the input image using the filter ImageFilter.BLUR
im_blurred = im.filter(filter=ImageFilter.BLUR)

Image.frombytes(data: bytes | bytearray | SupportsArrayInterface, decoder_name: str = 'raw', *args: Any) → None[source]

Loads this image with pixel data from a bytes object.

This method is similar to the frombytes() function, but loads data into this image instead of creating a new image object.

Image.getbands() → tuple[str, ...][source]

Returns a tuple containing the name of each band in this image. For example, getbands on an RGB image returns (“R”, “G”, “B”).

Returns:

A tuple containing band names.

Return type:

tuple

This helps to get the bands of the input image:

from PIL import Image

with Image.open("hopper.jpg") as im: print(im.getbands()) # Returns ('R', 'G', 'B')

Image.getbbox(*, alpha_only: bool = True) → tuple[int, int, int, int] | None[source]

Calculates the bounding box of the non-zero regions in the image.

Parameters:

alpha_only – Optional flag, defaulting to True. If True and the image has an alpha channel, trim transparent pixels. Otherwise, trim pixels when all channels are zero. Keyword-only argument.

Returns:

The bounding box is returned as a 4-tuple defining the left, upper, right, and lower pixel coordinate. SeeCoordinate System. If the image is completely empty, this method returns None.

This helps to get the bounding box coordinates of the input image:

from PIL import Image

with Image.open("hopper.jpg") as im: print(im.getbbox()) # Returns four coordinates in the format (left, upper, right, lower)

Image.getchannel(channel: int | str) → Image[source]

Returns an image containing a single channel of the source image.

Parameters:

channel – What channel to return. Could be index (0 for “R” channel of “RGB”) or channel name (“A” for alpha channel of “RGBA”).

Returns:

An image in “L” mode.

Added in version 4.3.0.

Image.getcolors(maxcolors: int = 256) → list[tuple[int, tuple[int, ...]]] | list[tuple[int, float]] | None[source]

Returns a list of colors used in this image.

The colors will be in the image’s mode. For example, an RGB image will return a tuple of (red, green, blue) color values, and a P image will return the index of the color in the palette.

Parameters:

maxcolors – Maximum number of colors. If this number is exceeded, this method returns None. The default limit is 256 colors.

Returns:

An unsorted list of (count, pixel) values.

Image.getdata(band: int | None = None) → core.ImagingCore[source]

Returns the contents of this image as a sequence object containing pixel values. The sequence object is flattened, so that values for line one follow directly after the values of line zero, and so on.

Note that the sequence object returned by this method is an internal PIL data type, which only supports certain sequence operations. To convert it to an ordinary sequence (e.g. for printing), use list(im.getdata()).

Parameters:

band – What band to return. The default is to return all bands. To return a single band, pass in the index value (e.g. 0 to get the “R” band from an “RGB” image).

Returns:

A sequence-like object.

Image.getexif() → Exif[source]

Gets EXIF data from the image.

Returns:

an Exif object.

Image.getextrema() → tuple[float, float] | tuple[tuple[int, int], ...][source]

Gets the minimum and maximum pixel values for each band in the image.

Returns:

For a single-band image, a 2-tuple containing the minimum and maximum pixel value. For a multi-band image, a tuple containing one 2-tuple for each band.

Image.getpalette(rawmode: str | None = 'RGB') → list[int] | None[source]

Returns the image palette as a list.

Parameters:

rawmode –

The mode in which to return the palette. None will return the palette in its current mode.

Added in version 9.1.0.

Returns:

A list of color values [r, g, b, …], or None if the image has no palette.

Image.getpixel(xy: tuple[int, int] | list[int]) → float | tuple[int, ...] | None[source]

Returns the pixel value at a given position.

Parameters:

xy – The coordinate, given as (x, y). SeeCoordinate System.

Returns:

The pixel value. If the image is a multi-layer image, this method returns a tuple.

Image.getprojection() → tuple[list[int], list[int]][source]

Get projection to x and y axes

Returns:

Two sequences, indicating where there are non-zero pixels along the X-axis and the Y-axis, respectively.

Image.getxmp() → dict[str, Any][source]

Returns a dictionary containing the XMP tags. Requires defusedxml to be installed.

Returns:

XMP tags in a dictionary.

Image.histogram(mask: Image | None = None, extrema: tuple[float, float] | None = None) → list[int][source]

Returns a histogram for the image. The histogram is returned as a list of pixel counts, one for each pixel value in the source image. Counts are grouped into 256 bins for each band, even if the image has more than 8 bits per band. If the image has more than one band, the histograms for all bands are concatenated (for example, the histogram for an “RGB” image contains 768 values).

A bilevel image (mode “1”) is treated as a grayscale (“L”) image by this method.

If a mask is provided, the method returns a histogram for those parts of the image where the mask image is non-zero. The mask image must have the same size as the image, and be either a bi-level image (mode “1”) or a grayscale image (“L”).

Parameters:

Returns:

A list containing pixel counts.

Image.paste(im: Image | str | float | tuple[float, ...], box: Image | tuple[int, int, int, int] | tuple[int, int] | None = None, mask: Image | None = None) → None[source]

Pastes another image into this image. The box argument is either a 2-tuple giving the upper left corner, a 4-tuple defining the left, upper, right, and lower pixel coordinate, or None (same as (0, 0)). See Coordinate System. If a 4-tuple is given, the size of the pasted image must match the size of the region.

If the modes don’t match, the pasted image is converted to the mode of this image (see the convert() method for details).

Instead of an image, the source can be a integer or tuple containing pixel values. The method then fills the region with the given color. When creating RGB images, you can also use color strings as supported by the ImageColor module.

If a mask is given, this method updates only the regions indicated by the mask. You can use either “1”, “L”, “LA”, “RGBA” or “RGBa” images (if present, the alpha band is used as mask). Where the mask is 255, the given image is copied as is. Where the mask is 0, the current value is preserved. Intermediate values will mix the two images together, including their alpha channels if they have them.

See alpha_composite() if you want to combine images with respect to their alpha channels.

Parameters:

Image.point(lut: Sequence[float] | NumpyArray | Callable[[int], float] | Callable[[ImagePointTransform], ImagePointTransform | float] | ImagePointHandler, mode: str | None = None) → Image[source]

Maps this image through a lookup table or function.

Parameters:

Returns:

An Image object.

Image.putalpha(alpha: Image | int) → None[source]

Adds or replaces the alpha layer in this image. If the image does not have an alpha layer, it’s converted to “LA” or “RGBA”. The new layer must be either “L” or “1”.

Parameters:

alpha – The new alpha layer. This can either be an “L” or “1” image having the same size as this image, or an integer.

Image.putdata(data: Sequence[float] | Sequence[Sequence[int]] | core.ImagingCore | NumpyArray, scale: float = 1.0, offset: float = 0.0) → None[source]

Copies pixel data from a flattened sequence object into the image. The values should start at the upper left corner (0, 0), continue to the end of the line, followed directly by the first value of the second line, and so on. Data will be read until either the image or the sequence ends. The scale and offset values are used to adjust the sequence values: pixel = value*scale + offset.

Parameters:

Image.putpalette(data: ImagePalette.ImagePalette | bytes | Sequence[int], rawmode: str = 'RGB') → None[source]

Attaches a palette to this image. The image must be a “P”, “PA”, “L” or “LA” image.

The palette sequence must contain at most 256 colors, made up of one integer value for each channel in the raw mode. For example, if the raw mode is “RGB”, then it can contain at most 768 values, made up of red, green and blue values for the corresponding pixel index in the 256 colors. If the raw mode is “RGBA”, then it can contain at most 1024 values, containing red, green, blue and alpha values.

Alternatively, an 8-bit string may be used instead of an integer sequence.

Parameters:

Image.putpixel(xy: tuple[int, int], value: float | tuple[int, ...] | list[int]) → None[source]

Modifies the pixel at the given position. The color is given as a single numerical value for single-band images, and a tuple for multi-band images. In addition to this, RGB and RGBA tuples are accepted for P and PA images.

Note that this method is relatively slow. For more extensive changes, use paste() or the ImageDrawmodule instead.

See:

Parameters:

Image.quantize(colors: int = 256, method: int | None = None, kmeans: int = 0, palette: Image | None = None, dither: Dither = Dither.FLOYDSTEINBERG) → Image[source]

Convert the image to ‘P’ mode with the specified number of colors.

Parameters:

Returns:

A new image

Image.reduce(factor: int | tuple[int, int], box: tuple[int, int, int, int] | None = None) → Image[source]

Returns a copy of the image reduced factor times. If the size of the image is not dividable by factor, the resulting size will be rounded up.

Parameters:

Image.remap_palette(dest_map: list[int], source_palette: bytes | bytearray | None = None) → Image[source]

Rewrites the image to reorder the palette.

Parameters:

Returns:

An Image object.

Image.resize(size: tuple[int, int] | list[int] | NumpyArray, resample: int | None = None, box: tuple[float, float, float, float] | None = None, reducing_gap: float | None = None) → Image[source]

Returns a resized copy of this image.

Parameters:

Returns:

An Image object.

This resizes the given image from (width, height) to (width/2, height/2):

from PIL import Image

with Image.open("hopper.jpg") as im:

# Provide the target width and height of the image
(width, height) = (im.width // 2, im.height // 2)
im_resized = im.resize((width, height))

Image.rotate(angle: float, resample: Resampling = Resampling.NEAREST, expand: int | bool = False, center: tuple[float, float] | None = None, translate: tuple[int, int] | None = None, fillcolor: float | tuple[float, ...] | str | None = None) → Image[source]

Returns a rotated copy of this image. This method returns a copy of this image, rotated the given number of degrees counter clockwise around its centre.

Parameters:

Returns:

An Image object.

This rotates the input image by theta degrees counter clockwise:

from PIL import Image

with Image.open("hopper.jpg") as im:

# Rotate the image by 60 degrees counter clockwise
theta = 60
# Angle is in degrees counter clockwise
im_rotated = im.rotate(angle=theta)

Image.save(fp: StrOrBytesPath | IO[bytes], format: str | None = None, **params: Any) → None[source]

Saves this image under the given filename. If no format is specified, the format to use is determined from the filename extension, if possible.

Keyword options can be used to provide additional instructions to the writer. If a writer doesn’t recognise an option, it is silently ignored. The available options are described in theimage format documentation for each writer.

You can use a file object instead of a filename. In this case, you must always specify the format. The file object must implement the seek, tell, and writemethods, and be opened in binary mode.

Parameters:

Saving XMP data to a single image

from PIL import Image
red = Image.new("RGB", (1, 1), "#f00")
red.save("out.mpo", xmp=b"test")

Saving XMP data to the second frame of an image

from PIL import Image
black = Image.new("RGB", (1, 1))
red = Image.new("RGB", (1, 1), "#f00")
red.encoderinfo = {"xmp": b"test"}
black.save("out.mpo", save_all=True, append_images=[red])

Returns:

None

Raises:

Image.seek(frame: int) → None[source]

Seeks to the given frame in this sequence file. If you seek beyond the end of the sequence, the method raises anEOFError exception. When a sequence file is opened, the library automatically seeks to frame 0.

See tell().

If defined, n_frames refers to the number of available frames.

Parameters:

frame – Frame number, starting at 0.

Raises:

EOFError – If the call attempts to seek beyond the end of the sequence.

Image.show(title: str | None = None) → None[source]

Displays this image. This method is mainly intended for debugging purposes.

This method calls PIL.ImageShow.show() internally. You can usePIL.ImageShow.register() to override its default behaviour.

The image is first saved to a temporary file. By default, it will be in PNG format.

On Unix, the image is then opened using the xdg-open, display,gm, eog or xv utility, depending on which one can be found.

On macOS, the image is opened with the native Preview application.

On Windows, the image is opened with the standard PNG display utility.

Parameters:

title – Optional title to use for the image window, where possible.

Image.split() → tuple[Image, ...][source]

Split this image into individual bands. This method returns a tuple of individual image bands from an image. For example, splitting an “RGB” image creates three new images each containing a copy of one of the original bands (red, green, blue).

If you need only one band, getchannel()method can be more convenient and faster.

Returns:

A tuple containing bands.

Image.tell() → int[source]

Returns the current frame number. See seek().

If defined, n_frames refers to the number of available frames.

Returns:

Frame number, starting with 0.

Image.thumbnail(size: tuple[float, float], resample: Resampling = Resampling.BICUBIC, reducing_gap: float | None = 2.0) → None[source]

Make this image into a thumbnail. This method modifies the image to contain a thumbnail version of itself, no larger than the given size. This method calculates an appropriate thumbnail size to preserve the aspect of the image, calls thedraft() method to configure the file reader (where applicable), and finally resizes the image.

Note that this function modifies the Imageobject in place. If you need to use the full resolution image as well, apply this method to a copy() of the original image.

Parameters:

Returns:

None

Image.tobitmap(name: str = 'image') → bytes[source]

Returns the image converted to an X11 bitmap.

Note

This method only works for mode “1” images.

Parameters:

name – The name prefix to use for the bitmap variables.

Returns:

A string containing an X11 bitmap.

Raises:

ValueError – If the mode is not “1”

Image.tobytes(encoder_name: str = 'raw', *args: Any) → bytes[source]

Return image as a bytes object.

Warning

This method returns the raw image data from the internal storage. For compressed image data (e.g. PNG, JPEG) usesave(), with a BytesIO parameter for in-memory data.

Parameters:

Returns:

A bytes object.

Image.transform(size: tuple[int, int], method: Transform | ImageTransformHandler | SupportsGetData, data: Sequence[Any] | None = None, resample: int = Resampling.NEAREST, fill: int = 1, fillcolor: float | tuple[float, ...] | str | None = None) → Image[source]

Transforms this image. This method creates a new image with the given size, and the same mode as the original, and copies data to the new image using the given transform.

Parameters:

Implementations of ImageTransformHandlerfor some of the Transform methods are provided in ImageTransform.
It may also be an object with a method.getdata method that returns a tuple supplying new method and data values:
class Example:
def getdata(self):
method = Image.Transform.EXTENT
data = (0, 0, 100, 100)
return method, data

Returns:

An Image object.

Image.transpose(method: Transpose) → Image[source]

Transpose image (flip or rotate in 90 degree steps)

Parameters:

method – One of Transpose.FLIP_LEFT_RIGHT,Transpose.FLIP_TOP_BOTTOM, Transpose.ROTATE_90,Transpose.ROTATE_180, Transpose.ROTATE_270,Transpose.TRANSPOSE or Transpose.TRANSVERSE.

Returns:

Returns a flipped or rotated copy of this image.

This flips the input image by using the Transpose.FLIP_LEFT_RIGHTmethod.

from PIL import Image

with Image.open("hopper.jpg") as im:

# Flip the image from left to right
im_flipped = im.transpose(method=Image.Transpose.FLIP_LEFT_RIGHT)
# To flip the image from top to bottom,
# use the method "Image.Transpose.FLIP_TOP_BOTTOM"

Image.verify() → None[source]

Verifies the contents of a file. For data read from a file, this method attempts to determine if the file is broken, without actually decoding the image data. If this method finds any problems, it raises suitable exceptions. If you need to load the image after using this method, you must reopen the image file.

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

Allocates storage for the image and loads the pixel data. In normal cases, you don’t need to call this method, since the Image class automatically loads an opened image when it is accessed for the first time.

If the file associated with the image was opened by Pillow, then this method will close it. The exception to this is if the image has multiple frames, in which case the file will be left open for seek operations. See File Handling in Pillow for more information.

Returns:

An image access object.

Return type:

PixelAccess

Image.close() → None[source]

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.

Image Attributes

Instances of the Image class have the following attributes:

Image.filename_: str_

The filename or path of the source file. Only images created with the factory function open have a filename attribute. If the input is a file like object, the filename attribute is set to an empty string.

Image.format_: str | None_

The file format of the source file. For images created by the library itself (via a factory function, or by running a method on an existing image), this attribute is set to None.

Image.mode_: str_

Image mode. This is a string specifying the pixel format used by the image. Typical values are “1”, “L”, “RGB”, or “CMYK.” SeeModes for a full list.

Image.size_: tuple[int]_

Image size, in pixels. The size is given as a 2-tuple (width, height).

Image.width_: int_

Image width, in pixels.

Image.height_: int_

Image height, in pixels.

Image.palette_: PIL.ImagePalette.ImagePalette | None_

Colour palette table, if any. If mode is “P” or “PA”, this should be an instance of the ImagePalette class. Otherwise, it should be set to None.

Image.info_: dict_

A dictionary holding data associated with the image. This dictionary is used by file handlers to pass on various non-image information read from the file. See documentation for the various file handlers for details.

Most methods ignore the dictionary when returning new images; since the keys are not standardized, it’s not possible for a method to know if the operation affects the dictionary. If you need the information later on, keep a reference to the info dictionary returned from the open method.

Unless noted elsewhere, this dictionary does not affect saving files.

Image.is_animated_: bool_

True if this image has more than one frame, or False otherwise.

This attribute is only defined by image plugins that support animated images. Plugins may leave this attribute undefined if they don’t support loading animated images, even if the given format supports animated images.

Given that this attribute is not present for all images usegetattr(image, "is_animated", False) to check if Pillow is aware of multiple frames in an image regardless of its format.

See also

n_frames, seek() and tell()

Image.n_frames_: int_

The number of frames in this image.

This attribute is only defined by image plugins that support animated images. Plugins may leave this attribute undefined if they don’t support loading animated images, even if the given format supports animated images.

Given that this attribute is not present for all images usegetattr(image, "n_frames", 1) to check the number of frames that Pillow is aware of in an image regardless of its format.

See also

is_animated, seek() and tell()

Image.has_transparency_data

Determine if an image has transparency data, whether in the form of an alpha channel, a palette with an alpha channel, or a “transparency” key in the info dictionary.

Note the image might still appear solid, if all of the values shown within are opaque.

Returns:

A boolean.

Classes

class PIL.Image.Exif[source]

Bases: MutableMapping

This class provides read and write access to EXIF image data:

from PIL import Image im = Image.open("exif.png") exif = im.getexif() # Returns an instance of this class

Information can be read and written, iterated over or deleted:

print(exif[274]) # 1 exif[274] = 2 for k, v in exif.items(): print("Tag", k, "Value", v) # Tag 274 Value 2 del exif[274]

To access information beyond IFD0, get_ifd()returns a dictionary:

from PIL import ExifTags im = Image.open("exif_gps.jpg") exif = im.getexif() gps_ifd = exif.get_ifd(ExifTags.IFD.GPSInfo) print(gps_ifd)

Other IFDs include ExifTags.IFD.Exif, ExifTags.IFD.MakerNote,ExifTags.IFD.Interop and ExifTags.IFD.IFD1.

ExifTags also has enum classes to provide names for data:

print(exif[ExifTags.Base.Software]) # PIL print(gps_ifd[ExifTags.GPS.GPSDateStamp]) # 1999:99:99 99:99:99

bigtiff = False

endian_: str | None_ = None

get_ifd(tag: int) → dict[int, Any][source]

hide_offsets() → None[source]

load(data: bytes) → None[source]

load_from_fp(fp: IO[bytes], offset: int | None = None) → None[source]

tobytes(offset: int = 8) → bytes[source]

class PIL.Image.ImagePointHandler[source]

Used as a mixin by point transforms (for use with point())

class PIL.Image.ImagePointTransform(scale: float, offset: float)[source]

Used with point() for single band images with more than 8 bits, this represents an affine transformation, where the value is multiplied byscale and offset is added.

class PIL.Image.ImageTransformHandler[source]

Used as a mixin by geometry transforms (for use with transform())

Protocols

class PIL.Image.SupportsArrayInterface(*args, **kwargs)[source]

Bases: Protocol

An object that has an __array_interface__ dictionary.

class PIL.Image.SupportsArrowArrayInterface(*args, **kwargs)[source]

Bases: Protocol

An object that has an __arrow_c_array__ method corresponding to the arrow c data interface.

class PIL.Image.SupportsGetData(*args, **kwargs)[source]

Bases: Protocol

Constants

PIL.Image.NONE

PIL.Image.MAX_IMAGE_PIXELS

Set to 89,478,485, approximately 0.25GB for a 24-bit (3 bpp) image. See open() for more information about how this is used.

PIL.Image.WARN_POSSIBLE_FORMATS

Set to false. If true, when an image cannot be identified, warnings will be raised from formats that attempted to read the data.

Transpose methods

Used to specify the Image.transpose() method to use.

class PIL.Image.Transpose(*values)[source]

FLIP_LEFT_RIGHT = 0

FLIP_TOP_BOTTOM = 1

ROTATE_180 = 3

ROTATE_270 = 4

ROTATE_90 = 2

TRANSPOSE = 5

TRANSVERSE = 6

Transform methods

Used to specify the Image.transform() method to use.

class PIL.Image.Transform[source]

AFFINE

Affine transform

EXTENT

Cut out a rectangular subregion

PERSPECTIVE

Perspective transform

QUAD

Map a quadrilateral to a rectangle

MESH

Map a number of source quadrilaterals in one operation

Resampling filters

See Filters for details.

class PIL.Image.Resampling(*values)[source]

BICUBIC = 3

BILINEAR = 2

BOX = 4

HAMMING = 5

LANCZOS = 1

NEAREST = 0

Dither modes

Used to specify the dithering method to use for theconvert() and quantize() methods.

class PIL.Image.Dither[source]

NONE

No dither

ORDERED

Not implemented

RASTERIZE

Not implemented

FLOYDSTEINBERG

Floyd-Steinberg dither

Palettes

Used to specify the palette to use for the convert() method.

class PIL.Image.Palette(*values)[source]

ADAPTIVE = 1

WEB = 0

Quantization methods

Used to specify the quantization method to use for the quantize() method.

class PIL.Image.Quantize[source]

MEDIANCUT

Median cut. Default method, except for RGBA images. This method does not support RGBA images.

MAXCOVERAGE

Maximum coverage. This method does not support RGBA images.

FASTOCTREE

Fast octree. Default method for RGBA images.

LIBIMAGEQUANT

libimagequant

Check support using PIL.features.check_feature() withfeature="libimagequant".