Skip to content

Commit

Permalink
Merge pull request #7635 from radarhere/type_hints_imagesequence
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk committed Dec 25, 2023
2 parents df83428 + f8d7503 commit fbecf77
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
6 changes: 3 additions & 3 deletions src/PIL/Image.py
Original file line number Diff line number Diff line change
Expand Up @@ -1181,7 +1181,7 @@ def quantize(

return im

def copy(self):
def copy(self) -> Image:
"""
Copies this image. Use this method if you wish to paste things
into an image, but still retain the original.
Expand Down Expand Up @@ -2450,7 +2450,7 @@ def save(self, fp, format=None, **params):
if open_fp:
fp.close()

def seek(self, frame):
def seek(self, frame) -> Image:
"""
Seeks to the given frame in this sequence file. If you seek
beyond the end of the sequence, the method raises an
Expand Down Expand Up @@ -2537,7 +2537,7 @@ def getchannel(self, channel):

return self._new(self.im.getband(channel))

def tell(self):
def tell(self) -> int:
"""
Returns the current frame number. See :py:meth:`~PIL.Image.Image.seek`.
Expand Down
17 changes: 12 additions & 5 deletions src/PIL/ImageSequence.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
##
from __future__ import annotations

from typing import Callable

from . import Image


class Iterator:
"""
Expand All @@ -29,25 +33,25 @@ class Iterator:
:param im: An image object.
"""

def __init__(self, im):
def __init__(self, im: Image.Image):
if not hasattr(im, "seek"):
msg = "im must have seek method"
raise AttributeError(msg)
self.im = im
self.position = getattr(self.im, "_min_frame", 0)

def __getitem__(self, ix):
def __getitem__(self, ix: int) -> Image.Image:
try:
self.im.seek(ix)
return self.im
except EOFError as e:
msg = "end of sequence"
raise IndexError(msg) from e

def __iter__(self):
def __iter__(self) -> Iterator:
return self

def __next__(self):
def __next__(self) -> Image.Image:
try:
self.im.seek(self.position)
self.position += 1
Expand All @@ -57,7 +61,10 @@ def __next__(self):
raise StopIteration(msg) from e


def all_frames(im, func=None):
def all_frames(
im: Image.Image | list[Image.Image],
func: Callable[[Image.Image], Image.Image] | None = None,
) -> list[Image.Image]:
"""
Applies a given function to all frames in an image or a list of images.
The frames are returned as a list of separate images.
Expand Down

0 comments on commit fbecf77

Please sign in to comment.