enhance typings on Sprite and SpriteList

Author: Snipy7374

arcade/scene.py

@@ -10,10 +10,10 @@
 * Control sprite list draw order within the group
 """
 
-from typing import Dict, List, Optional, Union, Iterable, Tuple
+from typing import Dict, List, Optional, Union, Iterable
 
 from arcade import Sprite, SpriteList
-from arcade.types import Color, RGBA255
+from arcade.types import Color, RGBA255, OpenGlFilters, BlendFunctions
 from arcade.tilemap import TileMap
 
 from warnings import warn
@@ -432,9 +432,9 @@ def update_animation(
     def draw(
         self,
         names: Optional[Iterable[str]] = None,
-        filter: Optional[int] = None,
+        filter: Optional[OpenGlFilters] = None,
         pixelated: bool = False,
-        blend_function: Optional[Union[Tuple[int, int], Tuple[int, int, int, int]]] = None,
+        blend_function: Optional[BlendFunctions] = None,
         **kwargs
     ) -> None:
         """

arcade/sprite/base.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING, Iterable, List, TypeVar
+from typing import TYPE_CHECKING, Iterable, List, TypeVar, Any
 
 import arcade
 from arcade.types import Point, Color, RGBA255, PointList
@@ -47,7 +47,7 @@ def __init__(
         scale: float = 1.0,
         center_x: float = 0,
         center_y: float = 0,
-        **kwargs,
+        **kwargs: Any,
     ) -> None:
         self._position = (center_x, center_y)
         self._depth = 0.0

arcade/sprite/sprite.py

@@ -5,7 +5,7 @@
 from arcade import Texture, load_texture
 from arcade.hitbox import HitBox, RotatableHitBox
 from arcade.texture import get_default_texture
-from arcade.types import PathOrTexture, Point
+from arcade.types import PathOrTexture, Point, OpenGlFilters, BlendFunctions
 
 from .base import BasicSprite
 from .mixins import PymunkMixin
@@ -66,7 +66,7 @@ def __init__(
         center_x: float = 0.0,
         center_y: float = 0.0,
         angle: float = 0.0,
-        **kwargs,
+        **kwargs: Any,
     ):
         if isinstance(path_or_texture, Texture):
             _texture = path_or_texture
@@ -255,7 +255,7 @@ def properties(self) -> Dict[str, Any]:
         return self._properties
 
     @properties.setter
-    def properties(self, value):
+    def properties(self, value: Dict[str, Any]):
         self._properties = value
 
     # --- Movement methods -----
@@ -313,7 +313,13 @@ def stop(self) -> None:
 
     # ---- Draw Methods ----
 
-    def draw(self, *, filter=None, pixelated=None, blend_function=None) -> None:
+    def draw(
+            self,
+            *,
+            filter: Optional[OpenGlFilters] | None = None,
+            pixelated: Optional[bool] = None,
+            blend_function: Optional[BlendFunctions] = None
+    ) -> None:
         """
         A debug method which draws the sprite into the current OpenGL context.
 
@@ -399,7 +405,7 @@ def remove_from_sprite_lists(self) -> None:
 
         self.physics_engines.clear()
 
-    def register_physics_engine(self, physics_engine) -> None:
+    def register_physics_engine(self, physics_engine: Any) -> None:
         """
         Register a physics engine on the sprite.
         This is only needed if you actually need a reference

arcade/sprite_list/sprite_list.py

@@ -31,7 +31,7 @@
     get_window,
     gl,
 )
-from arcade.types import Color, RGBA255
+from arcade.types import Color, RGBA255, OpenGlFilters, BlendFunctions
 from arcade.gl.buffer import Buffer
 from arcade.gl.vertex_array import Geometry
 
@@ -960,7 +960,13 @@ def initialize(self):
         """
         self._init_deferred()
 
-    def draw(self, *, filter=None, pixelated=None, blend_function=None):
+    def draw(
+            self,
+            *,
+            filter: Optional[OpenGlFilters] = None,
+            pixelated: Optional[bool] = None,
+            blend_function: Optional[BlendFunctions] = None
+    ) -> None:
         """
         Draw this list of sprites.
 

arcade/types.py

@@ -17,7 +17,10 @@
     Sequence,
     Tuple,
     Union,
-    TYPE_CHECKING, TypeVar
+    TYPE_CHECKING,
+    TypeVar,
+    TypeAlias,
+    Literal,
 )
 from typing_extensions import Self
 
@@ -49,6 +52,22 @@
 
 RGBA255OrNormalized = Union[RGBA255, RGBANormalized]
 
+# equivalent to the following filters (under arcade.gl.enums):
+# NEAREST, LINEAR, NEAREST_MIPMAP_NEAREST, LINEAR_MIPMAP_NEAREST,
+# NEAREST_MIPMAP_LINEAR, LINEAR_MIPMAP_LINEAR
+OpenGlFilters: TypeAlias = Union[Literal[9728], Literal[9729], Literal[9984],
+                                 Literal[9985], Literal[9986], Literal[9987]]
+
+# equivalent to the following blend_functions (under arcade.gl.enums):
+# ZERO, ONE, SRC_COLOR, ONE_MINUS_SRC_COLOR,
+# SRC_ALPHA, ONE_MINUS_SRC_ALPHA, DST_ALPHA,
+# ONE_MINUS_DST_ALPHA, DST_COLOR, ONE_MINUS_DST_COLOR
+BlendFunctions: TypeAlias = Union[Literal[0], Literal[1], Literal[768],
+                                  Literal[769], Literal[770], Literal[771],
+                                  Literal[772], Literal[773], Literal[774],
+                                  Literal[775]]
+
+
 
 __all__ = [
     "BufferProtocol",