Added DecoderInput type alias

Author: radarhere

Tests/test_file_jpeg.py

@@ -1053,10 +1053,7 @@ def test_eof(self, monkeypatch: pytest.MonkeyPatch) -> None:
         # Even though this decoder never says that it is finished
         # the image should still end when there is no new data
         class InfiniteMockPyDecoder(ImageFile.PyDecoder):
-            def decode(
-                self,
-                buffer: bytes | bytearray | memoryview | Image.SupportsArrayInterface,
-            ) -> tuple[int, int]:
+            def decode(self, buffer: Image.DecoderInput) -> tuple[int, int]:
                 return 0, 0
 
         Image.register_decoder("INFINITE", InfiniteMockPyDecoder)

Tests/test_imagefile.py

@@ -260,9 +260,7 @@ def __init__(self, mode: str, *args: Any) -> None:
 
         super().__init__(mode, *args)
 
-    def decode(
-        self, buffer: bytes | bytearray | memoryview | Image.SupportsArrayInterface
-    ) -> tuple[int, int]:
+    def decode(self, buffer: Image.DecoderInput) -> tuple[int, int]:
         # eof
         return -1, 0
 

docs/example/DdsImagePlugin.py

@@ -258,9 +258,7 @@ def load_seek(self, pos: int) -> None:
 class DXT1Decoder(ImageFile.PyDecoder):
     _pulls_fd = True
 
-    def decode(
-        self, buffer: bytes | bytearray | memoryview | Image.SupportsArrayInterface
-    ) -> tuple[int, int]:
+    def decode(self, buffer: Image.DecoderInput) -> tuple[int, int]:
         assert self.fd is not None
         try:
             self.set_as_raw(_dxt1(self.fd, self.state.xsize, self.state.ysize))
@@ -273,9 +271,7 @@ def decode(
 class DXT5Decoder(ImageFile.PyDecoder):
     _pulls_fd = True
 
-    def decode(
-        self, buffer: bytes | bytearray | memoryview | Image.SupportsArrayInterface
-    ) -> tuple[int, int]:
+    def decode(self, buffer: Image.DecoderInput) -> tuple[int, int]:
         assert self.fd is not None
         try:
             self.set_as_raw(_dxt5(self.fd, self.state.xsize, self.state.ysize))

docs/reference/Image.rst

@@ -376,6 +376,8 @@ Protocols
     :show-inheritance:
 .. autoclass:: SupportsGetData
     :show-inheritance:
+.. autoclass:: DecoderInput
+    :show-inheritance:
 
 Constants
 ---------

src/PIL/BlpImagePlugin.py

@@ -295,9 +295,7 @@ def _open(self) -> None:
 class _BLPBaseDecoder(abc.ABC, ImageFile.PyDecoder):
     _pulls_fd = True
 
-    def decode(
-        self, buffer: bytes | bytearray | memoryview | Image.SupportsArrayInterface
-    ) -> tuple[int, int]:
+    def decode(self, buffer: Image.DecoderInput) -> tuple[int, int]:
         try:
             self._read_header()
             self._load()

src/PIL/BmpImagePlugin.py

@@ -324,9 +324,7 @@ def _open(self) -> None:
 class BmpRleDecoder(ImageFile.PyDecoder):
     _pulls_fd = True
 
-    def decode(
-        self, buffer: bytes | bytearray | memoryview | Image.SupportsArrayInterface
-    ) -> tuple[int, int]:
+    def decode(self, buffer: Image.DecoderInput) -> tuple[int, int]:
         assert self.fd is not None
         rle4 = self.args[1]
         data = bytearray()

src/PIL/DdsImagePlugin.py

@@ -488,9 +488,7 @@ def load_seek(self, pos: int) -> None:
 class DdsRgbDecoder(ImageFile.PyDecoder):
     _pulls_fd = True
 
-    def decode(
-        self, buffer: bytes | bytearray | memoryview | Image.SupportsArrayInterface
-    ) -> tuple[int, int]:
+    def decode(self, buffer: Image.DecoderInput) -> tuple[int, int]:
         assert self.fd is not None
         bitcount, masks = self.args
 

src/PIL/FitsImagePlugin.py

@@ -126,9 +126,7 @@ def _parse_headers(
 class FitsGzipDecoder(ImageFile.PyDecoder):
     _pulls_fd = True
 
-    def decode(
-        self, buffer: bytes | bytearray | memoryview | Image.SupportsArrayInterface
-    ) -> tuple[int, int]:
+    def decode(self, buffer: Image.DecoderInput) -> tuple[int, int]:
         assert self.fd is not None
         with gzip.open(self.fd) as fp:
             value = fp.read(self.state.xsize * self.state.ysize * 4)

src/PIL/Image.py

@@ -931,7 +931,7 @@ def tobitmap(self, name: str = "image") -> bytes:
 
     def frombytes(
         self,
-        data: bytes | bytearray | memoryview | SupportsArrayInterface,
+        data: DecoderInput,
         decoder_name: str = "raw",
         *args: Any,
     ) -> None:
@@ -3241,7 +3241,7 @@ def new(
 def frombytes(
     mode: str,
     size: tuple[int, int],
-    data: bytes | bytearray | memoryview | SupportsArrayInterface,
+    data: DecoderInput,
     decoder_name: str = "raw",
     *args: Any,
 ) -> Image:
@@ -3356,6 +3356,9 @@ def __array_interface__(self) -> dict[str, Any]:
         raise NotImplementedError()
 
 
+DecoderInput = bytes | bytearray | memoryview | SupportsArrayInterface
+
+
 class SupportsArrowArrayInterface(Protocol):
     """
     An object that has an ``__arrow_c_array__`` method corresponding to the arrow c

src/PIL/ImageFile.py

@@ -836,9 +836,7 @@ class PyDecoder(PyCodec):
     def pulls_fd(self) -> bool:
         return self._pulls_fd
 
-    def decode(
-        self, buffer: bytes | bytearray | memoryview | Image.SupportsArrayInterface
-    ) -> tuple[int, int]:
+    def decode(self, buffer: Image.DecoderInput) -> tuple[int, int]:
         """
         Override to perform the decoding process.