Merge pull request #3301 from pygame-community/ankith26-new-typing-2

Freetype typing fixes, enhancements to dict/tuple/ellipsis typing

Author: MyreMylar

buildconfig/stubs/pygame/_sdl2/touch.pyi

@@ -1,6 +1,13 @@
-from typing import Union, Optional
+from typing import TypedDict, Optional
+
+# dict at runtime, this only exist for benefit of the typechecker
+class _FingerDict(TypedDict):
+    id: int
+    x: float
+    y: float
+    pressure: float
 
 def get_num_devices() -> int: ...
 def get_device(index: int, /) -> int: ...
 def get_num_fingers(device_id: int, /) -> int: ...
-def get_finger(touchid: int, index: int) -> Optional[dict[str, Union[int, float]]]: ...
+def get_finger(touchid: int, index: int) -> Optional[_FingerDict]: ...

buildconfig/stubs/pygame/color.pyi

@@ -41,8 +41,8 @@ class Color(Collection[int]):
     def __index__(self) -> int: ...
     def __invert__(self) -> Color: ...
     def __contains__(self, other: int) -> bool: ...  # type: ignore[override]
-    def __getattribute__(self, attr: str) -> Union[Color, tuple]: ...
-    def __setattr__(self, attr: str, value: Union[Color, tuple]) -> None: ...
+    def __getattribute__(self, attr: str) -> Union[Color, tuple[int, ...]]: ...
+    def __setattr__(self, attr: str, value: Union[Color, tuple[int, ...]]) -> None: ...
     @overload
     @classmethod
     def from_cmy(cls, object: tuple[float, float, float], /) -> Color: ...

buildconfig/stubs/pygame/freetype.pyi

@@ -17,7 +17,7 @@ def get_init() -> bool: ...
 def was_init() -> bool: ...
 def get_cache_size() -> int: ...
 def get_default_resolution() -> int: ...
-def set_default_resolution(resolution: int, /) -> None: ...
+def set_default_resolution(resolution: int = 0, /) -> None: ...
 def SysFont(
     name: Union[str, bytes, Iterable[Union[str, bytes]], None],
     size: int,
@@ -143,7 +143,7 @@ class Font:
     ) -> None: ...
     def get_rect(
         self,
-        text: str,
+        text: Optional[str],
         style: int = STYLE_DEFAULT,
         rotation: int = 0,
         size: float = 0,
@@ -158,7 +158,7 @@ class Font:
     def get_sizes(self) -> list[tuple[int, int, int, float, float]]: ...
     def render(
         self,
-        text: str,
+        text: Optional[str],
         fgcolor: Optional[ColorLike] = None,
         bgcolor: Optional[ColorLike] = None,
         style: int = STYLE_DEFAULT,
@@ -169,7 +169,7 @@ class Font:
         self,
         surf: Surface,
         dest: RectLike,
-        text: str,
+        text: Optional[str],
         fgcolor: Optional[ColorLike] = None,
         bgcolor: Optional[ColorLike] = None,
         style: int = STYLE_DEFAULT,
@@ -178,7 +178,7 @@ class Font:
     ) -> Rect: ...
     def render_raw(
         self,
-        text: str,
+        text: Optional[str],
         style: int = STYLE_DEFAULT,
         rotation: int = 0,
         size: float = 0,
@@ -187,7 +187,7 @@ class Font:
     def render_raw_to(
         self,
         array: Any,
-        text: str,
+        text: Optional[str],
         dest: Optional[RectLike] = None,
         style: int = STYLE_DEFAULT,
         rotation: int = 0,

buildconfig/stubs/pygame/mixer_music.pyi

@@ -1,7 +1,13 @@
-from typing import Optional
+from typing import Optional, TypedDict
 
 from pygame.typing import FileLike
 
+class _MusicMetadataDict(TypedDict):
+    title: str
+    album: str
+    artist: str
+    copyright: str
+
 def load(filename: FileLike, namehint: Optional[str] = "") -> None: ...
 def unload() -> None: ...
 def play(loops: int = 0, start: float = 0.0, fade_ms: int = 0) -> None: ...
@@ -18,4 +24,6 @@ def get_pos() -> int: ...
 def queue(filename: FileLike, namehint: str = "", loops: int = 0) -> None: ...
 def set_endevent(event_type: int, /) -> None: ...
 def get_endevent() -> int: ...
-def get_metadata(filename: Optional[FileLike] = None, namehint: str = "") -> dict[str, str]: ...
+def get_metadata(
+    filename: Optional[FileLike] = None, namehint: str = ""
+) -> _MusicMetadataDict: ...

buildconfig/stubs/pygame/pixelarray.pyi

@@ -1,9 +1,17 @@
+import sys
 from typing import Any, Union, overload
 
 from pygame.surface import Surface
 from pygame.color import Color
 from pygame.typing import SequenceLike
 
+# 'ellipsis' existed in typeshed pre 3.10, now we use EllipsisType which is
+# the modern standard library equivalent.
+if sys.version_info >= (3, 10):
+    from types import EllipsisType
+else:
+    EllipsisType = ellipsis
+
 _ColorLike = int | Color | tuple[int, int, int] | tuple[int, int, int, int]
 
 class PixelArray:
@@ -32,7 +40,7 @@ class PixelArray:
     def __getitem__(self, indices: tuple[int, int]) -> int: ...
     # returns self
     @overload
-    def __getitem__(self, ell: ellipsis) -> PixelArray: ...
+    def __getitem__(self, ell: EllipsisType) -> PixelArray: ...
     def make_surface(self) -> Surface: ...
     def replace(
         self,

buildconfig/stubs/pygame/rect.pyi

@@ -16,6 +16,13 @@ if sys.version_info >= (3, 11):
 else:
     from typing_extensions import Self
 
+# 'ellipsis' existed in typeshed pre 3.10, now we use EllipsisType which is
+# the modern standard library equivalent.
+if sys.version_info >= (3, 10):
+    from types import EllipsisType
+else:
+    EllipsisType = ellipsis
+
 _N = TypeVar("_N", int, float)
 _K = TypeVar("_K")
 _V = TypeVar("_V")
@@ -129,11 +136,13 @@ class _GenericRect(Collection[_N]):
     @overload
     def __getitem__(self, i: SupportsIndex) -> _N: ...
     @overload
-    def __getitem__(self, s: slice) -> list[_N]: ...
+    def __getitem__(self, s: Union[slice, EllipsisType]) -> list[_N]: ...
     @overload
     def __setitem__(self, key: int, value: float) -> None: ...
     @overload
-    def __setitem__(self, key: slice, value: Union[float, RectLike]) -> None: ...
+    def __setitem__(
+        self, key: Union[slice, EllipsisType], value: Union[float, RectLike]
+    ) -> None: ...
     def __copy__(self) -> Self: ...
     def copy(self) -> Self: ...
     @overload