Merge pull request #3398 from aatle/buffer-stubs

Fix stubs for buffer types

Author: zoldalma999

buildconfig/stubs/pygame/bufferproxy.pyi

@@ -1,3 +1,4 @@
+import sys
 from typing import Any
 
 class BufferProxy:
@@ -13,5 +14,12 @@ class BufferProxy:
     def __array_interface__(self) -> dict[str, Any]: ...
     @property
     def __array_struct__(self) -> Any: ...
+    if sys.version_info >= (3, 12):
+        def __buffer__(self, flags: int, /) -> memoryview[int]: ...
+        def __release_buffer__(self, view: memoryview[int], /) -> None: ...
     def __init__(self, parent: Any) -> None: ...  # TODO: parent: TypedDict | Protocol
-    def write(self, buffer: bytes, offset: int = 0) -> None: ...
+    def write(
+        self,
+        buffer: str | bytes,  # Any "read-only bytes-like-object" is valid
+        offset: int = 0,
+    ) -> None: ...

buildconfig/stubs/pygame/color.pyi

@@ -1,3 +1,4 @@
+import sys
 from collections.abc import Collection, Iterator
 from typing import Any, ClassVar, SupportsIndex, Union, overload
 
@@ -22,6 +23,8 @@ class Color(Collection[int]):
     __hash__: ClassVar[None]  # type: ignore[assignment]
     @property
     def __array_struct__(self) -> Any: ...
+    if sys.version_info >= (3, 12):
+        def __buffer__(self, flags: int, /) -> memoryview[int]: ...
     @overload
     def __init__(self, r: int, g: int, b: int, a: int = 255) -> None: ...
     @overload

buildconfig/stubs/pygame/image.pyi

@@ -67,9 +67,11 @@ from typing import Literal, Optional, Union
 from pygame.bufferproxy import BufferProxy
 from pygame.surface import Surface
 from pygame.typing import FileLike, IntPoint, Point
-from typing_extensions import deprecated  # added in 3.13
+from typing_extensions import (
+    Buffer,  # collections.abc 3.12
+    deprecated,  # added in 3.13
+)
 
-_BufferLike = Union[BufferProxy, bytes, bytearray, memoryview]
 _from_buffer_format = Literal["P", "RGB", "BGR", "BGRA", "RGBX", "RGBA", "ARGB"]
 _to_bytes_format = Literal[
     "P", "RGB", "RGBX", "RGBA", "ARGB", "BGRA", "ABGR", "RGBA_PREMULT", "ARGB_PREMULT"
@@ -320,7 +322,7 @@ def frombytes(
     """
 
 def frombuffer(
-    buffer: _BufferLike,
+    buffer: Buffer,
     size: IntPoint,
     format: _from_buffer_format,
     pitch: int = -1,

buildconfig/stubs/pygame/mask.pyi

@@ -1,3 +1,4 @@
+import sys
 from typing import Any, Optional, Union
 
 from pygame.rect import Rect
@@ -53,6 +54,9 @@ class Mask:
         unsetcolor: Optional[ColorLike] = (0, 0, 0, 255),
         dest: Union[RectLike, Point] = (0, 0),
     ) -> Surface: ...
+    if sys.version_info >= (3, 12):
+        def __buffer__(self, flags: int, /) -> memoryview[int]: ...
+        def __release_buffer__(self, view: memoryview[int], /) -> None: ...
 
 @deprecated("Use `Mask` instead (MaskType is an old alias)")
 class MaskType(Mask): ...

buildconfig/stubs/pygame/mixer.pyi

@@ -1,9 +1,12 @@
+import sys
 from typing import Any, Optional, Union, overload
 
-import numpy
 from pygame.event import Event
 from pygame.typing import FileLike
-from typing_extensions import deprecated  # added in 3.13
+from typing_extensions import (
+    Buffer,  # collections.abc 3.12
+    deprecated,  # added in 3.13
+)
 
 from . import mixer_music
 
@@ -46,13 +49,7 @@ class Sound:
     @overload
     def __init__(self, file: FileLike) -> None: ...
     @overload
-    def __init__(
-        self, buffer: Any
-    ) -> None: ...  # Buffer protocol is still not implemented in typing
-    @overload
-    def __init__(
-        self, array: numpy.ndarray
-    ) -> None: ...  # Buffer protocol is still not implemented in typing
+    def __init__(self, buffer: Buffer) -> None: ...
     def play(
         self,
         loops: int = 0,
@@ -65,6 +62,9 @@ class Sound:
     def __array_interface__(self) -> dict[str, Any]: ...
     @property
     def __array_struct__(self) -> Any: ...
+    if sys.version_info >= (3, 12):
+        def __buffer__(self, flags: int, /) -> memoryview[int]: ...
+        def __release_buffer__(self, view: memoryview[int], /) -> None: ...
     def stop(self) -> None: ...
     def fadeout(self, time: int, /) -> None: ...
     def set_volume(self, value: float, /) -> None: ...

buildconfig/stubs/pygame/pixelarray.pyi

@@ -31,6 +31,8 @@ class PixelArray:
     def __array_interface__(self) -> dict[str, Any]: ...
     @property
     def __array_struct__(self) -> Any: ...
+    if sys.version_info >= (3, 12):
+        def __buffer__(self, flags: int, /) -> memoryview[int]: ...
     def __init__(self, surface: Surface) -> None: ...
     def __enter__(self) -> PixelArray: ...
     def __exit__(self, *args, **kwargs) -> None: ...