doc_stack/docstring_misc

arcade/__init__.py

@@ -3,8 +3,9 @@
 
 A Python simple, easy to use module for creating 2D games.
 """
-# flake8: noqa: E402
+from __future__ import annotations
 
+# flake8: noqa: E402
 # Error out if we import Arcade with an incompatible version of Python.
 import sys
 import os

arcade/__main__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from arcade.management import show_info
 
 

arcade/__pyinstaller/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 
 

arcade/__pyinstaller/hook-arcade.py

@@ -9,6 +9,8 @@
 For a walk through of building an Arcade application with pyinstaller see:
 https://api.arcade.academy/en/latest/tutorials/bundling_with_pyinstaller/index.html
 """
+from __future__ import annotations
+
 from pathlib import Path
 
 import arcade

arcade/application.py

@@ -2,6 +2,8 @@
 The main window class that all object-oriented applications should
 derive from.
 """
+from __future__ import annotations
+
 import logging
 import os
 import time

arcade/background/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Optional, Tuple
 
 from PIL import Image

arcade/background/background.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Optional, Union, Tuple
 
 from arcade.window_commands import get_window

arcade/background/background_texture.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Optional, List, Tuple
 
 from PIL import Image

arcade/background/groups.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Optional, Union, List, Tuple
 
 import arcade.gl as gl

arcade/cache/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any, List
 from .hit_box import HitBoxCache
 from .texture import TextureCache

arcade/cache/hit_box.py

@@ -8,6 +8,8 @@
 * Simple   : Scanning the corners for the texture
 * Detailed : fairly detailed hit box generated by pymunk with detail parameter
 """
+from __future__ import annotations
+
 import gzip
 import json
 from pathlib import Path

arcade/cache/image_data.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Dict, Optional, TYPE_CHECKING
 from weakref import WeakValueDictionary
 

arcade/cache/texture.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Dict, Optional, TYPE_CHECKING, Union, List
 from pathlib import Path
 from weakref import WeakValueDictionary

arcade/camera.py

@@ -1,6 +1,8 @@
 """
 Camera class
 """
+from __future__ import annotations
+
 import math
 from typing import TYPE_CHECKING, List, Optional, Tuple, Union
 

arcade/color/__init__.py

@@ -1,6 +1,8 @@
 """
 This module pre-defines several colors.
 """
+from __future__ import annotations
+
 from arcade.types import Color
 
 AERO_BLUE = Color(201, 255, 229, 255)

arcade/context.py

@@ -2,6 +2,8 @@
 Arcade's version of the OpenGL Context.
 Contains pre-loaded programs
 """
+from __future__ import annotations
+
 from pathlib import Path
 from typing import Any, Iterable, Dict, Optional, Tuple, Union, Sequence
 from contextlib import contextmanager

arcade/controller.py

@@ -4,6 +4,8 @@
 For more info on this API, see https://pyglet.readthedocs.io/en/latest/programming_guide/input.html#using-controllers
 """
 
+from __future__ import annotations
+
 import pyglet.input
 
 __all__ = [

arcade/csscolor/__init__.py

@@ -2,6 +2,8 @@
 This module pre-defines colors as defined by the W3C CSS standard:
 https://www.w3.org/TR/2018/PR-css-color-3-20180315/
 """
+from __future__ import annotations
+
 from arcade.types import Color
 
 ALICE_BLUE = Color(240, 248, 255, 255)

arcade/draw_commands.py

@@ -6,6 +6,8 @@
 graphics card each time a shape is drawn. For faster drawing, see the
 Buffered Draw Commands.
 """
+from __future__ import annotations
+
 import array
 import math
 from typing import Optional, Tuple

arcade/drawing_support.py

@@ -2,6 +2,8 @@
 Functions used to support drawing. No Pyglet/OpenGL here.
 """
 
+from __future__ import annotations
+
 import math
 
 __all__ = ["get_points_for_thick_line"]

arcade/earclip.py

@@ -3,6 +3,8 @@
 from: https://github.com/linuxlewis/tripy/blob/master/tripy.py
 """
 
+from __future__ import annotations
+
 from arcade.types import Point, PointList
 from typing import List, Tuple
 

arcade/easing.py

@@ -1,6 +1,8 @@
 """
 Functions used to support easing
 """
+from __future__ import annotations
+
 from math import pi, sin, cos
 from dataclasses import dataclass
 from typing import Callable, Tuple

arcade/examples/array_backed_grid.py

@@ -13,6 +13,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.array_backed_grid
 """
+from __future__ import annotations
+
 import arcade
 
 # Set how many rows and columns we will have

arcade/examples/array_backed_grid_buffered.py

@@ -13,6 +13,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.array_backed_grid_buffered
 """
+from __future__ import annotations
+
 import arcade
 
 # Set how many rows and columns we will have

arcade/examples/array_backed_grid_sprites_1.py

@@ -12,6 +12,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.array_backed_grid_sprites_1
 """
+from __future__ import annotations
+
 import arcade
 
 # Set how many rows and columns we will have

arcade/examples/array_backed_grid_sprites_2.py

@@ -12,6 +12,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.array_backed_grid_sprites_2
 """
+from __future__ import annotations
+
 import arcade
 
 # Set how many rows and columns we will have

arcade/examples/astar_pathfinding.py

@@ -7,6 +7,8 @@
 python -m arcade.examples.astar_pathfinding
 """
 
+from __future__ import annotations
+
 import arcade
 import random
 

arcade/examples/asteroid_smasher.py

@@ -13,6 +13,8 @@
 the command line with:
 python -m arcade.examples.asteroid_smasher
 """
+from __future__ import annotations
+
 import random
 import math
 import arcade

arcade/examples/background_blending.py

@@ -9,6 +9,8 @@
 python -m arcade.examples.background_blending
 """
 
+from __future__ import annotations
+
 import arcade
 import arcade.background as background
 

arcade/examples/background_groups.py

@@ -11,6 +11,8 @@
 python -m arcade.examples.background_groups
 """
 
+from __future__ import annotations
+
 import arcade
 import arcade.background as background
 

arcade/examples/background_parallax.py

@@ -13,6 +13,8 @@
 python -m arcade.examples.background_parallax
 """
 
+from __future__ import annotations
+
 import arcade
 import arcade.background as background
 

arcade/examples/background_scrolling.py

@@ -9,6 +9,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.background_scrolling
 """
+from __future__ import annotations
+
 import arcade
 import arcade.background as background
 

arcade/examples/background_stationary.py

@@ -8,6 +8,8 @@
 python -m arcade.examples.background_stationary
 """
 
+from __future__ import annotations
+
 import arcade
 import arcade.background as background
 

arcade/examples/bloom_defender.py

@@ -7,6 +7,8 @@
 python -m arcade.examples.bloom_defender
 """
 
+from __future__ import annotations
+
 import arcade
 import random
 

arcade/examples/bouncing_rectangle.py

@@ -7,6 +7,8 @@
 python -m arcade.examples.bouncing_rectangle
 """
 
+from __future__ import annotations
+
 import arcade
 
 # --- Set up the constants

arcade/examples/camera_platform.py

@@ -8,6 +8,8 @@
 python -m arcade.examples.camera_platform
 """
 
+from __future__ import annotations
+
 import time
 
 import arcade

arcade/examples/conway_alpha.py

@@ -8,6 +8,8 @@
 typing:
 python -m arcade.examples.conway_alpha
 """
+from __future__ import annotations
+
 import arcade
 import random
 

arcade/examples/drawing_primitives.py

@@ -15,6 +15,8 @@
 python -m arcade.examples.drawing_primitives
 """
 
+from __future__ import annotations
+
 # Import the Arcade library. If this fails, then try following the instructions
 # for how to install arcade:
 # https://api.arcade.academy/en/latest/install/index.html

arcade/examples/drawing_text.py

@@ -4,6 +4,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.drawing_text
 """
+from __future__ import annotations
+
 import arcade
 
 SCREEN_WIDTH = 1200

arcade/examples/drawing_text_objects.py

@@ -5,6 +5,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.drawing_text_objects
 """
+from __future__ import annotations
+
 import arcade
 
 SCREEN_WIDTH = 1200

arcade/examples/drawing_text_objects_batch.py

@@ -10,6 +10,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.drawing_text_objects_batch
 """
+from __future__ import annotations
+
 import arcade
 import pyglet.graphics
 

arcade/examples/dual_stick_shooter.py

@@ -7,6 +7,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.dual_stick_shooter
 """
+from __future__ import annotations
+
 import math
 import pprint
 import random

arcade/examples/easing_example_1.py

@@ -10,6 +10,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.easing_example_1
 """
+from __future__ import annotations
+
 import arcade
 from arcade import easing
 from arcade.types import Color

arcade/examples/easing_example_2.py

@@ -9,6 +9,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.easing_example_2
 """
+from __future__ import annotations
+
 import arcade
 from arcade import easing
 

arcade/examples/follow_path.py

@@ -9,6 +9,8 @@
 python -m arcade.examples.follow_path
 """
 
+from __future__ import annotations
+
 import arcade
 import math
 

arcade/examples/full_screen_example.py

@@ -9,6 +9,8 @@
 python -m arcade.examples.full_screen_example
 """
 
+from __future__ import annotations
+
 import arcade
 
 SPRITE_SCALING = 0.5

arcade/examples/gl/3d_cube.py

@@ -4,6 +4,8 @@
 If Python and Arcade are installed, this example can be run from the command line with:
 python -m arcade.examples.gl.3d_cube
 """
+from __future__ import annotations
+
 from pyglet.math import Mat4
 import arcade
 from arcade.gl import geometry