Skip to content

Commit fd5df78

Browse files
authored
Merge pull request #7716 from radarhere/type_hints
2 parents ed9e29d + 575edbe commit fd5df78

File tree

10 files changed

+40
-21
lines changed

10 files changed

+40
-21
lines changed

src/PIL/Image.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3437,7 +3437,7 @@ def register_open(id, factory, accept=None) -> None:
34373437
OPEN[id] = factory, accept
34383438

34393439

3440-
def register_mime(id, mimetype):
3440+
def register_mime(id: str, mimetype: str) -> None:
34413441
"""
34423442
Registers an image MIME type by populating ``Image.MIME``. This function
34433443
should not be used in application code.
@@ -3452,7 +3452,7 @@ def register_mime(id, mimetype):
34523452
MIME[id.upper()] = mimetype
34533453

34543454

3455-
def register_save(id, driver):
3455+
def register_save(id: str, driver) -> None:
34563456
"""
34573457
Registers an image save function. This function should not be
34583458
used in application code.

src/PIL/ImageFile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,7 @@ def close(self):
514514
# --------------------------------------------------------------------
515515

516516

517-
def _save(im, fp, tile, bufsize=0):
517+
def _save(im, fp, tile, bufsize=0) -> None:
518518
"""Helper to save image based on tile list
519519
520520
:param im: Image object.

src/PIL/ImagePalette.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ def save(self, fp):
192192
# Internal
193193

194194

195-
def raw(rawmode, data):
195+
def raw(rawmode, data) -> ImagePalette:
196196
palette = ImagePalette()
197197
palette.rawmode = rawmode
198198
palette.palette = data

src/PIL/McIdasImagePlugin.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
from . import Image, ImageFile
2323

2424

25-
def _accept(s):
26-
return s[:8] == b"\x00\x00\x00\x00\x00\x00\x00\x04"
25+
def _accept(prefix: bytes) -> bool:
26+
return prefix[:8] == b"\x00\x00\x00\x00\x00\x00\x00\x04"
2727

2828

2929
##
@@ -34,8 +34,10 @@ class McIdasImageFile(ImageFile.ImageFile):
3434
format = "MCIDAS"
3535
format_description = "McIdas area file"
3636

37-
def _open(self):
37+
def _open(self) -> None:
3838
# parse area file directory
39+
assert self.fp is not None
40+
3941
s = self.fp.read(256)
4042
if not _accept(s) or len(s) != 256:
4143
msg = "not an McIdas area file"

src/PIL/PcdImagePlugin.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@ class PcdImageFile(ImageFile.ImageFile):
2727
format = "PCD"
2828
format_description = "Kodak PhotoCD"
2929

30-
def _open(self):
30+
def _open(self) -> None:
3131
# rough
32+
assert self.fp is not None
33+
3234
self.fp.seek(2048)
3335
s = self.fp.read(2048)
3436

@@ -47,9 +49,11 @@ def _open(self):
4749
self._size = 768, 512 # FIXME: not correct for rotated images!
4850
self.tile = [("pcd", (0, 0) + self.size, 96 * 2048, None)]
4951

50-
def load_end(self):
52+
def load_end(self) -> None:
5153
if self.tile_post_rotate:
5254
# Handle rotated PCDs
55+
assert self.im is not None
56+
5357
self.im = self.im.rotate(self.tile_post_rotate)
5458
self._size = self.im.size
5559

src/PIL/PcxImagePlugin.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
logger = logging.getLogger(__name__)
3838

3939

40-
def _accept(prefix):
40+
def _accept(prefix: bytes) -> bool:
4141
return prefix[0] == 10 and prefix[1] in [0, 2, 3, 5]
4242

4343

@@ -49,8 +49,10 @@ class PcxImageFile(ImageFile.ImageFile):
4949
format = "PCX"
5050
format_description = "Paintbrush"
5151

52-
def _open(self):
52+
def _open(self) -> None:
5353
# header
54+
assert self.fp is not None
55+
5456
s = self.fp.read(128)
5557
if not _accept(s):
5658
msg = "not a PCX file"
@@ -141,7 +143,7 @@ def _open(self):
141143
}
142144

143145

144-
def _save(im, fp, filename):
146+
def _save(im: Image.Image, fp: io.BytesIO, filename: str) -> None:
145147
try:
146148
version, bits, planes, rawmode = SAVE[im.mode]
147149
except KeyError as e:
@@ -199,6 +201,8 @@ def _save(im, fp, filename):
199201

200202
if im.mode == "P":
201203
# colour palette
204+
assert im.im is not None
205+
202206
fp.write(o8(12))
203207
palette = im.im.getpalette("RGB", "RGB")
204208
palette += b"\x00" * (768 - len(palette))

src/PIL/PixarImagePlugin.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
# helpers
2828

2929

30-
def _accept(prefix):
30+
def _accept(prefix: bytes) -> bool:
3131
return prefix[:4] == b"\200\350\000\000"
3232

3333

@@ -39,8 +39,10 @@ class PixarImageFile(ImageFile.ImageFile):
3939
format = "PIXAR"
4040
format_description = "PIXAR raster image"
4141

42-
def _open(self):
42+
def _open(self) -> None:
4343
# assuming a 4-byte magic label
44+
assert self.fp is not None
45+
4446
s = self.fp.read(4)
4547
if not _accept(s):
4648
msg = "not a PIXAR file"

src/PIL/SunImagePlugin.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
from ._binary import i32be as i32
2222

2323

24-
def _accept(prefix):
24+
def _accept(prefix: bytes) -> bool:
2525
return len(prefix) >= 4 and i32(prefix) == 0x59A66A95
2626

2727

@@ -33,7 +33,7 @@ class SunImageFile(ImageFile.ImageFile):
3333
format = "SUN"
3434
format_description = "Sun Raster File"
3535

36-
def _open(self):
36+
def _open(self) -> None:
3737
# The Sun Raster file header is 32 bytes in length
3838
# and has the following format:
3939

@@ -49,6 +49,8 @@ def _open(self):
4949
# DWORD ColorMapLength; /* Size of the color map in bytes */
5050
# } SUNRASTER;
5151

52+
assert self.fp is not None
53+
5254
# HEAD
5355
s = self.fp.read(32)
5456
if not _accept(s):

src/PIL/XVThumbImagePlugin.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
)
3434

3535

36-
def _accept(prefix):
36+
def _accept(prefix: bytes) -> bool:
3737
return prefix[:6] == _MAGIC
3838

3939

@@ -45,8 +45,10 @@ class XVThumbImageFile(ImageFile.ImageFile):
4545
format = "XVThumb"
4646
format_description = "XV thumbnail image"
4747

48-
def _open(self):
48+
def _open(self) -> None:
4949
# check magic
50+
assert self.fp is not None
51+
5052
if not _accept(self.fp.read(6)):
5153
msg = "not an XV thumbnail file"
5254
raise SyntaxError(msg)

src/PIL/XbmImagePlugin.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
from __future__ import annotations
2222

2323
import re
24+
from io import BytesIO
2425

2526
from . import Image, ImageFile
2627

@@ -36,7 +37,7 @@
3637
)
3738

3839

39-
def _accept(prefix):
40+
def _accept(prefix: bytes) -> bool:
4041
return prefix.lstrip()[:7] == b"#define"
4142

4243

@@ -48,7 +49,9 @@ class XbmImageFile(ImageFile.ImageFile):
4849
format = "XBM"
4950
format_description = "X11 Bitmap"
5051

51-
def _open(self):
52+
def _open(self) -> None:
53+
assert self.fp is not None
54+
5255
m = xbm_head.match(self.fp.read(512))
5356

5457
if not m:
@@ -67,7 +70,7 @@ def _open(self):
6770
self.tile = [("xbm", (0, 0) + self.size, m.end(), None)]
6871

6972

70-
def _save(im, fp, filename):
73+
def _save(im: Image.Image, fp: BytesIO, filename: str) -> None:
7174
if im.mode != "1":
7275
msg = f"cannot write mode {im.mode} as XBM"
7376
raise OSError(msg)

0 commit comments

Comments
 (0)