Skip to content

Commit b692d78

Browse files
HexDecimalHexDecimal
committed
Make EventDispatch on event methods positional only
1 parent f187e9c commit b692d78

File tree

2 files changed

+43
-38
lines changed

2 files changed

+43
-38
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ This project adheres to [Semantic Versioning](https://semver.org/) since version
66

77
## [Unreleased]
88

9+
### Changed
10+
11+
- `EventDispatch`'s on event methods are now defined as positional parameters, so renaming the `event` parameter is now valid in subclasses.
12+
913
### Deprecated
1014

1115
- Keyboard bitmask modifiers `tcod.event.KMOD_*` have been replaced by `tcod.event.Modifier`.

‎tcod/event.py‎

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
from numpy.typing import NDArray
9191
from typing_extensions import Literal
9292

93+
import tcod.event
9394
import tcod.event_constants
9495
import tcod.sdl.joystick
9596
import tcod.sdl.sys
@@ -1377,160 +1378,160 @@ def event_wait(self, timeout: float | None) -> None:
13771378
wait(timeout)
13781379
self.event_get()
13791380

1380-
def ev_quit(self, event: tcod.event.Quit) -> T | None:
1381+
def ev_quit(self, event: tcod.event.Quit, /) -> T | None:
13811382
"""Called when the termination of the program is requested."""
13821383

1383-
def ev_keydown(self, event: tcod.event.KeyDown) -> T | None:
1384+
def ev_keydown(self, event: tcod.event.KeyDown, /) -> T | None:
13841385
"""Called when a keyboard key is pressed or repeated."""
13851386

1386-
def ev_keyup(self, event: tcod.event.KeyUp) -> T | None:
1387+
def ev_keyup(self, event: tcod.event.KeyUp, /) -> T | None:
13871388
"""Called when a keyboard key is released."""
13881389

1389-
def ev_mousemotion(self, event: tcod.event.MouseMotion) -> T | None:
1390+
def ev_mousemotion(self, event: tcod.event.MouseMotion, /) -> T | None:
13901391
"""Called when the mouse is moved."""
13911392

1392-
def ev_mousebuttondown(self, event: tcod.event.MouseButtonDown) -> T | None:
1393+
def ev_mousebuttondown(self, event: tcod.event.MouseButtonDown, /) -> T | None:
13931394
"""Called when a mouse button is pressed."""
13941395

1395-
def ev_mousebuttonup(self, event: tcod.event.MouseButtonUp) -> T | None:
1396+
def ev_mousebuttonup(self, event: tcod.event.MouseButtonUp, /) -> T | None:
13961397
"""Called when a mouse button is released."""
13971398

1398-
def ev_mousewheel(self, event: tcod.event.MouseWheel) -> T | None:
1399+
def ev_mousewheel(self, event: tcod.event.MouseWheel, /) -> T | None:
13991400
"""Called when the mouse wheel is scrolled."""
14001401

1401-
def ev_textinput(self, event: tcod.event.TextInput) -> T | None:
1402+
def ev_textinput(self, event: tcod.event.TextInput, /) -> T | None:
14021403
"""Called to handle Unicode input."""
14031404

1404-
def ev_windowshown(self, event: tcod.event.WindowEvent) -> T | None:
1405+
def ev_windowshown(self, event: tcod.event.WindowEvent, /) -> T | None:
14051406
"""Called when the window is shown."""
14061407

1407-
def ev_windowhidden(self, event: tcod.event.WindowEvent) -> T | None:
1408+
def ev_windowhidden(self, event: tcod.event.WindowEvent, /) -> T | None:
14081409
"""Called when the window is hidden."""
14091410

1410-
def ev_windowexposed(self, event: tcod.event.WindowEvent) -> T | None:
1411+
def ev_windowexposed(self, event: tcod.event.WindowEvent, /) -> T | None:
14111412
"""Called when a window is exposed, and needs to be refreshed.
14121413
14131414
This usually means a call to :any:`libtcodpy.console_flush` is necessary.
14141415
"""
14151416

1416-
def ev_windowmoved(self, event: tcod.event.WindowMoved) -> T | None:
1417+
def ev_windowmoved(self, event: tcod.event.WindowMoved, /) -> T | None:
14171418
"""Called when the window is moved."""
14181419

1419-
def ev_windowresized(self, event: tcod.event.WindowResized) -> T | None:
1420+
def ev_windowresized(self, event: tcod.event.WindowResized, /) -> T | None:
14201421
"""Called when the window is resized."""
14211422

1422-
def ev_windowsizechanged(self, event: tcod.event.WindowResized) -> T | None:
1423+
def ev_windowsizechanged(self, event: tcod.event.WindowResized, /) -> T | None:
14231424
"""Called when the system or user changes the size of the window."""
14241425

1425-
def ev_windowminimized(self, event: tcod.event.WindowEvent) -> T | None:
1426+
def ev_windowminimized(self, event: tcod.event.WindowEvent, /) -> T | None:
14261427
"""Called when the window is minimized."""
14271428

1428-
def ev_windowmaximized(self, event: tcod.event.WindowEvent) -> T | None:
1429+
def ev_windowmaximized(self, event: tcod.event.WindowEvent, /) -> T | None:
14291430
"""Called when the window is maximized."""
14301431

1431-
def ev_windowrestored(self, event: tcod.event.WindowEvent) -> T | None:
1432+
def ev_windowrestored(self, event: tcod.event.WindowEvent, /) -> T | None:
14321433
"""Called when the window is restored."""
14331434

1434-
def ev_windowenter(self, event: tcod.event.WindowEvent) -> T | None:
1435+
def ev_windowenter(self, event: tcod.event.WindowEvent, /) -> T | None:
14351436
"""Called when the window gains mouse focus."""
14361437

1437-
def ev_windowleave(self, event: tcod.event.WindowEvent) -> T | None:
1438+
def ev_windowleave(self, event: tcod.event.WindowEvent, /) -> T | None:
14381439
"""Called when the window loses mouse focus."""
14391440

1440-
def ev_windowfocusgained(self, event: tcod.event.WindowEvent) -> T | None:
1441+
def ev_windowfocusgained(self, event: tcod.event.WindowEvent, /) -> T | None:
14411442
"""Called when the window gains keyboard focus."""
14421443

1443-
def ev_windowfocuslost(self, event: tcod.event.WindowEvent) -> T | None:
1444+
def ev_windowfocuslost(self, event: tcod.event.WindowEvent, /) -> T | None:
14441445
"""Called when the window loses keyboard focus."""
14451446

1446-
def ev_windowclose(self, event: tcod.event.WindowEvent) -> T | None:
1447+
def ev_windowclose(self, event: tcod.event.WindowEvent, /) -> T | None:
14471448
"""Called when the window manager requests the window to be closed."""
14481449

1449-
def ev_windowtakefocus(self, event: tcod.event.WindowEvent) -> T | None:
1450+
def ev_windowtakefocus(self, event: tcod.event.WindowEvent, /) -> T | None:
14501451
pass
14511452

1452-
def ev_windowhittest(self, event: tcod.event.WindowEvent) -> T | None:
1453+
def ev_windowhittest(self, event: tcod.event.WindowEvent, /) -> T | None:
14531454
pass
14541455

1455-
def ev_joyaxismotion(self, event: tcod.event.JoystickAxis) -> T | None:
1456+
def ev_joyaxismotion(self, event: tcod.event.JoystickAxis, /) -> T | None:
14561457
"""Called when a joystick analog is moved.
14571458
14581459
.. versionadded:: 13.8
14591460
"""
14601461

1461-
def ev_joyballmotion(self, event: tcod.event.JoystickBall) -> T | None:
1462+
def ev_joyballmotion(self, event: tcod.event.JoystickBall, /) -> T | None:
14621463
"""Called when a joystick ball is moved.
14631464
14641465
.. versionadded:: 13.8
14651466
"""
14661467

1467-
def ev_joyhatmotion(self, event: tcod.event.JoystickHat) -> T | None:
1468+
def ev_joyhatmotion(self, event: tcod.event.JoystickHat, /) -> T | None:
14681469
"""Called when a joystick hat is moved.
14691470
14701471
.. versionadded:: 13.8
14711472
"""
14721473

1473-
def ev_joybuttondown(self, event: tcod.event.JoystickButton) -> T | None:
1474+
def ev_joybuttondown(self, event: tcod.event.JoystickButton, /) -> T | None:
14741475
"""Called when a joystick button is pressed.
14751476
14761477
.. versionadded:: 13.8
14771478
"""
14781479

1479-
def ev_joybuttonup(self, event: tcod.event.JoystickButton) -> T | None:
1480+
def ev_joybuttonup(self, event: tcod.event.JoystickButton, /) -> T | None:
14801481
"""Called when a joystick button is released.
14811482
14821483
.. versionadded:: 13.8
14831484
"""
14841485

1485-
def ev_joydeviceadded(self, event: tcod.event.JoystickDevice) -> T | None:
1486+
def ev_joydeviceadded(self, event: tcod.event.JoystickDevice, /) -> T | None:
14861487
"""Called when a joystick is added.
14871488
14881489
.. versionadded:: 13.8
14891490
"""
14901491

1491-
def ev_joydeviceremoved(self, event: tcod.event.JoystickDevice) -> T | None:
1492+
def ev_joydeviceremoved(self, event: tcod.event.JoystickDevice, /) -> T | None:
14921493
"""Called when a joystick is removed.
14931494
14941495
.. versionadded:: 13.8
14951496
"""
14961497

1497-
def ev_controlleraxismotion(self, event: tcod.event.ControllerAxis) -> T | None:
1498+
def ev_controlleraxismotion(self, event: tcod.event.ControllerAxis, /) -> T | None:
14981499
"""Called when a controller analog is moved.
14991500
15001501
.. versionadded:: 13.8
15011502
"""
15021503

1503-
def ev_controllerbuttondown(self, event: tcod.event.ControllerButton) -> T | None:
1504+
def ev_controllerbuttondown(self, event: tcod.event.ControllerButton, /) -> T | None:
15041505
"""Called when a controller button is pressed.
15051506
15061507
.. versionadded:: 13.8
15071508
"""
15081509

1509-
def ev_controllerbuttonup(self, event: tcod.event.ControllerButton) -> T | None:
1510+
def ev_controllerbuttonup(self, event: tcod.event.ControllerButton, /) -> T | None:
15101511
"""Called when a controller button is released.
15111512
15121513
.. versionadded:: 13.8
15131514
"""
15141515

1515-
def ev_controllerdeviceadded(self, event: tcod.event.ControllerDevice) -> T | None:
1516+
def ev_controllerdeviceadded(self, event: tcod.event.ControllerDevice, /) -> T | None:
15161517
"""Called when a standard controller is added.
15171518
15181519
.. versionadded:: 13.8
15191520
"""
15201521

1521-
def ev_controllerdeviceremoved(self, event: tcod.event.ControllerDevice) -> T | None:
1522+
def ev_controllerdeviceremoved(self, event: tcod.event.ControllerDevice, /) -> T | None:
15221523
"""Called when a standard controller is removed.
15231524
15241525
.. versionadded:: 13.8
15251526
"""
15261527

1527-
def ev_controllerdeviceremapped(self, event: tcod.event.ControllerDevice) -> T | None:
1528+
def ev_controllerdeviceremapped(self, event: tcod.event.ControllerDevice, /) -> T | None:
15281529
"""Called when a standard controller is remapped.
15291530
15301531
.. versionadded:: 13.8
15311532
"""
15321533

1533-
def ev_(self, event: Any) -> T | None:
1534+
def ev_(self, event: Any, /) -> T | None:
15341535
pass
15351536

15361537

0 commit comments

Comments
 (0)