Remove array struct support

Author: zoldalma999

buildconfig/stubs/pygame/__init__.pyi

@@ -61,7 +61,6 @@ from .base import (
     BufferError as BufferError,
     HAVE_NEWBUF as HAVE_NEWBUF,
     error as error,
-    get_array_interface as get_array_interface,
     get_error as get_error,
     get_init as get_init,
     get_sdl_byteorder as get_sdl_byteorder,

buildconfig/stubs/pygame/base.pyi

@@ -16,6 +16,3 @@ def set_error(error_msg: str, /) -> None: ...
 def get_sdl_version(linked: bool = True) -> Tuple[int, int, int]: ...
 def get_sdl_byteorder() -> int: ...
 def register_quit(callable: Callable[[], Any], /) -> None: ...
-
-# undocumented part of pygame API, kept here to make stubtest happy
-def get_array_interface(arg: Any, /) -> dict: ...

buildconfig/stubs/pygame/bufferproxy.pyi

@@ -7,7 +7,6 @@ class BufferProxy:
     # possibly going to be deprecated/removed soon, in which case these
     # typestubs must be removed too
     __array_interface__: Dict[str, Any]
-    __array_struct__: Any
     @overload
     def __init__(self) -> None: ...
     @overload

buildconfig/stubs/pygame/color.pyi

@@ -22,7 +22,6 @@ class Color(Collection[int]):
     hsla: Tuple[float, float, float, float]
     i1i2i3: Tuple[float, float, float]
     __hash__: None  # type: ignore
-    __array_struct__: Any
     @overload
     def __init__(self, r: int, g: int, b: int, a: int = 255) -> None: ...
     @overload

buildconfig/stubs/pygame/mixer.pyi

@@ -61,7 +61,6 @@ class Sound:
     # possibly going to be deprecated/removed soon, in which case these
     # typestubs must be removed too
     __array_interface__: Dict[str, Any]
-    __array_struct__: Any
     def stop(self) -> None: ...
     def fadeout(self, time: int, /) -> None: ...
     def set_volume(self, value: float, /) -> None: ...
@@ -70,7 +69,6 @@ class Sound:
     def get_length(self) -> float: ...
     def get_raw(self) -> bytes: ...
 
-
 class Channel:
     def __init__(self, id: int) -> None: ...
     @property

buildconfig/stubs/pygame/pixelarray.pyi

@@ -10,10 +10,7 @@ class PixelArray:
     ndim: int
     shape: Tuple[int, ...]
     strides: Tuple[int, ...]
-    # possibly going to be deprecated/removed soon, in which case these
-    # typestubs must be removed too
     __array_interface__: Dict[str, Any]
-    __array_struct__: Any
     def __init__(self, surface: Surface) -> None: ...
     def __enter__(self) -> PixelArray: ...
     def __exit__(self, *args, **kwargs) -> None: ...

docs/reST/c_api/base.rst

@@ -124,19 +124,14 @@ C header: src_c/include/pygame.h
    Return a Python array interface object representation of buffer *view_p*.
    On failure raise a Python exception and return *NULL*.
 
-.. c:function:: PyObject* pgBuffer_AsArrayStruct(Py_buffer *view_p)
-
-   Return a Python array struct object representation of buffer *view_p*.
-   On failure raise a Python exception and return *NULL*.
-
 .. c:function:: int pgObject_GetBuffer(PyObject *obj, pg_buffer *pg_view_p, int flags)
 
    Request a buffer for object *obj*.
    Argument *flags* are PyBUF options.
    Return the buffer description in *pg_view_p*.
-   An object may support the Python buffer interface, the NumPy array interface,
-   or the NumPy array struct interface.
-   Return ``0`` on success, raise a Python exception and return ``-1`` on failure.
+   An object may support the Python buffer interface or the NumPy python
+   object array interface. Return ``0`` on success, raise a Python exception
+   and return ``-1`` on failure.
 
 .. c:function:: void pgBuffer_Release(Pg_buffer *pg_view_p)
 

docs/reST/ref/freetype.rst

@@ -506,7 +506,7 @@ loaded. This module must be imported explicitly to be used. ::
       | :sl:`Render text into an array of ints`
       | :sg:`render_raw_to(array, text, dest=None, style=STYLE_DEFAULT, rotation=0, size=0, invert=False) -> Rect`
 
-      Render to an array object exposing an array struct interface. The array
+      Render to an array object exposing the buffer protocol. The array
       must be two dimensional with integer items. The default *dest* value,
       ``None``, is equivalent to position (0, 0). See :meth:`render_to`.
       As with the other render methods, *text* can be ``None`` to

docs/reST/ref/pixelarray.rst

@@ -17,9 +17,9 @@
    for assignment. A pixel array sliced on a single column or row
    returns a one dimensional pixel array. Arithmetic and other operations
    are not supported. A pixel array can be safely assigned to itself.
-   Finally, pixel arrays export an array struct interface, allowing
-   them to interact with :mod:`pygame.pixelcopy` methods and NumPy
-   arrays.
+   Finally, pixel arrays export the buffer protocol as well as the python
+   array interface, allowing them to interact with :mod:`pygame.pixelcopy`
+   methods and NumPy arrays.
 
    A PixelArray pixel item can be assigned a raw integer values, a
    :class:`pygame.Color` instance, or a (r, g, b[, a]) tuple.
@@ -100,6 +100,8 @@
    copying is implemented it is suggested PixelArray to PixelArray copies be
    only between surfaces of identical format.
 
+   .. versionchanged:: 2.5.0 Removed array struct support
+
    .. versionaddedold:: 1.9.4
 
     - close() method was added. For explicitly cleaning up.

docs/reST/ref/pixelcopy.rst

@@ -9,23 +9,18 @@
 | :sl:`pygame module for general pixel array copying`
 
 The ``pygame.pixelcopy`` module contains functions for copying between
-surfaces and objects exporting an array structure interface. It is a backend
-for :mod:`pygame.surfarray`, adding NumPy support. But pixelcopy is more
-general, and intended for direct use.
-
-The array struct interface exposes an array's data in a standard way.
-It was introduced in NumPy. In Python 2.7 and above it is replaced by the
-new buffer protocol, though the buffer protocol is still a work in progress.
-The array struct interface, on the other hand, is stable and works with earlier
-Python versions. So for now the array struct interface is the predominate way
-pygame handles array introspection.
+surfaces and objects exporting the buffer protocol or the python array
+interface. It is a backend for :mod:`pygame.surfarray`, which adds NumPy
+support. But pixelcopy is more general, and intended for direct use.
 
 For 2d arrays of integer pixel values, the values are mapped to the
 pixel format of the related surface. To get the actual color of a pixel
 value use :meth:`pygame.Surface.unmap_rgb`. 2d arrays can only be used
 directly between surfaces having the same pixel layout.
 
-New in pygame 1.9.2.
+.. versionchanged:: 2.5.0 Removed array struct support
+
+.. versionaddedold:: 1.9.2
 
 .. function:: surface_to_array