From a1ddb4dd27690ba979ffcee7822ac8d25d5d68a1 Mon Sep 17 00:00:00 2001 From: Andrew Murray Date: Sun, 15 Oct 2023 16:17:19 +1100 Subject: [PATCH] Describe how to populate mode and size --- .../writing-your-own-image-plugin.rst | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/handbook/writing-your-own-image-plugin.rst b/docs/handbook/writing-your-own-image-plugin.rst index ca16fccda6a..ad1bf7f9523 100644 --- a/docs/handbook/writing-your-own-image-plugin.rst +++ b/docs/handbook/writing-your-own-image-plugin.rst @@ -26,14 +26,14 @@ Pillow decodes files in two stages: it. An image plugin should contain a format handler derived from the -:py:class:`PIL.ImageFile.ImageFile` base class. This class should -provide an ``_open`` method, which reads the file header and -sets up at least the :py:attr:`~PIL.Image.Image.mode` and -:py:attr:`~PIL.Image.Image.size` attributes. To be able to load the -file, the method must also create a list of ``tile`` descriptors, -which contain a decoder name, extents of the tile, and -any decoder-specific data. The format handler class must be explicitly -registered, via a call to the :py:mod:`~PIL.Image` module. +:py:class:`PIL.ImageFile.ImageFile` base class. This class should provide an +``_open`` method, which reads the file header and set at least the internal +``_size`` and ``_mode`` attributes so that :py:attr:`~PIL.Image.Image.mode` and +:py:attr:`~PIL.Image.Image.size` are populated. To be able to load the file, +the method must also create a list of ``tile`` descriptors, which contain a +decoder name, extents of the tile, and any decoder-specific data. The format +handler class must be explicitly registered, via a call to the +:py:mod:`~PIL.Image` module. .. note:: For performance reasons, it is important that the ``_open`` method quickly rejects files that do not have the @@ -96,13 +96,13 @@ true color. ) -The format handler must always set the -:py:attr:`~PIL.Image.Image.size` and :py:attr:`~PIL.Image.Image.mode` -attributes. If these are not set, the file cannot be opened. To -simplify the plugin, the calling code considers exceptions like -:py:exc:`SyntaxError`, :py:exc:`KeyError`, :py:exc:`IndexError`, -:py:exc:`EOFError` and :py:exc:`struct.error` as a failure to identify -the file. +The format handler must always set the internal ``_size`` and ``_mode`` +attributes so that :py:attr:`~PIL.Image.Image.size` and +:py:attr:`~PIL.Image.Image.mode` are populated. If these are not set, the file +cannot be opened. To simplify the plugin, the calling code considers exceptions +like :py:exc:`SyntaxError`, :py:exc:`KeyError`, :py:exc:`IndexError`, +:py:exc:`EOFError` and :py:exc:`struct.error` as a failure to identify the +file. Note that the image plugin must be explicitly registered using :py:func:`PIL.Image.register_open`. Although not required, it is also a good