Mypy/fix pep 484 (#1399)

* fix mypy issues for PEP 484 and more
* make SpriteList generic

Author: eruvanos

arcade/__init__.py

@@ -8,14 +8,15 @@
 # Error out if we import Arcade with an incompatible version of Python.
 import sys
 import os
+from typing import Optional
 
 from pathlib import Path
 
 if sys.version_info[0] < 3 or (sys.version_info[0] == 3 and sys.version_info[1] < 7):
     sys.exit("The Arcade Library requires Python 3.7 or higher.")
 
 
-def configure_logging(level: int = None):
+def configure_logging(level: Optional[int] = None):
     """Set up basic logging.
     :param int level: The log level. Defaults to DEBUG.
     """
@@ -340,7 +341,6 @@ def configure_logging(level: int = None):
     Text,
 )
 
-
 __all__ = ['AStarBarrierList',
            'AnimatedTimeBasedSprite',
            'AnimatedWalkingSprite',

arcade/application.py

@@ -277,7 +277,7 @@ def close(self):
     def set_fullscreen(self,
                        fullscreen: bool = True,
                        screen: Optional['Window'] = None,
-                       mode: ScreenMode = None,
+                       mode: Optional[ScreenMode] = None,
                        width: Optional[float] = None,
                        height: Optional[float] = None):
         """
@@ -902,7 +902,7 @@ class View:
     """
 
     def __init__(self,
-                 window: Window = None):
+                 window: Optional[Window] = None):
 
         self.window = arcade.get_window() if window is None else window
         self.key: Optional[int] = None
@@ -934,7 +934,7 @@ def clear(
         self,
         color: Optional[Color] = None,
         normalized: bool = False,
-        viewport: Tuple[int, int, int, int] = None,
+        viewport: Optional[Tuple[int, int, int, int]] = None,
     ):
         """Clears the View's Window with the configured background color
         set through :py:attr:`arcade.Window.background_color`.

arcade/background/__init__.py

@@ -1,4 +1,4 @@
-from typing import Tuple
+from typing import Optional, Tuple
 
 from PIL import Image
 
@@ -42,16 +42,16 @@ def texture_from_file(
 def background_from_file(
     tex_src: str,
     pos: Tuple[float, float] = (0.0, 0.0),
-    size: Tuple[int, int] = None,
+    size: Optional[Tuple[int, int]] = None,
     offset: Tuple[float, float] = (0.0, 0.0),
     scale: float = 1.0,
     angle: float = 0.0,
     *,
     filters=(gl.NEAREST, gl.NEAREST),
-    color: Tuple[int, int, int] = None,
-    color_norm: Tuple[float, float, float] = None,
-    shader: gl.Program = None,
-    geometry: gl.Geometry = None
+    color: Optional[Tuple[int, int, int]] = None,
+    color_norm: Optional[Tuple[float, float, float]] = None,
+    shader: Optional[gl.Program] = None,
+    geometry: Optional[gl.Geometry] = None
 ) -> Background:
 
     texture = BackgroundTexture.from_file(tex_src, offset, scale, angle, filters)

arcade/background/background.py

@@ -1,4 +1,4 @@
-from typing import Union, Tuple
+from typing import Optional, Union, Tuple
 
 from arcade.window_commands import get_window
 import arcade.gl as gl
@@ -24,8 +24,8 @@ def __init__(
         pos: Tuple[float, float],
         size: Tuple[int, int],
         color: Union[Tuple[float, float, float], Tuple[int, int, int]],
-        shader: gl.Program = None,
-        geometry: gl.Geometry = None,
+        shader: Optional[gl.Program] = None,
+        geometry: Optional[gl.Geometry] = None,
     ):
 
         if shader is None:
@@ -81,16 +81,16 @@ def __init__(
     def from_file(
         tex_src: str,
         pos: Tuple[float, float] = (0.0, 0.0),
-        size: Tuple[int, int] = None,
+        size: Optional[Tuple[int, int]] = None,
         offset: Tuple[float, float] = (0.0, 0.0),
         scale: float = 1.0,
         angle: float = 0.0,
         *,
         filters=(gl.NEAREST, gl.NEAREST),
-        color: Tuple[int, int, int] = None,
-        color_norm: Tuple[float, float, float] = None,
-        shader: gl.Program = None,
-        geometry: gl.Geometry = None
+        color: Optional[Tuple[int, int, int]] = None,
+        color_norm: Optional[Tuple[float, float, float]] = None,
+        shader: Optional[gl.Program] = None,
+        geometry: Optional[gl.Geometry] = None
     ):
         """
         This will generate a Background from an input image source. The generated texture is not stored in the

arcade/background/background_texture.py

@@ -1,4 +1,4 @@
-from typing import List, Tuple
+from typing import Optional, List, Tuple
 
 from PIL import Image
 
@@ -123,8 +123,8 @@ def use(self, unit: int = 0) -> None:
     def render_target(
         self,
         context: ArcadeContext,
-        color_attachments: List[gl.Texture] = None,
-        depth_attachment: gl.Texture = None,
+        color_attachments: Optional[List[gl.Texture]] = None,
+        depth_attachment: Optional[gl.Texture] = None,
     ) -> gl.Framebuffer:
         if color_attachments is None:
             color_attachments = []

arcade/background/groups.py

@@ -1,4 +1,4 @@
-from typing import Union, List, Tuple
+from typing import Optional, Union, List, Tuple
 
 import arcade.gl as gl
 from arcade.background import Background
@@ -11,7 +11,7 @@ class BackgroundGroup:
     The offset of the BackgroundGroup is the same as each background.
     """
 
-    def __init__(self, backgrounds: List[Background] = None):
+    def __init__(self, backgrounds: Optional[List[Background]] = None):
         self._backgrounds: List[Background] = [] if backgrounds is None else backgrounds
 
         self._pos = (0.0, 0.0)
@@ -63,16 +63,16 @@ def add_from_file(
         self,
         tex_src: str,
         pos: Tuple[float, float] = (0.0, 0.0),
-        size: Tuple[int, int] = None,
+        size: Optional[Tuple[int, int]] = None,
         offset: Tuple[float, float] = (0.0, 0.0),
         scale: float = 1.0,
         angle: float = 0.0,
         *,
         filters=(gl.NEAREST, gl.NEAREST),
-        color: Tuple[int, int, int] = None,
-        color_norm: Tuple[float, float, float] = None,
-        shader: gl.Program = None,
-        geometry: gl.Geometry = None
+        color: Optional[Tuple[int, int, int]] = None,
+        color_norm: Optional[Tuple[float, float, float]] = None,
+        shader: Optional[gl.Program] = None,
+        geometry: Optional[gl.Geometry] = None
     ):
         background = Background.from_file(
             tex_src,
@@ -100,7 +100,7 @@ class ParallaxGroup:
     """
 
     def __init__(
-        self, backgrounds: List[Background] = None, depths: List[float] = None
+        self, backgrounds: Optional[List[Background]] = None, depths: Optional[List[float]] = None
     ):
         self._backgrounds: List[Background] = [] if backgrounds is None else backgrounds
         self._depths: List[float] = [] if depths is None else depths
@@ -168,17 +168,17 @@ def add_from_file(
         self,
         tex_src: str,
         pos: Tuple[float, float] = (0.0, 0.0),
-        size: Tuple[int, int] = None,
+        size: Optional[Tuple[int, int]] = None,
         depth: float = 1,
         offset: Tuple[float, float] = (0.0, 0.0),
         scale: float = 1.0,
         angle: float = 0.0,
         *,
         filters=(gl.NEAREST, gl.NEAREST),
-        color: Tuple[int, int, int] = None,
-        color_norm: Tuple[float, float, float] = None,
-        shader: gl.Program = None,
-        geometry: gl.Geometry = None
+        color: Optional[Tuple[int, int, int]] = None,
+        color_norm: Optional[Tuple[float, float, float]] = None,
+        shader: Optional[gl.Program] = None,
+        geometry: Optional[gl.Geometry] = None
     ):
         background = Background.from_file(
             tex_src,

arcade/camera.py

@@ -27,8 +27,8 @@ class SimpleCamera:
     """
 
     def __init__(self, *,
-                 viewport: FourIntTuple = None,
-                 projection: FourFloatTuple = None,
+                 viewport: Optional[FourIntTuple] = None,
+                 projection: Optional[FourFloatTuple] = None,
                  window: Optional["arcade.Window"] = None) -> None:
 
         # Reference to Context, used to update projection matrix

arcade/draw_commands.py

@@ -17,7 +17,7 @@
 
 import pyglet.gl as gl
 
-from typing import Tuple
+from typing import Optional, Tuple
 
 from arcade import Color
 from arcade import PointList
@@ -877,7 +877,7 @@ def get_pixel(x: int, y: int, components: int = 3) -> Tuple[int, ...]:
     return tuple(int(i) for i in a[:components])
 
 
-def get_image(x: int = 0, y: int = 0, width: int = None, height: int = None) -> PIL.Image.Image:
+def get_image(x: int = 0, y: int = 0, width: Optional[int] = None, height: Optional[int] = None) -> PIL.Image.Image:
     """
     Get an image from the screen.
 

arcade/emitter.py

@@ -5,7 +5,7 @@
 
 import arcade
 from arcade.particle import Particle
-from typing import Callable, cast
+from typing import Optional, Callable, cast
 from arcade.utils import _Vec2
 from arcade.arcade_types import Point, Vector
 
@@ -109,8 +109,8 @@ def __init__(
         emit_controller: EmitController,
         particle_factory: Callable[["Emitter"], Particle],
         change_xy: Vector = (0.0, 0.0),
-        emit_done_cb: Callable[["Emitter"], None] = None,
-        reap_cb: Callable[[], None] = None
+        emit_done_cb: Optional[Callable[["Emitter"], None]] = None,
+        reap_cb: Optional[Callable[[], None]] = None
     ):
         # Note Self-reference with type annotations:
         #     https://www.python.org/dev/peps/pep-0484/#the-problem-of-forward-declarations

arcade/examples/performance_statistics.py

@@ -20,6 +20,8 @@
 python -m arcade.examples.performance_statistics
 """
 import random
+from typing import Optional
+
 import arcade
 
 # --- Constants ---
@@ -74,9 +76,9 @@ def __init__(self):
         super().__init__(SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_TITLE)
 
         # Variables to hold game objects and performance info
-        self.coin_list: arcade.SpriteList = None
-        self.perf_graph_list: arcade.SpriteList = None
-        self.fps_text: arcade.Text = None
+        self.coin_list: Optional[arcade.SpriteList] = None
+        self.perf_graph_list: Optional[arcade.SpriteList] = None
+        self.fps_text: Optional[arcade.Text] = None
         self.frame_count: int = 0  # for tracking the reset interval
 
         arcade.set_background_color(arcade.color.AMAZON)