python-pillow/Pillow
1
1
Fork 0
mirror of https://github.com/python-pillow/Pillow.git synced 2024-12-26 01:46:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

document is_animated and n_frames

Browse Source
This commit is contained in:
nulano 2020-06-27 17:24:13 +02:00
parent b4e7202dcb
commit f5b4565d8c
2 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/reference/Image.rst
View File

@ -324,3 +324,34 @@ Instances of the :py:class:`Image` class have the following attributes:
Unless noted elsewhere, this dictionary does not affect saving files.
:type: :py:class:`dict`
.. py:attribute:: Image.is_animated
:type: bool
This attribute is ``True`` if the Image is animated, ``False`` otherwise.
Typically defined as ``Image.n_frames > 1``.
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. Use
``hasattr(image, "is_animated")`` to check whether the implementation
supports animated images, or ``getattr(image, "is_animated", False)``
to check whether an image has been loaded with animation support.
.. seealso:: :attr:`~Image.n_frames`, :func:`~Image.seek` and :func:`~Image.tell`
.. py:attribute:: Image.n_frames
:type: int
The number of frames in this image.
Defined if and only if :attr:`~Image.is_animated` is also defined.
Equal to 1 for non-animated images loaded by a plugin supporting animations.
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. Use
``hasattr(image, "is_animated")`` to check whether the implementation
supports animated images, or ``getattr(image, "n_frames", 1)``
to check whether an image has been loaded with more than one frame.
.. seealso:: :attr:`~Image.is_animated`, :func:`~Image.seek` and :func:`~Image.tell`

6
src/PIL/Image.py
View File

@ -2170,6 +2170,9 @@ class Image:
See :py:meth:`~PIL.Image.Image.tell`.
If defined, :attr:`~PIL.Image.Image.n_frames` refers to the
number of available frames.
:param frame: Frame number, starting at 0.
:exception EOFError: If the call attempts to seek beyond the end
of the sequence.
@ -2254,6 +2257,9 @@ class Image:
"""
Returns the current frame number. See :py:meth:`~PIL.Image.Image.seek`.
If defined, :attr:`~PIL.Image.Image.n_frames` refers to the
number of available frames.
:returns: Frame number, starting with 0.
"""
return 0