fix tests and type hints

Author: eruvanos

arcade/examples/gui/exp_controller_support.py

@@ -1,3 +1,14 @@
+"""
+Example demonstrating controller support in an Arcade GUI.
+
+This example shows how to integrate controller input with the Arcade GUI framework.
+It includes a controller indicator widget that displays the last controller input,
+and a modal dialog that can be navigated using a controller.
+
+If Arcade and Python are properly installed, you can run this example with:
+python -m arcade.examples.gui.exp_controller_support
+"""
+
 from typing import Optional
 
 import arcade
@@ -34,7 +45,7 @@ class ControllerIndicator(UIAnchorLayout):
     """
 
     BLANK_TEX = Texture.create_empty("empty", (40, 40), arcade.color.TRANSPARENT_BLACK)
-    TEXTURE_CACHE = {}
+    TEXTURE_CACHE: dict[str, Texture] = {}
 
     def __init__(self):
         super().__init__()
@@ -54,53 +65,53 @@ def input_prompts(cls, event: UIControllerEvent) -> Texture | None:
         if isinstance(event, UIControllerButtonEvent):
             match event.button:
                 case "a":
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_a.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/button_a.png")
                 case "b":
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_b.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/button_b.png")
                 case "x":
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_x.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/button_x.png")
                 case "y":
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_y.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/button_y.png")
                 case "rightshoulder":
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_rb.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/rb.png")
                 case "leftshoulder":
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_lb.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/lb.png")
                 case "start":
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_start.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/button_start.png")
                 case "back":
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_button_back.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/button_back.png")
 
         if isinstance(event, UIControllerTriggerEvent):
             match event.name:
                 case "lefttrigger":
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_lt.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/lt.png")
                 case "righttrigger":
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_rt.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/rt.png")
 
         if isinstance(event, UIControllerDpadEvent):
             match event.vector:
                 case (1, 0):
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_dpad_right.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/dpad_right.png")
                 case (-1, 0):
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_dpad_left.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/dpad_left.png")
                 case (0, 1):
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_dpad_up.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/dpad_up.png")
                 case (0, -1):
-                    return cls.get_texture(":resources:input_prompt/xbox/xbox_dpad_down.png")
+                    return cls.get_texture(":resources:input_prompt/xbox/dpad_down.png")
 
         if isinstance(event, UIControllerStickEvent) and event.vector.length() > 0.2:
             stick = "l" if event.name == "leftstick" else "r"
 
             # map atan2(y, x) to direction string (up, down, left, right)
             heading = event.vector.heading()
             if 0.785 > heading > -0.785:
-                return cls.get_texture(f":resources:input_prompt/xbox/xbox_stick_{stick}_right.png")
+                return cls.get_texture(f":resources:input_prompt/xbox/stick_{stick}_right.png")
             elif 0.785 < heading < 2.356:
-                return cls.get_texture(f":resources:input_prompt/xbox/xbox_stick_{stick}_up.png")
+                return cls.get_texture(f":resources:input_prompt/xbox/stick_{stick}_up.png")
             elif heading > 2.356 or heading < -2.356:
-                return cls.get_texture(f":resources:input_prompt/xbox/xbox_stick_{stick}_left.png")
+                return cls.get_texture(f":resources:input_prompt/xbox/stick_{stick}_left.png")
             elif -2.356 < heading < -0.785:
-                return cls.get_texture(f":resources:input_prompt/xbox/xbox_stick_{stick}_down.png")
+                return cls.get_texture(f":resources:input_prompt/xbox/stick_{stick}_down.png")
 
         return None
 

arcade/examples/gui/exp_controller_support_grid.py

@@ -1,3 +1,13 @@
+"""
+Example demonstrating a grid layout with focusable buttons in an Arcade GUI.
+
+This example shows how to create a grid layout with buttons that can be navigated using a controller.
+It includes a focus transition setup to allow smooth navigation between buttons in the grid.
+
+If Arcade and Python are properly installed, you can run this example with:
+python -m arcade.examples.gui.exp_controller_support_grid
+"""
+
 from typing import Dict, Tuple
 
 import arcade
@@ -6,6 +16,7 @@
     UIFlatButton,
     UIGridLayout,
     UIView,
+    UIWidget,
 )
 from arcade.gui.experimental.controller import (
     UIControllerBridge,
@@ -17,7 +28,7 @@ class FocusableButton(Focusable, UIFlatButton):
     pass
 
 
-def setup_grid_focus_transition(grid: Dict[Tuple[int, int], Focusable]):
+def setup_grid_focus_transition(grid: Dict[Tuple[int, int], UIWidget]):
     """Setup focus transition in grid.
 
     Connect focus transition between `Focusable` in grid.

arcade/examples/gui/exp_inventory_demo.py

@@ -10,8 +10,11 @@
 - Move items between slots
 - Controller support
 
+If Arcade and Python are properly installed, you can run this example with:
+python -m arcade.examples.gui.exp_inventory_demo
 """
 
+from functools import partial
 # TODO: Drag and Drop
 
 from typing import List
@@ -204,7 +207,7 @@ def __init__(self, inventory: Inventory, **kwargs):
             # fill left to right, bottom to top (6x5 grid)
             self.add(slot, column=i % 6, row=i // 6)
             self.grid[(i % 6, i // 6)] = slot
-            slot.on_click = self._on_slot_click
+            slot.on_click = self._on_slot_click  # type: ignore
 
         InventoryUI.register_event_type("on_slot_clicked")
 
@@ -235,13 +238,13 @@ def __init__(self, **kwargs):
         equipment = Equipment()
 
         self.head_slot = self.add(EquipmentSlotUI(equipment, 0))
-        self.head_slot.on_click = lambda _: self.dispatch_event("on_slot_clicked", self.head_slot)
+        self.head_slot.on_click = partial(self.dispatch_event, "on_slot_clicked", self.head_slot)
 
         self.chest_slot = self.add(EquipmentSlotUI(equipment, 1))
-        self.chest_slot.on_click = lambda _: self.dispatch_event("on_slot_clicked", self.chest_slot)
+        self.chest_slot.on_click = partial(self.dispatch_event, "on_slot_clicked", self.chest_slot)
 
         self.legs_slot = self.add(EquipmentSlotUI(equipment, 2))
-        self.legs_slot.on_click = lambda _: self.dispatch_event("on_slot_clicked", self.legs_slot)
+        self.legs_slot.on_click = partial(self.dispatch_event, "on_slot_clicked", self.legs_slot)
 
         EquipmentUI.register_event_type("on_slot_clicked")
 
@@ -251,7 +254,7 @@ class ActiveSlotTrackerMixin(UIWidget):
     Mixin class to track the active slot.
     """
 
-    active_slot = Property(None)
+    active_slot = Property[InventorySlotUI | None](None)
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -307,14 +310,16 @@ def __init__(self, inventory: Inventory, **kwargs):
         self.add(content, anchor_y="bottom")
 
         inv_ui = content.add(InventoryUI(inventory))
-        inv_ui.on_slot_clicked = self.on_slot_clicked
+        inv_ui.on_slot_clicked = self.on_slot_clicked  # type: ignore
 
         eq_ui = content.add(EquipmentUI())
-        eq_ui.on_slot_clicked = self.on_slot_clicked
+        eq_ui.on_slot_clicked = self.on_slot_clicked  # type: ignore
 
         # prepare focusable widgets
         widget_grid = inv_ui.grid
-        setup_grid_focus_transition(widget_grid)  # setup default transitions in a grid
+        setup_grid_focus_transition(
+            widget_grid  # type: ignore
+        )  # setup default transitions in a grid
 
         # add transitions to equipment slots
         cols = max(x for x, y in widget_grid.keys())
@@ -343,7 +348,7 @@ def __init__(self, inventory: Inventory, **kwargs):
             anchor_x="right",
             anchor_y="top",
         )
-        close_button.on_click = lambda _: self.close()
+        close_button.on_click = lambda _: self.close()  # type: ignore
 
     def close(self):
         self.trigger_full_render()
@@ -379,6 +384,8 @@ def on_key_press(self, symbol: int, modifiers: int) -> bool | None:
                 print(i, item.symbol if item else "-")
             return True
 
+        return super().on_key_press(symbol, modifiers)
+
     def on_draw_before_ui(self):
         pass
 

arcade/gui/experimental/focus.py

@@ -50,11 +50,13 @@ class Focusable(UIWidget):
     @property
     def ui(self) -> UIManager | None:
         """The UIManager this widget is attached to."""
-        w = self
-        while w.parent:
-            if isinstance(w.parent, UIManager):
-                return w.parent
-            w = self.parent
+        w: UIWidget | None = self
+        while w and w.parent:
+            parent = w.parent
+            if isinstance(parent, UIManager):
+                return parent
+
+            w = parent
         return None
 
     def _render_focus(self, surface: Surface):
@@ -191,10 +193,11 @@ def _ensure_focused_property(self):
         focused = self._get_focused_widget()
 
         for widget in self._focusable_widgets:
-            if widget == focused:
-                widget.focused = True
-            else:
-                widget.focused = False
+            if isinstance(widget, Focusable):
+                if widget == focused:
+                    widget.focused = True
+                else:
+                    widget.focused = False
 
     def _get_focused_widget(self) -> UIWidget | None:
         if len(self._focusable_widgets) == 0:
@@ -215,7 +218,7 @@ def _walk_widgets(cls, root: UIWidget):
             yield child
             yield from cls._walk_widgets(child)
 
-    def detect_focusable_widgets(self, root: UIWidget = None):
+    def detect_focusable_widgets(self, root: UIWidget | None = None):
         """Automatically detect focusable widgets."""
         if root is None:
             root = self
@@ -286,8 +289,8 @@ def start_interaction(self):
             widget.dispatch_ui_event(
                 UIMousePressEvent(
                     source=self,
-                    x=widget.rect.center_x,
-                    y=widget.rect.center_y,
+                    x=int(widget.rect.center_x),
+                    y=int(widget.rect.center_y),
                     button=MOUSE_BUTTON_LEFT,
                     modifiers=0,
                 )
@@ -312,15 +315,16 @@ def end_interaction(self):
             widget.dispatch_ui_event(
                 UIMouseReleaseEvent(
                     source=self,
-                    x=x,
-                    y=y,
+                    x=int(x),
+                    y=int(y),
                     button=MOUSE_BUTTON_LEFT,
                     modifiers=0,
                 )
             )
 
     def _do_render(self, surface: Surface, force=False) -> bool:
-        self._ensure_focused_property()  # TODO this is a hack, to set the focused property on the focused widget
+        # TODO this is a hack, to set the focused property on the focused widget
+        self._ensure_focused_property()
 
         # TODO: add a post child render hook to UIWidget
         rendered = super()._do_render(surface, force)

arcade/gui/ui_manager.py

@@ -18,6 +18,7 @@
 from typing_extensions import TypeGuard
 
 import arcade
+from arcade.experimental.controller_window import ControllerWindow
 from arcade.gui import UIEvent
 from arcade.gui.events import (
     UIKeyPressEvent,
@@ -41,7 +42,7 @@
 )
 from arcade.gui.surface import Surface
 from arcade.gui.widgets import UIWidget
-from arcade.types import LBWH, AnchorPoint, Point2, Rect
+from arcade.types import AnchorPoint, LBWH, Point2, Rect
 
 W = TypeVar("W", bound=UIWidget)
 
@@ -288,6 +289,18 @@ def enable(self) -> None:
         """
         if not self._enabled:
             self._enabled = True
+
+            if isinstance(self.window, ControllerWindow):
+                controller_handlers = {
+                    self.on_stick_motion,
+                    self.on_trigger_motion,
+                    self.on_button_press,
+                    self.on_button_release,
+                    self.on_dpad_motion,
+                }
+            else:
+                controller_handlers = set()
+
             self.window.push_handlers(
                 self.on_resize,
                 self.on_update,
@@ -301,11 +314,7 @@ def enable(self) -> None:
                 self.on_text,
                 self.on_text_motion,
                 self.on_text_motion_select,
-                self.on_stick_motion,
-                self.on_trigger_motion,
-                self.on_button_press,
-                self.on_button_release,
-                self.on_dpad_motion,
+                *controller_handlers,
             )
 
     def disable(self) -> None:
@@ -316,6 +325,18 @@ def disable(self) -> None:
         """
         if self._enabled:
             self._enabled = False
+
+            if isinstance(self.window, ControllerWindow):
+                controller_handlers = {
+                    self.on_stick_motion,
+                    self.on_trigger_motion,
+                    self.on_button_press,
+                    self.on_button_release,
+                    self.on_dpad_motion,
+                }
+            else:
+                controller_handlers = set()
+
             self.window.remove_handlers(
                 self.on_resize,
                 self.on_update,
@@ -329,11 +350,7 @@ def disable(self) -> None:
                 self.on_text,
                 self.on_text_motion,
                 self.on_text_motion_select,
-                self.on_stick_motion,
-                self.on_trigger_motion,
-                self.on_button_press,
-                self.on_button_release,
-                self.on_dpad_motion,
+                *controller_handlers,
             )
 
     def on_update(self, time_delta):

arcade/resources/assets/input_prompt/xbox/xbox_button_a.png

@@ -10,12 +10,12 @@
 
 def test_all():
     resources = arcade.resources.list_built_in_assets()
-    assert len(resources) == pytest.approx(770, abs=10)
+    assert len(resources) == pytest.approx(863, abs=10)
 
 
 def test_png():
     resources = arcade.resources.list_built_in_assets(extensions=(".png",))
-    assert len(resources) == pytest.approx(630, abs=10)
+    assert len(resources) == pytest.approx(723, abs=10)
 
 
 def test_audio():