Pillow (PIL Fork) Documentation Release 8.3.2
Total Page:16
File Type:pdf, Size:1020Kb
Pillow (PIL Fork) Documentation Release 8.3.2 Alex Clark Sep 02, 2021 CONTENTS 1 Overview 3 1.1 Installation................................................3 1.2 Handbook................................................ 12 1.3 Reference................................................. 53 1.4 Porting.................................................. 180 1.5 About................................................... 181 1.6 Release Notes............................................... 181 1.7 Deprecations and removals........................................ 234 2 Indices and tables 239 Python Module Index 241 Index 243 i ii Pillow (PIL Fork) Documentation, Release 8.3.2 Pillow is the friendly PIL fork by Alex Clark and Contributors. PIL is the Python Imaging Library by Fredrik Lundh and Contributors. Pillow for enterprise is available via the Tidelift Subscription. Learn more. CONTENTS 1 Pillow (PIL Fork) Documentation, Release 8.3.2 2 CONTENTS CHAPTER ONE OVERVIEW The Python Imaging Library adds image processing capabilities to your Python interpreter. This library provides extensive file format support, an efficient internal representation, and fairly powerful image pro- cessing capabilities. The core image library is designed for fast access to data stored in a few basic pixel formats. It should provide a solid foundation for a general image processing tool. 1.1 Installation 1.1.1 Warnings Warning: Pillow and PIL cannot co-exist in the same environment. Before installing Pillow, please uninstall PIL. Warning: Pillow >= 1.0 no longer supports import Image. Please use from PIL import Image instead. Warning: Pillow >= 2.1.0 no longer supports import _imaging. Please use from PIL.Image import core as _imaging instead. 1.1.2 Python Support Pillow supports these Python versions. Python 3.10 3.9 3.8 3.7 3.6 3.5 3.4 2.7 Pillow >= 8.3.2 Yes Yes Yes Yes Yes Pillow 8.0 - 8.3.1 Yes Yes Yes Yes Pillow 7.0 - 7.2 Yes Yes Yes Yes Pillow 6.2.1 - 6.2.2 Yes Yes Yes Yes Yes Pillow 6.0 - 6.2.0 Yes Yes Yes Yes Pillow 5.2 - 5.4 Yes Yes Yes Yes Yes 3 Pillow (PIL Fork) Documentation, Release 8.3.2 Python 3.6 3.5 3.4 3.3 3.2 2.7 2.6 2.5 2.4 Pillow 5.0 - 5.1 Yes Yes Yes Yes Pillow 4 Yes Yes Yes Yes Yes Pillow 2 - 3 Yes Yes Yes Yes Yes Yes Pillow < 2 Yes Yes Yes Yes 1.1.3 Basic Installation Note: The following instructions will install Pillow with support for most common image formats. See External Libraries for a full list of external libraries supported. Install Pillow with pip: python3-m pip install--upgrade pip python3-m pip install--upgrade Pillow Windows Installation We provide Pillow binaries for Windows compiled for the matrix of supported Pythons in both 32 and 64-bit versions in the wheel format. These binaries include support for all optional libraries except libimagequant and libxcb. Raqm support requires FriBiDi to be installed separately: python3-m pip install--upgrade pip python3-m pip install--upgrade Pillow To install Pillow in MSYS2, see Building on Windows using MSYS2/MinGW. macOS Installation We provide binaries for macOS for each of the supported Python versions in the wheel format. These include support for all optional libraries except libimagequant. Raqm support requires FriBiDi to be installed separately: python3-m pip install--upgrade pip python3-m pip install--upgrade Pillow Linux Installation We provide binaries for Linux for each of the supported Python versions in the manylinux wheel format. These include support for all optional libraries except libimagequant. Raqm support requires FriBiDi to be installed separately: python3-m pip install--upgrade pip python3-m pip install--upgrade Pillow Most major Linux distributions, including Fedora, Ubuntu and ArchLinux also include Pillow in packages that previ- ously contained PIL e.g. python-imaging. Debian splits it into two packages, python3-pil and python3-pil. imagetk. 4 Chapter 1. Overview Pillow (PIL Fork) Documentation, Release 8.3.2 FreeBSD Installation Pillow can be installed on FreeBSD via the official Ports or Packages systems: Ports: cd/usr/ports/graphics/py-pillow&& make install clean Packages: pkg install py36-pillow Note: The Pillow FreeBSD port and packages are tested by the ports team with all supported FreeBSD versions. 1.1.4 Building From Source Download and extract the compressed archive from PyPI. External Libraries Note: You do not need to install all supported external libraries to use Pillow’s basic features. Zlib and libjpeg are required by default. Note: There are Dockerfiles in our Docker images repo to install the dependencies for some operating systems. Many of Pillow’s features require external libraries: • libjpeg provides JPEG functionality. – Pillow has been tested with libjpeg versions 6b, 8, 9-9d and libjpeg-turbo version 8. – Starting with Pillow 3.0.0, libjpeg is required by default, but may be disabled with the --disable-jpeg flag. • zlib provides access to compressed PNGs – Starting with Pillow 3.0.0, zlib is required by default, but may be disabled with the --disable-zlib flag. • libtiff provides compressed TIFF functionality – Pillow has been tested with libtiff versions 3.x and 4.0-4.3 • libfreetype provides type related services • littlecms provides color management – Pillow version 2.2.1 and below uses liblcms1, Pillow 2.3.0 and above uses liblcms2. Tested with 1.19 and 2.7-2.12. • libwebp provides the WebP format. – Pillow has been tested with version 0.1.3, which does not read transparent WebP files. Versions 0.3.0 and above support transparency. • tcl/tk provides support for tkinter bitmap and photo images. 1.1. Installation 5 Pillow (PIL Fork) Documentation, Release 8.3.2 • openjpeg provides JPEG 2000 functionality. – Pillow has been tested with openjpeg 2.0.0, 2.1.0, 2.3.1 and 2.4.0. – Pillow does not support the earlier 1.5 series which ships with Debian Jessie. • libimagequant provides improved color quantization – Pillow has been tested with libimagequant 2.6-2.15.1 – Libimagequant is licensed GPLv3, which is more restrictive than the Pillow license, therefore we will not be distributing binaries with libimagequant support enabled. • libraqm provides complex text layout support. – libraqm provides bidirectional text support (using FriBiDi), shaping (using HarfBuzz), and proper script itemization. As a result, Raqm can support most writing systems covered by Unicode. – libraqm depends on the following libraries: FreeType, HarfBuzz, FriBiDi, make sure that you install them before installing libraqm if not available as package in your system. – Setting text direction or font features is not supported without libraqm. – Pillow wheels since version 8.2.0 include a modified version of libraqm that loads libfribidi at runtime ifitis installed. On Windows this requires compiling FriBiDi and installing fribidi.dll into a directory listed in the Dynamic-Link Library Search Order (Microsoft Docs)( fribidi-0.dll or libfribidi-0.dll are also detected). See Build Options to see how to build this version. – Previous versions of Pillow (5.0.0 to 8.1.2) linked libraqm dynamically at runtime. • libxcb provides X11 screengrab support. Once you have installed the prerequisites, run: python3-m pip install--upgrade pip python3-m pip install--upgrade Pillow If the prerequisites are installed in the standard library locations for your machine (e.g. /usr or /usr/local), no additional configuration should be required. If they are installed in a non-standard location, you may need toconfigure setuptools to use those locations by editing setup.py or setup.cfg, or by adding environment variables on the command line: CFLAGS="-I/usr/pkg/include" python3-m pip install--upgrade Pillow If Pillow has been previously built without the required prerequisites, it may be necessary to manually clear the pip cache or build without cache using the --no-cache-dir option to force a build with newly installed external libraries. Build Options • Environment variable: MAX_CONCURRENCY=n. Pillow can use multiprocessing to build the extension. Setting MAX_CONCURRENCY sets the number of CPUs to use, or can disable parallel building by using a setting of 1. By default, it uses 4 CPUs, or if 4 are not available, as many as are present. • Build flags: --disable-zlib, --disable-jpeg, --disable-tiff, --disable-freetype, --disable-lcms, --disable-webp, --disable-webpmux, --disable-jpeg2000, --disable-imagequant, --disable-xcb. Disable building the corresponding feature even if the de- velopment libraries are present on the building machine. 6 Chapter 1. Overview Pillow (PIL Fork) Documentation, Release 8.3.2 • Build flags: --enable-zlib, --enable-jpeg, --enable-tiff, --enable-freetype, --enable-lcms, --enable-webp, --enable-webpmux, --enable-jpeg2000, --enable-imagequant, --enable-xcb. Re- quire that the corresponding feature is built. The build will raise an exception if the libraries are not found. Webpmux (WebP metadata) relies on WebP support. Tcl and Tk also must be used together. • Build flags: --vendor-raqm --vendor-fribidi These flags are used to compile a modified version ofli- braqm and a shim that dynamically loads libfribidi at runtime. These are used to compile the standard Pillow wheels. Compiling libraqm requires a C99-compliant compiler. • Build flag: --disable-platform-guessing. Skips all of the platform dependent guessing of include and library directories for automated build systems that configure the proper paths in the environment variables (e.g. Buildroot). • Build flag: --debug. Adds a debugging flag to the include and library search process to dump all paths searched for and found to stdout. Sample usage: MAX_CONCURRENCY=1 python3 setup.py build_ext--enable-[feature] install or using pip: python3-m pip install--upgrade Pillow-- global-option="build_ext"-- global-option="-- ,!enable-[feature]" Building on macOS The Xcode command line tools are required to compile portions of Pillow. The tools are installed by running xcode-select --install from the command line. The command line tools are required even if you have the full Xcode package installed.