python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2024-11-11 04:07:21 +03:00
Code Issues Packages Projects Releases Wiki Activity

avoid suggesting that Pillow understands animation in all formats

Browse Source 
Co-authored-by: Andrew Murray <3112309+radarhere@users.noreply.github.com>
This commit is contained in:
nulano 2020-07-09 17:16:41 +02:00
parent 91bd2d3752
commit c244ecf245
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/Image.rst
View File

@ -339,8 +339,9 @@ Instances of the :py:class:`Image` class have the following attributes:
Plugins may leave this attribute undefined if they don't support loading
animated images, even if the given format supports animated images.
To check whether an image is animated regardless of its format, use
``getattr(image, "is_animated", False)``.
Given that this attribute is not present for all images use
``getattr(image, "is_animated", False)`` to check if Pillow is aware of multiple
frames in an image regardless of its format.
.. seealso:: :attr:`~Image.n_frames`, :func:`~Image.seek` and :func:`~Image.tell`
@ -353,8 +354,9 @@ Instances of the :py:class:`Image` class have the following attributes:
Plugins may leave this attribute undefined if they don't support loading
animated images, even if the given format supports animated images.
To check the number of frames in an image regardless of its format, use
``getattr(image, "n_frames", 1)``.
Given that this attribute is not present for all images use
``getattr(image, "n_frames", 1)`` to check the number of frames that Pillow is
aware of in an image regardless of its format.
.. seealso:: :attr:`~Image.is_animated`, :func:`~Image.seek` and :func:`~Image.tell`