Examples broken call to View.close on ESC

[cdeil]

There's a few examples that call View.close on ESC key.

Here:

arcade/arcade/examples/astar_pathfinding.py

Lines 216 to 218 in 333ce6e

	# Close the window / exit game
	elif key == arcade.key.ESCAPE:
	self.close()

Here:

arcade/arcade/examples/asteroid_smasher.py

Lines 317 to 319 in 333ce6e

	# Quit if the player hits escape
	elif symbol == arcade.key.ESCAPE:
	self.close()

Here, but it's dead code since ESC is tested twice in elif statements and only the first is executed:

arcade/arcade/examples/dual_stick_shooter.py

Lines 278 to 282 in 333ce6e

	elif key == arcade.key.ESCAPE:
	self.player.start_pressed = True
	# close the window if the user hits the escape key
	elif key == arcade.key.ESCAPE:
	self.close()

Here:

arcade/arcade/examples/slime_invaders.py

Lines 202 to 203 in 333ce6e

	if key == arcade.key.ESCAPE:
	self.close()

I presume this is a recent API change, but I don't see it mentioned here!?

https://github.com/pythonarcade/arcade/blob/development/CHANGELOG.md#window-and-view

What is the proper fix / coding pattern here to process ESC when sub-classing arcade.View?

I can send a PR if you let me know.

[einarf]

Nice catch.

This is just lingering code after many examples were converted into Views because we try to promote them over subclassing the window itself for more flexibility. We could change it to call self.window.close() or actually make a close() wrapper function in the View that calls self.window.close() to make it simpler for users.

[einarf]

Be free to make a PR :)

[pushfoo]

We may want to look at some proxying mechanism in classes + sphinx in the future. For the time being, the simplest solution's probably the best.

[einarf]

For now we should use arcade.close_window() or self.window.close() in views

[einarf]

Fixed in the referenced PR

[cdeil]

This is just lingering code after many examples were converted into Views because we try to promote them over subclassing the window itself for more flexibility. We could change it to call self.window.close()

Ah, good to know that there's View.window :-)

For newcomers like me it's difficult to understand the coding patterns when or why to subclass Window or View or when to create extra classes and how they relate. If any experienced dev has capacity to write a docs page on that I think that would be very useful. I plan to teach a 16 year old Python including OOP using Arcade soon, but to be honest I still haven't figured out what good practices are where to introduce more or less classes.

I did find https://youtu.be/7TdbpIOfosQ?si=JKeoMyNsAYjTR6uV yesterday which explains a coding pattern of having a separate Game class from Window when using pure pyglet. Would be great to have something similar as docs page and/or video for Arcade. The docstring of arcade.View mentions that it's good to have multiple View classes to represent different "screens" like intro/main/game over screens. But then I think the examples I saw so far don't follow that recommendation!?

Fixed in the referenced PR

There's still a bug in this one:

arcade/arcade/examples/dual_stick_shooter.py

Lines 278 to 282 in 7717e3f

	elif key == arcade.key.ESCAPE:
	self.player.start_pressed = True
	# close the window if the user hits the escape key
	elif key == arcade.key.ESCAPE:
	self.window.close()

There's two elif testing for ESC and the second one closing the window will never be reached (see https://docs.python.org/3/reference/compound_stmts.html#the-if-statement). For the first condition the game over just flashes and then the game re-starts. Is that intended or should it display and then the game should re-start on some key press?

I'll re-open the ticket. Apologies for not simply sending a PR - as mentioned it's not clear to me what a good solution here is. Introduce a second different key or change the elif so that pressing ESC twice will close the window?

[einarf]

Fixed the double ESC check and created this #2549

We definitely need better docs. We restructured the entire thing in 3.0.0 and now we can keep improving the content.