Pillow icon indicating copy to clipboard operation
Pillow copied to clipboard

Add type hints

Open radarhere opened this issue 1 year ago • 2 comments

Resolves #8029

In order to add type hints to the following Image methods

def __enter__(self):
def _close_fp(self):
def __exit__(self, *args):

I've made a few changes.

Image now has

def __enter__(self) -> Image:
def __exit__(self, *args: object) -> None:

I added an __enter__() and __exit__() to ImageFile, so that with Image.open(...): will type hint an ImageFile instance. I also moved _close_fp() to ImageFile, as it is only used when exiting an ImageFile instance.

def __enter__(self) -> ImageFile:
def _close_fp(self) -> None:
def __exit__(self, *args: object) -> None:

I also moved get_child_images() from Image to ImageFile. It requires the use of self.fp, so this made sense to me, but feel to tell me it should stay in Image.

Believe it or not, all the other changes in this PR flowed out from there.

radarhere avatar Sep 09 '24 12:09 radarhere

This is such a big PR I've not found time to review it yet, so let's either ask for reviewers from the community (for example, via https://github.com/python-pillow/Pillow/issues/8029), or just go ahead and merge it if you'd like it in the next release.

hugovk avatar Dec 22 '24 14:12 hugovk

I've commented in #8029 asking for reviews, but I'll also try and break this down into smaller PRs, like #8617. The PRs won't help external type hinting by themselves, but they should still individually make sense.

radarhere avatar Dec 23 '24 00:12 radarhere