Revert generic Sprite, fixing typing issue with Sprite.add and Sprite.remove

Author: nachomaiz

buildconfig/stubs/pygame/sprite.pyi

@@ -47,13 +47,12 @@ class _HasMaskAndRect(_HasRect, Protocol):
 class _HasRadiusAndRect(_HasRect, Protocol):
     radius: float
 
-# generic Group, used in Sprite
-_TGroup = TypeVar("_TGroup", bound=AbstractGroup)
+# non-generic Group, used in Sprite
+_Group = AbstractGroup[_SupportsSprite]
 
 # protocol helps with structural subtyping for typevars in sprite group generics
 # and allows the use of any class with the required attributes and methods
-class _SupportsSprite(Generic[_TGroup], _HasImageAndRect, Protocol):
-    def __class_getitem__(cls, item: type[AbstractGroup], /) -> types.GenericAlias: ...
+class _SupportsSprite(_HasImageAndRect, Protocol):
     @property
     def image(self) -> Optional[Surface]: ...
     @image.setter
@@ -66,17 +65,17 @@ class _SupportsSprite(Generic[_TGroup], _HasImageAndRect, Protocol):
     def layer(self) -> int: ...
     @layer.setter
     def layer(self, value: int) -> None: ...
-    def add_internal(self, group: _TGroup) -> None: ...
-    def remove_internal(self, group: _TGroup) -> None: ...
+    def add_internal(self, group: _Group) -> None: ...
+    def remove_internal(self, group: _Group) -> None: ...
     def update(self, *args: Any, **kwargs: Any) -> None: ...
-    def add(self, *groups: _TGroup) -> None: ...
-    def remove(self, *groups: _TGroup) -> None: ...
+    def add(self, *groups: _Group) -> None: ...
+    def remove(self, *groups: _Group) -> None: ...
     def kill(self) -> None: ...
     def alive(self) -> bool: ...
-    def groups(self) -> list[_TGroup]: ...
+    def groups(self) -> list[_Group]: ...
 
 # also a protocol
-class _SupportsDirtySprite(_SupportsSprite[_TGroup], Protocol):
+class _SupportsDirtySprite(_SupportsSprite, Protocol):
     dirty: int
     blendmode: int
     source_rect: Union[FRect, Rect]
@@ -86,7 +85,7 @@ class _SupportsDirtySprite(_SupportsSprite[_TGroup], Protocol):
     def _get_visible(self) -> int: ...
 
 # concrete sprite implementation class
-class Sprite(_SupportsSprite[_TGroup]):
+class Sprite(_SupportsSprite):
     @property
     def image(self) -> Optional[Surface]: ...
     @image.setter
@@ -99,18 +98,18 @@ class Sprite(_SupportsSprite[_TGroup]):
     def layer(self) -> int: ...
     @layer.setter
     def layer(self, value: int) -> None: ...
-    def __init__(self, *groups: _TGroup) -> None: ...
-    def add_internal(self, group: _TGroup) -> None: ...
-    def remove_internal(self, group: _TGroup) -> None: ...
+    def __init__(self, *groups: _Group) -> None: ...
+    def add_internal(self, group: _Group) -> None: ...
+    def remove_internal(self, group: _Group) -> None: ...
     def update(self, *args: Any, **kwargs: Any) -> None: ...
-    def add(self, *groups: _TGroup) -> None: ...
-    def remove(self, *groups: _TGroup) -> None: ...
+    def add(self, *groups: _Group) -> None: ...
+    def remove(self, *groups: _Group) -> None: ...
     def kill(self) -> None: ...
     def alive(self) -> bool: ...
-    def groups(self) -> list[_TGroup]: ...
+    def groups(self) -> list[_Group]: ...
 
 # concrete dirty sprite implementation class
-class DirtySprite(Sprite[_TGroup], _SupportsDirtySprite[_TGroup]):
+class DirtySprite(Sprite, _SupportsDirtySprite):
     dirty: int
     blendmode: int
     source_rect: Union[FRect, Rect]
@@ -122,33 +121,32 @@ class DirtySprite(Sprite[_TGroup], _SupportsDirtySprite[_TGroup]):
 # typevar bound to Sprite, _SupportsSprite Protocol ensures sprite
 # subclass passed to group has image and rect attributes
 _TSprite = TypeVar("_TSprite", bound=_SupportsSprite)
+_TSprite_co = TypeVar("_TSprite_co", bound=_SupportsSprite, covariant=True)
 _TSprite2 = TypeVar("_TSprite2", bound=_SupportsSprite)
 
 # almost the same as _TSprite but bound to DirtySprite
-_TDirtySprite = TypeVar("_TDirtySprite", bound=_SupportsDirtySprite)
+_TDirtySprite_co = TypeVar("_TDirtySprite_co", bound=_SupportsDirtySprite, covariant=True)
 
 # typevar for sprite or iterable of sprites, used in Group init, add and remove
-_SpriteOrIterable = Union[_TSprite, Iterable[_SpriteOrIterable[_TSprite]]]
+_SpriteOrIterable = Union[_TSprite_co, Iterable[_SpriteOrIterable[_TSprite_co]]]
 
-class AbstractGroup(Generic[_TSprite]):
-    spritedict: dict[_TSprite, Optional[Union[FRect, Rect]]]
+class AbstractGroup(Generic[_TSprite_co]):
+    spritedict: dict[_TSprite_co, Optional[Union[FRect, Rect]]]
     lostsprites: list[Union[FRect, Rect]]
-    def __class_getitem__(
-        cls, item: type[_SupportsSprite], /
-    ) -> types.GenericAlias: ...
+    def __class_getitem__(cls, item: Any, /) -> types.GenericAlias: ...
     def __init__(self) -> None: ...
     def __len__(self) -> int: ...
-    def __iter__(self) -> Iterator[_TSprite]: ...
+    def __iter__(self) -> Iterator[_TSprite_co]: ...
     def __bool__(self) -> bool: ...
     def __contains__(self, item: Any) -> bool: ...
-    def add_internal(self, sprite: _TSprite, layer: None = None) -> None: ...
-    def remove_internal(self, sprite: _TSprite) -> None: ...
-    def has_internal(self, sprite: _TSprite) -> bool: ...
+    def add_internal(self, sprite: _SupportsSprite, layer: None = None) -> None: ...
+    def remove_internal(self, sprite: _SupportsSprite) -> None: ...
+    def has_internal(self, sprite: _SupportsSprite) -> bool: ...
     def copy(self) -> Self: ...
-    def sprites(self) -> list[_TSprite]: ...
-    def add(self, *sprites: _SpriteOrIterable[_TSprite]) -> None: ...
-    def remove(self, *sprites: _SpriteOrIterable[_TSprite]) -> None: ...
-    def has(self, *sprites: _SpriteOrIterable[_TSprite]) -> bool: ...
+    def sprites(self) -> list[_TSprite_co]: ...
+    def add(self, *sprites: _SpriteOrIterable[_TSprite_co]) -> None: ...
+    def remove(self, *sprites: _SpriteOrIterable[_TSprite_co]) -> None: ...
+    def has(self, *sprites: _SpriteOrIterable[_TSprite_co]) -> bool: ...
     def update(self, *args: Any, **kwargs: Any) -> None: ...
     def draw(
         self, surface: Surface, bgd: Optional[Surface] = None, special_flags: int = 0
@@ -160,41 +158,41 @@ class AbstractGroup(Generic[_TSprite]):
     ) -> None: ...
     def empty(self) -> None: ...
 
-class Group(AbstractGroup[_TSprite]):
-    def __init__(self, *sprites: _SpriteOrIterable[_TSprite]) -> None: ...
+class Group(AbstractGroup[_TSprite_co]):
+    def __init__(self, *sprites: _SpriteOrIterable[_TSprite_co]) -> None: ...
 
 # these are aliased in the code too
 @deprecated("Use `pygame.sprite.Group` instead")
-class RenderPlain(Group[_TSprite]): ...
+class RenderPlain(Group[_TSprite_co]): ...
 
 @deprecated("Use `pygame.sprite.Group` instead")
-class RenderClear(Group[_TSprite]): ...
+class RenderClear(Group[_TSprite_co]): ...
 
-class RenderUpdates(Group[_TSprite]): ...
+class RenderUpdates(Group[_TSprite_co]): ...
 
 @deprecated("Use `pygame.sprite.RenderUpdates` instead")
-class OrderedUpdates(RenderUpdates[_TSprite]): ...
+class OrderedUpdates(RenderUpdates[_TSprite_co]): ...
 
-class LayeredUpdates(AbstractGroup[_TSprite]):
+class LayeredUpdates(AbstractGroup[_TSprite_co]):
     def __init__(
-        self, *sprites: _SpriteOrIterable[_TSprite], **kwargs: Any
+        self, *sprites: _SpriteOrIterable[_TSprite_co], **kwargs: Any
     ) -> None: ...
-    def add(self, *sprites: _SpriteOrIterable[_TSprite], **kwargs: Any) -> None: ...
-    def get_sprites_at(self, pos: Point) -> list[_TSprite]: ...
-    def get_sprite(self, idx: int) -> _TSprite: ...
-    def remove_sprites_of_layer(self, layer_nr: int) -> list[_TSprite]: ...
+    def add(self, *sprites: _SpriteOrIterable[_TSprite_co], **kwargs: Any) -> None: ...
+    def get_sprites_at(self, pos: Point) -> list[_TSprite_co]: ...
+    def get_sprite(self, idx: int) -> _TSprite_co: ...
+    def remove_sprites_of_layer(self, layer_nr: int) -> list[_TSprite_co]: ...
     def layers(self) -> list[int]: ...
-    def change_layer(self, sprite: _TSprite, new_layer: int) -> None: ...
-    def get_layer_of_sprite(self, sprite: _TSprite) -> int: ...
+    def change_layer(self, sprite: _SupportsSprite, new_layer: int) -> None: ...
+    def get_layer_of_sprite(self, sprite: _SupportsSprite) -> int: ...
     def get_top_layer(self) -> int: ...
     def get_bottom_layer(self) -> int: ...
-    def move_to_front(self, sprite: _TSprite) -> None: ...
-    def move_to_back(self, sprite: _TSprite) -> None: ...
-    def get_top_sprite(self) -> _TSprite: ...
-    def get_sprites_from_layer(self, layer: int) -> list[_TSprite]: ...
+    def move_to_front(self, sprite: _SupportsSprite) -> None: ...
+    def move_to_back(self, sprite: _SupportsSprite) -> None: ...
+    def get_top_sprite(self) -> _TSprite_co: ...
+    def get_sprites_from_layer(self, layer: int) -> list[_TSprite_co]: ...
     def switch_layer(self, layer1_nr: int, layer2_nr: int) -> None: ...
 
-class LayeredDirty(LayeredUpdates[_TDirtySprite]):
+class LayeredDirty(LayeredUpdates[_TDirtySprite_co]):
     def draw(
         self,
         surface: Surface,