Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added type hints to PpmImagePlugin #7726

Merged
merged 1 commit into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/PIL/Image.py
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ def getmodebandnames(mode):
return ImageMode.getmode(mode).bands


def getmodebands(mode):
def getmodebands(mode: str) -> int:
"""
Gets the number of individual bands for this mode.

Expand Down
2 changes: 2 additions & 0 deletions src/PIL/ImageFile.py
Original file line number Diff line number Diff line change
Expand Up @@ -616,6 +616,8 @@ def extents(self):


class PyCodec:
fd: io.BytesIO | None

def __init__(self, mode, *args):
self.im = None
self.state = PyCodecState()
Expand Down
46 changes: 30 additions & 16 deletions src/PIL/PpmImagePlugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
from __future__ import annotations

import math
from io import BytesIO

from . import Image, ImageFile
from ._binary import i16be as i16
Expand Down Expand Up @@ -45,7 +46,7 @@
}


def _accept(prefix):
def _accept(prefix: bytes) -> bool:
return prefix[0:1] == b"P" and prefix[1] in b"0123456fy"


Expand All @@ -57,7 +58,9 @@ class PpmImageFile(ImageFile.ImageFile):
format = "PPM"
format_description = "Pbmplus image"

def _read_magic(self):
def _read_magic(self) -> bytes:
assert self.fp is not None

magic = b""
# read until whitespace or longest available magic number
for _ in range(6):
Expand All @@ -67,7 +70,9 @@ def _read_magic(self):
magic += c
return magic

def _read_token(self):
def _read_token(self) -> bytes:
assert self.fp is not None

token = b""
while len(token) <= 10: # read until next whitespace or limit of 10 characters
c = self.fp.read(1)
Expand All @@ -93,7 +98,9 @@ def _read_token(self):
raise ValueError(msg)
return token

def _open(self):
def _open(self) -> None:
assert self.fp is not None

magic_number = self._read_magic()
try:
mode = MODES[magic_number]
Expand All @@ -114,6 +121,8 @@ def _open(self):
decoder_name = "raw"
if magic_number in (b"P1", b"P2", b"P3"):
decoder_name = "ppm_plain"

args: str | tuple[str | int, ...]
if mode == "1":
args = "1;I"
elif mode == "F":
Expand Down Expand Up @@ -151,16 +160,19 @@ def _open(self):

class PpmPlainDecoder(ImageFile.PyDecoder):
_pulls_fd = True
_comment_spans: bool

def _read_block(self) -> bytes:
assert self.fd is not None

def _read_block(self):
return self.fd.read(ImageFile.SAFEBLOCK)

def _find_comment_end(self, block, start=0):
def _find_comment_end(self, block: bytes, start: int = 0) -> int:
a = block.find(b"\n", start)
b = block.find(b"\r", start)
return min(a, b) if a * b > 0 else max(a, b) # lowest nonnegative index (or -1)

def _ignore_comments(self, block):
def _ignore_comments(self, block: bytes) -> bytes:
if self._comment_spans:
# Finish current comment
while block:
Expand Down Expand Up @@ -194,7 +206,7 @@ def _ignore_comments(self, block):
break
return block

def _decode_bitonal(self):
def _decode_bitonal(self) -> bytearray:
"""
This is a separate method because in the plain PBM format, all data tokens are
exactly one byte, so the inter-token whitespace is optional.
Expand All @@ -219,15 +231,15 @@ def _decode_bitonal(self):
invert = bytes.maketrans(b"01", b"\xFF\x00")
return data.translate(invert)

def _decode_blocks(self, maxval):
def _decode_blocks(self, maxval: int) -> bytearray:
data = bytearray()
max_len = 10
out_byte_count = 4 if self.mode == "I" else 1
out_max = 65535 if self.mode == "I" else 255
bands = Image.getmodebands(self.mode)
total_bytes = self.state.xsize * self.state.ysize * bands * out_byte_count

half_token = False
half_token = b""
while len(data) != total_bytes:
block = self._read_block() # read next block
if not block:
Expand All @@ -241,7 +253,7 @@ def _decode_blocks(self, maxval):

if half_token:
block = half_token + block # stitch half_token to new block
half_token = False
half_token = b""

tokens = block.split()

Expand All @@ -259,15 +271,15 @@ def _decode_blocks(self, maxval):
raise ValueError(msg)
value = int(token)
if value > maxval:
msg = f"Channel value too large for this mode: {value}"
raise ValueError(msg)
msg_str = f"Channel value too large for this mode: {value}"
raise ValueError(msg_str)
value = round(value / maxval * out_max)
data += o32(value) if self.mode == "I" else o8(value)
if len(data) == total_bytes: # finished!
break
return data

def decode(self, buffer):
def decode(self, buffer: bytes) -> tuple[int, int]:
self._comment_spans = False
if self.mode == "1":
data = self._decode_bitonal()
Expand All @@ -283,7 +295,9 @@ def decode(self, buffer):
class PpmDecoder(ImageFile.PyDecoder):
_pulls_fd = True

def decode(self, buffer):
def decode(self, buffer: bytes) -> tuple[int, int]:
assert self.fd is not None

data = bytearray()
maxval = self.args[-1]
in_byte_count = 1 if maxval < 256 else 2
Expand All @@ -310,7 +324,7 @@ def decode(self, buffer):
# --------------------------------------------------------------------


def _save(im, fp, filename):
def _save(im: Image.Image, fp: BytesIO, filename: str) -> None:
if im.mode == "1":
rawmode, head = "1;I", b"P4"
elif im.mode == "L":
Expand Down
Loading