Skip to content

Remove outdated and duplicate names from the arcade namespace - #2965

Merged
pvcraven merged 1 commit into
developmentfrom
namespace-cleanup
Oct 9, 2026
Merged

pvcraven merged 1 commit into
developmentfrom
namespace-cleanup

Conversation

@pvcraven

@pvcraven pvcraven commented Oct 9, 2026

Copy link
Copy Markdown
Member

Related to #2402.

We reviewed all 169 names in arcade.__all__ and picked the ones that are outdated, duplicated or wrong. This is a breaking change, with a changelog entry under Breaking Changes.

Removed

  • AnimatedWalkingSprite, and the FACE_UP, FACE_DOWN, FACE_LEFT, FACE_RIGHT constants that only it used (arcade/sprite/enums.py is deleted).
    • Its docstring already said "Deprecated… It is highly recommended you create your own version of this class".
    • No examples used it. Its docstring linked to the platformer tutorial's Tiled map step instead of an animation example.
    • The changelog points to the sprite_move_animation example instead.
  • get_game_controllers(). It did the same as get_joysticks(), and its name was wrong: it returned pyglet Joystick objects, while game controllers in Arcade come from get_controllers().
    • The two docstrings pointed at each other, each calling the other the alias.
    • get_joysticks()'s docstring now says what it returns and points to get_controllers() for game controllers.
  • The duplicate draw_lrbt_rectangle_filled and draw_lrbt_rectangle_outline entries in arcade.__all__.

Kept on purpose

  • set_background_color (7 examples use it) and MOUSE_BUTTON_* (the on_mouse_press docs use them). Both overlap newer APIs but are beginner-friendly.
  • start_render/finish_render (static-image scripts) and the timing functions (performance statistics example). These are still current.

Also updated

Testing

The full test suite passes (1840; the 3 removed were the AnimatedWalkingSprite tests), and ruff, mypy, pyright and the docs build are clean.

🤖 Generated with Claude Code

Removes AnimatedWalkingSprite (already documented as deprecated) and the
FACE_* constants only it used, and get_game_controllers, a duplicate of
get_joysticks whose name suggested it returned game controllers. Also
drops the duplicate draw_lrbt_rectangle_filled/outline entries in
arcade.__all__.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@pvcraven
pvcraven merged commit 1b51b85 into development Oct 9, 2026
7 checks passed
@pvcraven
pvcraven deleted the namespace-cleanup branch October 9, 2026 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant