python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2025-01-28 02:04:36 +03:00
Code Issues Packages Projects Releases Wiki Activity

Changed PIL references to Pillow [ci skip]

Browse Source
This commit is contained in:
Andrew Murray 2019-03-08 20:58:29 +11:00
parent 1c1bad3186
commit 2764031762
1 changed files with 55 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
docs/handbook/image-file-formats.rst
View File

@ -21,7 +21,7 @@ Fully supported formats
BMP BMP
^^^ ^^^
PIL reads and writes Windows and OS/2 BMP files containing ``1``, ``L``, ``P``, Pillow reads and writes Windows and OS/2 BMP files containing ``1``, ``L``, ``P``,
or ``RGB`` data. 16-colour images are read as ``P`` images. Run-length encoding or ``RGB`` data. 16-colour images are read as ``P`` images. Run-length encoding
is not supported. is not supported.
@ -34,7 +34,7 @@ The :py:meth:`~PIL.Image.Image.open` method sets the following
DIB DIB
^^^ ^^^
PIL reads and writes DIB files. DIB files are similar to BMP files, so see Pillow reads and writes DIB files. DIB files are similar to BMP files, so see
above for more information. above for more information.
.. versionadded:: 6.0.0 .. versionadded:: 6.0.0
@ -42,10 +42,10 @@ above for more information.
EPS EPS
^^^ ^^^
PIL identifies EPS files containing image data, and can read files that contain Pillow identifies EPS files containing image data, and can read files that
embedded raster images (ImageData descriptors). If Ghostscript is available, contain embedded raster images (ImageData descriptors). If Ghostscript is
other EPS files can be read as well. The EPS driver can also write EPS available, other EPS files can be read as well. The EPS driver can also write
images. The EPS driver can read EPS images in ``L``, ``LAB``, ``RGB`` and EPS images. The EPS driver can read EPS images in ``L``, ``LAB``, ``RGB`` and
``CMYK`` mode, but Ghostscript may convert the images to ``RGB`` mode rather ``CMYK`` mode, but Ghostscript may convert the images to ``RGB`` mode rather
than leaving them in the original color space. The EPS driver can write images than leaving them in the original color space. The EPS driver can write images
in ``L``, ``RGB`` and ``CMYK`` modes. in ``L``, ``RGB`` and ``CMYK`` modes.
@ -67,8 +67,8 @@ method with the following parameter to affect how Ghostscript renders the EPS
GIF GIF
^^^ ^^^
PIL reads GIF87a and GIF89a versions of the GIF file format. The library writes Pillow reads GIF87a and GIF89a versions of the GIF file format. The library
run-length encoded files in GIF87a by default, unless GIF89a features writes run-length encoded files in GIF87a by default, unless GIF89a features
are used or GIF89a is already in use. are used or GIF89a is already in use.
Note that GIF files are always read as grayscale (``L``) Note that GIF files are always read as grayscale (``L``)
@ -200,7 +200,7 @@ attributes before loading the file::
ICNS ICNS
^^^^ ^^^^
PIL reads and (macOS only) writes macOS ``.icns`` files. By default, the Pillow reads and (macOS only) writes macOS ``.icns`` files. By default, the
largest available icon is read, though you can override this by setting the largest available icon is read, though you can override this by setting the
:py:attr:`~PIL.Image.Image.size` property before calling :py:attr:`~PIL.Image.Image.size` property before calling
:py:meth:`~PIL.Image.Image.load`. The :py:meth:`~PIL.Image.Image.open` method :py:meth:`~PIL.Image.Image.load`. The :py:meth:`~PIL.Image.Image.open` method
@ -245,12 +245,12 @@ IM is a format used by LabEye and other applications based on the IFUNC image
processing library. The library reads and writes most uncompressed interchange processing library. The library reads and writes most uncompressed interchange
versions of this format. versions of this format.
IM is the only format that can store all internal PIL formats. IM is the only format that can store all internal Pillow formats.
JPEG JPEG
^^^^ ^^^^
PIL reads JPEG, JFIF, and Adobe JPEG files containing ``L``, ``RGB``, or Pillow reads JPEG, JFIF, and Adobe JPEG files containing ``L``, ``RGB``, or
``CMYK`` data. It writes standard and progressive JFIF files. ``CMYK`` data. It writes standard and progressive JFIF files.
Using the :py:meth:`~PIL.Image.Image.draft` method, you can speed things up by Using the :py:meth:`~PIL.Image.Image.draft` method, you can speed things up by
@ -362,15 +362,15 @@ JPEG 2000
.. versionadded:: 2.4.0 .. versionadded:: 2.4.0
PIL reads and writes JPEG 2000 files containing ``L``, ``LA``, ``RGB`` or Pillow reads and writes JPEG 2000 files containing ``L``, ``LA``, ``RGB`` or
``RGBA`` data. It can also read files containing ``YCbCr`` data, which it ``RGBA`` data. It can also read files containing ``YCbCr`` data, which it
converts on read into ``RGB`` or ``RGBA`` depending on whether or not there is converts on read into ``RGB`` or ``RGBA`` depending on whether or not there is
an alpha channel. PIL supports JPEG 2000 raw codestreams (``.j2k`` files), as an alpha channel. Pillow supports JPEG 2000 raw codestreams (``.j2k`` files),
well as boxed JPEG 2000 files (``.j2p`` or ``.jpx`` files). PIL does *not* as well as boxed JPEG 2000 files (``.j2p`` or ``.jpx`` files). Pillow does
support files whose components have different sampling frequencies. *not* support files whose components have different sampling frequencies.
When loading, if you set the ``mode`` on the image prior to the When loading, if you set the ``mode`` on the image prior to the
:py:meth:`~PIL.Image.Image.load` method being invoked, you can ask PIL to :py:meth:`~PIL.Image.Image.load` method being invoked, you can ask Pillow to
convert the image to either ``RGB`` or ``RGBA`` rather than choosing for convert the image to either ``RGB`` or ``RGBA`` rather than choosing for
itself. It is also possible to set ``reduce`` to the number of resolutions to itself. It is also possible to set ``reduce`` to the number of resolutions to
discard (each one reduces the size of the resulting image by a factor of 2), discard (each one reduces the size of the resulting image by a factor of 2),
@ -441,25 +441,25 @@ The :py:meth:`~PIL.Image.Image.save` method supports the following options:
Library. Library.
Windows users can install the OpenJPEG binaries available on the Windows users can install the OpenJPEG binaries available on the
OpenJPEG website, but must add them to their PATH in order to use PIL (if OpenJPEG website, but must add them to their PATH in order to use Pillow (if
you fail to do this, you will get errors about not being able to load the you fail to do this, you will get errors about not being able to load the
``_imaging`` DLL). ``_imaging`` DLL).
MSP MSP
^^^ ^^^
PIL identifies and reads MSP files from Windows 1 and 2. The library writes Pillow identifies and reads MSP files from Windows 1 and 2. The library writes
uncompressed (Windows 1) versions of this format. uncompressed (Windows 1) versions of this format.
PCX PCX
^^^ ^^^
PIL reads and writes PCX files containing ``1``, ``L``, ``P``, or ``RGB`` data. Pillow reads and writes PCX files containing ``1``, ``L``, ``P``, or ``RGB`` data.
PNG PNG
^^^ ^^^
PIL identifies, reads, and writes PNG files containing ``1``, ``L``, ``P``, Pillow identifies, reads, and writes PNG files containing ``1``, ``L``, ``P``,
``RGB``, or ``RGBA`` data. Interlaced files are supported as of v1.1.7. ``RGB``, or ``RGBA`` data. Interlaced files are supported as of v1.1.7.
The :py:meth:`~PIL.Image.Image.open` method sets the following The :py:meth:`~PIL.Image.Image.open` method sets the following
@ -543,8 +543,8 @@ The :py:meth:`~PIL.Image.Image.save` method supports the following options:
PPM PPM
^^^ ^^^
PIL reads and writes PBM, PGM and PPM files containing ``1``, ``L`` or ``RGB`` Pillow reads and writes PBM, PGM and PPM files containing ``1``, ``L`` or
data. ``RGB`` data.
SGI SGI
^^^ ^^^
@ -555,10 +555,10 @@ Pillow reads and writes uncompressed ``L``, ``RGB``, and ``RGBA`` files.
SPIDER SPIDER
^^^^^^ ^^^^^^
PIL reads and writes SPIDER image files of 32-bit floating point data Pillow reads and writes SPIDER image files of 32-bit floating point data
("F;32F"). ("F;32F").
PIL also reads SPIDER stack files containing sequences of SPIDER images. The Pillow also reads SPIDER stack files containing sequences of SPIDER images. The
:py:meth:`~file.seek` and :py:meth:`~file.tell` methods are supported, and :py:meth:`~file.seek` and :py:meth:`~file.tell` methods are supported, and
random access is allowed. random access is allowed.
@ -595,8 +595,8 @@ For more information about the SPIDER image processing package, see the
TGA TGA
^^^ ^^^
PIL reads and writes TGA images containing ``L``, ``LA``, ``P``, Pillow reads and writes TGA images containing ``L``, ``LA``, ``P``,
``RGB``, and ``RGBA`` data. PIL can read and write both uncompressed and ``RGB``, and ``RGBA`` data. Pillow can read and write both uncompressed and
run-length encoded TGAs. run-length encoded TGAs.
TIFF TIFF
@ -604,8 +604,8 @@ TIFF
Pillow reads and writes TIFF files. It can read both striped and tiled Pillow reads and writes TIFF files. It can read both striped and tiled
images, pixel and plane interleaved multi-band images. If you have images, pixel and plane interleaved multi-band images. If you have
libtiff and its headers installed, PIL can read and write many kinds libtiff and its headers installed, Pillow can read and write many kinds
of compressed TIFF files. If not, PIL will only read and write of compressed TIFF files. If not, Pillow will only read and write
uncompressed files. uncompressed files.
.. note:: .. note::
@ -742,8 +742,8 @@ using the general tags available through tiffinfo.
WebP WebP
^^^^ ^^^^
PIL reads and writes WebP files. The specifics of PIL's capabilities with this Pillow reads and writes WebP files. The specifics of Pillow's capabilities with
format are currently undocumented. this format are currently undocumented.
The :py:meth:`~PIL.Image.Image.save` method supports the following options: The :py:meth:`~PIL.Image.Image.save` method supports the following options:
@ -815,7 +815,7 @@ are available when the `save_all` argument is present and true.
XBM XBM
^^^ ^^^
PIL reads and writes X bitmap files (mode ``1``). Pillow reads and writes X bitmap files (mode ``1``).
Read-only formats Read-only formats
----------------- -----------------
@ -857,7 +857,7 @@ mode.
FLI, FLC FLI, FLC
^^^^^^^^ ^^^^^^^^
PIL reads Autodesk FLI and FLC animations. Pillow reads Autodesk FLI and FLC animations.
The :py:meth:`~PIL.Image.Image.open` method sets the following The :py:meth:`~PIL.Image.Image.open` method sets the following
:py:attr:`~PIL.Image.Image.info` properties: :py:attr:`~PIL.Image.Image.info` properties:
@ -868,7 +868,7 @@ The :py:meth:`~PIL.Image.Image.open` method sets the following
FPX FPX
^^^ ^^^
PIL reads Kodak FlashPix files. In the current version, only the highest Pillow reads Kodak FlashPix files. In the current version, only the highest
resolution image is read from the file, and the viewing transform is not taken resolution image is read from the file, and the viewing transform is not taken
into account. into account.
@ -904,7 +904,7 @@ The :py:meth:`~PIL.Image.Image.open` method sets the following
GD GD
^^ ^^
PIL reads uncompressed GD2 files. Note that you must use Pillow reads uncompressed GD2 files. Note that you must use
:py:func:`PIL.GdImageFile.open` to read such a file. :py:func:`PIL.GdImageFile.open` to read such a file.
The :py:meth:`~PIL.Image.Image.open` method sets the following The :py:meth:`~PIL.Image.Image.open` method sets the following
@ -917,23 +917,23 @@ The :py:meth:`~PIL.Image.Image.open` method sets the following
IMT IMT
^^^ ^^^
PIL reads Image Tools images containing ``L`` data. Pillow reads Image Tools images containing ``L`` data.
IPTC/NAA IPTC/NAA
^^^^^^^^ ^^^^^^^^
PIL provides limited read support for IPTC/NAA newsphoto files. Pillow provides limited read support for IPTC/NAA newsphoto files.
MCIDAS MCIDAS
^^^^^^ ^^^^^^
PIL identifies and reads 8-bit McIdas area files. Pillow identifies and reads 8-bit McIdas area files.
MIC MIC
^^^ ^^^
PIL identifies and reads Microsoft Image Composer (MIC) files. When opened, the Pillow identifies and reads Microsoft Image Composer (MIC) files. When opened,
first sprite in the file is loaded. You can use :py:meth:`~file.seek` and the first sprite in the file is loaded. You can use :py:meth:`~file.seek` and
:py:meth:`~file.tell` to read other sprites from the file. :py:meth:`~file.tell` to read other sprites from the file.
Note that there may be an embedded gamma of 2.2 in MIC files. Note that there may be an embedded gamma of 2.2 in MIC files.
@ -949,22 +949,22 @@ zero-indexed and random access is supported.
PCD PCD
^^^ ^^^
PIL reads PhotoCD files containing ``RGB`` data. This only reads the 768x512 Pillow reads PhotoCD files containing ``RGB`` data. This only reads the 768x512
resolution image from the file. Higher resolutions are encoded in a proprietary resolution image from the file. Higher resolutions are encoded in a proprietary
encoding. encoding.
PIXAR PIXAR
^^^^^ ^^^^^
PIL provides limited support for PIXAR raster files. The library can identify Pillow provides limited support for PIXAR raster files. The library can
and read “dumped” RGB files. identify and read “dumped” RGB files.
The format code is ``PIXAR``. The format code is ``PIXAR``.
PSD PSD
^^^ ^^^
PIL identifies and reads PSD files written by Adobe Photoshop 2.5 and 3.0. Pillow identifies and reads PSD files written by Adobe Photoshop 2.5 and 3.0.
WAL WAL
@ -972,7 +972,7 @@ WAL
.. versionadded:: 1.1.4 .. versionadded:: 1.1.4
PIL reads Quake2 WAL texture files. Pillow reads Quake2 WAL texture files.
Note that this file format cannot be automatically identified, so you must use Note that this file format cannot be automatically identified, so you must use
the open function in the :py:mod:`~PIL.WalImageFile` module to read files in the open function in the :py:mod:`~PIL.WalImageFile` module to read files in
@ -984,7 +984,7 @@ the palette, use the putpalette method.
XPM XPM
^^^ ^^^
PIL reads X pixmap files (mode ``P``) with 256 colors or less. Pillow reads X pixmap files (mode ``P``) with 256 colors or less.
The :py:meth:`~PIL.Image.Image.open` method sets the following The :py:meth:`~PIL.Image.Image.open` method sets the following
:py:attr:`~PIL.Image.Image.info` properties: :py:attr:`~PIL.Image.Image.info` properties:
@ -999,14 +999,14 @@ Write-only formats
PALM PALM
^^^^ ^^^^
PIL provides write-only support for PALM pixmap files. Pillow provides write-only support for PALM pixmap files.
The format code is ``Palm``, the extension is ``.palm``. The format code is ``Palm``, the extension is ``.palm``.
PDF PDF
^^^ ^^^
PIL can write PDF (Acrobat) images. Such images are written as binary PDF 1.4 Pillow can write PDF (Acrobat) images. Such images are written as binary PDF 1.4
files, using either JPEG or HEX encoding depending on the image mode (and files, using either JPEG or HEX encoding depending on the image mode (and
whether JPEG support is available or not). whether JPEG support is available or not).
@ -1085,7 +1085,7 @@ The :py:meth:`~PIL.Image.Image.save` method can take the following keyword argum
XV Thumbnails XV Thumbnails
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
PIL can read XV thumbnail files. Pillow can read XV thumbnail files.
Identify-only formats Identify-only formats
--------------------- ---------------------
@ -1095,7 +1095,7 @@ BUFR
.. versionadded:: 1.1.3 .. versionadded:: 1.1.3
PIL provides a stub driver for BUFR files. Pillow provides a stub driver for BUFR files.
To add read or write support to your application, use To add read or write support to your application, use
:py:func:`PIL.BufrStubImagePlugin.register_handler`. :py:func:`PIL.BufrStubImagePlugin.register_handler`.
@ -1105,7 +1105,7 @@ FITS
.. versionadded:: 1.1.5 .. versionadded:: 1.1.5
PIL provides a stub driver for FITS files. Pillow provides a stub driver for FITS files.
To add read or write support to your application, use To add read or write support to your application, use
:py:func:`PIL.FitsStubImagePlugin.register_handler`. :py:func:`PIL.FitsStubImagePlugin.register_handler`.
@ -1115,11 +1115,11 @@ GRIB
.. versionadded:: 1.1.5 .. versionadded:: 1.1.5
PIL provides a stub driver for GRIB files. Pillow provides a stub driver for GRIB files.
The driver requires the file to start with a GRIB header. If you have files The driver requires the file to start with a GRIB header. If you have files
with embedded GRIB data, or files with multiple GRIB fields, your application with embedded GRIB data, or files with multiple GRIB fields, your application
has to seek to the header before passing the file handle to PIL. has to seek to the header before passing the file handle to Pillow.
To add read or write support to your application, use To add read or write support to your application, use
:py:func:`PIL.GribStubImagePlugin.register_handler`. :py:func:`PIL.GribStubImagePlugin.register_handler`.
@ -1129,7 +1129,7 @@ HDF5
.. versionadded:: 1.1.5 .. versionadded:: 1.1.5
PIL provides a stub driver for HDF5 files. Pillow provides a stub driver for HDF5 files.
To add read or write support to your application, use To add read or write support to your application, use
:py:func:`PIL.Hdf5StubImagePlugin.register_handler`. :py:func:`PIL.Hdf5StubImagePlugin.register_handler`.
@ -1137,12 +1137,12 @@ To add read or write support to your application, use
MPEG MPEG
^^^^ ^^^^
PIL identifies MPEG files. Pillow identifies MPEG files.
WMF WMF
^^^ ^^^
PIL can identify playable WMF files. Pillow can identify playable WMF files.
In PIL 1.1.4 and earlier, the WMF driver provides some limited rendering In PIL 1.1.4 and earlier, the WMF driver provides some limited rendering
support, but not enough to be useful for any real application. support, but not enough to be useful for any real application.