(api-break) remove DEFAULT_PRIORITY

Author: gottadiveintopython

examples/01_event_handling.py

@@ -8,7 +8,7 @@ async def main(*, sdlevent: apg.SDLEvent, **kwargs):
     pygame.display.set_mode((400, 400))
 
     while True:
-        e = await sdlevent.wait(pygame.MOUSEBUTTONDOWN, pygame.MOUSEBUTTONUP)
+        e = await sdlevent.wait(pygame.MOUSEBUTTONDOWN, pygame.MOUSEBUTTONUP, priority=0x100)
         print(e)
 
 

examples/loop_animation (skippable).py

@@ -22,7 +22,7 @@ async def main(**kwargs: Unpack[apg.CommonParams]):
     r(pygame.display.flip, priority=0xFFFFFF00)
     del r
 
-    mouse_button_down = partial(kwargs["sdlevent"].wait, pygame.MOUSEBUTTONDOWN)
+    mouse_button_down = partial(kwargs["sdlevent"].wait, pygame.MOUSEBUTTONDOWN, priority=0x100)
     move_sprite = partial(kwargs["clock"].anim_attrs, img_rect, duration=1000)
     wait_any = apg.wait_any
 

examples/scene_transition_showcase.py

@@ -36,7 +36,7 @@ async def show_transition(*, scene_switcher, userdata, executor, sdlevent, draw_
     text, transition = next(userdata['transitions'])
     img = font.render(text, True, "white").convert_alpha()
     with executor.register(partial(draw_target.blit, img, img.get_rect(center=draw_target.get_rect().center)), priority=0x100):
-        await sdlevent.wait(pygame.MOUSEBUTTONDOWN)
+        await sdlevent.wait(pygame.MOUSEBUTTONDOWN, priority=0)
         scene_switcher.switch_to(show_transition, transition)
         await apg.sleep_forever()
 

src/asyncpygame/__init__.py

@@ -1,12 +1,11 @@
 __all__ = (
-    'DEFAULT_PRIORITY', 'run', 'quit', 'Clock', 'SDLEvent', 'PriorityExecutor',
+    'run', 'quit', 'Clock', 'SDLEvent', 'PriorityExecutor',
     'CommonParams', 'capture_current_frame', 'block_input_events',
 )
 
 from asyncgui import *
 from asyncgui_ext.clock import Clock
 from ._runner import run, quit
-from .constants import DEFAULT_PRIORITY
 from ._sdlevent import SDLEvent
 from ._priority_executor import PriorityExecutor
 from ._utils import CommonParams, capture_current_frame, block_input_events

src/asyncpygame/_priority_executor.py

@@ -1,5 +1,4 @@
 from heapq import merge as heapq_merge
-from .constants import DEFAULT_PRIORITY
 
 
 class ExecutionRequest:
@@ -95,7 +94,7 @@ def __call__(self, *args):
             self._reqs = reqs2
             self._reqs_2 = reqs
 
-    def register(self, func, priority=DEFAULT_PRIORITY) -> ExecutionRequest:
+    def register(self, func, priority) -> ExecutionRequest:
         req = ExecutionRequest(priority, func)
         self._reqs_to_be_added.append(req)
         return req

src/asyncpygame/_runner.py

@@ -20,8 +20,8 @@ def run(main_func, *, fps=30, auto_quit=True):
     main_task = ap.start(main_func(clock=clock, sdlevent=sdlevent, executor=executor, pygame_clock=pygame_clock))
 
     if auto_quit:
-        sdlevent.subscribe((pygame.QUIT, ), quit)
-        sdlevent.subscribe((pygame.KEYDOWN, ), lambda e, K=pygame.K_ESCAPE: e.key == K and quit())
+        sdlevent.subscribe((pygame.QUIT, ), quit, priority=0)
+        sdlevent.subscribe((pygame.KEYDOWN, ), lambda e, K=pygame.K_ESCAPE: e.key == K and quit(), priority=0)
 
     # LOAD_FAST
     pygame_event_get = pygame.event.get

src/asyncpygame/_sdlevent.py

@@ -8,8 +8,6 @@
 from pygame.event import Event
 from asyncgui import _current_task, _sleep_forever, current_task
 
-from .constants import DEFAULT_PRIORITY
-
 
 def _callback(filter, consume, task_step, event: Event):
     if filter(event):
@@ -141,7 +139,7 @@ def dispatch(self, event: Event):
             self._subs = subs2
             self._subs_2 = subs
 
-    def subscribe(self, topics, callback, priority=DEFAULT_PRIORITY) -> Subscriber:
+    def subscribe(self, topics, callback, priority) -> Subscriber:
         '''
         async型APIの礎となっているコールバック型API。直接触るべきではない。
         '''
@@ -150,7 +148,7 @@ def subscribe(self, topics, callback, priority=DEFAULT_PRIORITY) -> Subscriber:
         return sub
 
     @types.coroutine
-    def wait(self, *event_types, filter=_accept_any, priority=DEFAULT_PRIORITY, consume=False) -> Awaitable[Event]:
+    def wait(self, *event_types, filter=_accept_any, priority, consume=False) -> Awaitable[Event]:
         '''
         Waits for any of the specified types of events to occur.
         '''
@@ -162,7 +160,7 @@ def wait(self, *event_types, filter=_accept_any, priority=DEFAULT_PRIORITY, cons
             sub.cancel()
 
     @asynccontextmanager
-    async def wait_freq(self, *event_types, filter=_accept_any, priority=DEFAULT_PRIORITY, consume=False):
+    async def wait_freq(self, *event_types, filter=_accept_any, priority, consume=False):
         '''
         ``MOUSEMOTION`` や ``FINGERMOTION`` などの頻りに起こりうるイベントを効率良く捌けるかもしれない機能。
         以下のようなコードは

src/asyncpygame/constants.py

@@ -1,11 +1,10 @@
 __all__ = (
-    'DEFAULT_PRIORITY', 'INPUT_EVENTS',
+    'INPUT_EVENTS',
 )
 
 import pygame.constants as C
 
 
-DEFAULT_PRIORITY = 0
 INPUT_EVENTS = {
     C.KEYDOWN, C.KEYUP,
     C.MOUSEMOTION, C.MOUSEBUTTONDOWN, C.MOUSEBUTTONUP, C.MOUSEWHEEL,

tests/test_priority_executor.py

@@ -9,7 +9,7 @@ def executor():
 
 def test_basis(executor):
     values = []
-    req = executor.register(lambda: values.append('A'))
+    req = executor.register(lambda: values.append('A'), priority=0)
     assert values == []
     executor()
     assert values == ['A', ]
@@ -22,8 +22,8 @@ def test_basis(executor):
 
 def test_same_priority(executor):
     values = []
-    req = executor.register(lambda: values.append('A'))
-    executor.register(lambda: values.append('B'))
+    req = executor.register(lambda: values.append('A'), priority=0)
+    executor.register(lambda: values.append('B'), priority=0)
     assert values == []
     executor()
     assert sorted(values) == ['A', 'B', ]

tests/test_sdlevent.py

@@ -10,7 +10,7 @@ def se():
 
 def test_subscribe(se):
     received = []
-    sub = se.subscribe((1, 2), received.append)
+    sub = se.subscribe((1, 2), received.append, priority=0)
     se.dispatch(E(1))
     assert len(received) == 1
     se.dispatch(E(0))
@@ -30,10 +30,10 @@ def test_two_subscribers_with_the_same_priority(se):
     def store_value(e):
         value_list.append(e.value)
 
-    sub = se.subscribe((1, ), store_value)
+    sub = se.subscribe((1, ), store_value, priority=0)
     se.dispatch(E(1, value='A'))
     assert value_list == ['A', ]
-    se.subscribe((1, ), store_value)
+    se.subscribe((1, ), store_value, priority=0)
     se.dispatch(E(1, value='B'))
     assert value_list == ['A', 'B', 'B',]
     sub.cancel()
@@ -77,7 +77,7 @@ def test_stop_dispatching(se):
 def test_wait(se):
     from asyncgui import start
 
-    task = start(se.wait(1, 2))
+    task = start(se.wait(1, 2, priority=0))
     se.dispatch(E(0))
     assert not task.finished
     se.dispatch(E(1))
@@ -87,7 +87,7 @@ def test_wait(se):
 def test_wait_with_filter(se):
     from asyncgui import start
 
-    task = start(se.wait(1, 2, filter=lambda e: e.value == 'A'))
+    task = start(se.wait(1, 2, filter=lambda e: e.value == 'A', priority=0))
     se.dispatch(E(0, value='B'))
     assert not task.finished
     se.dispatch(E(0, value='A'))
@@ -115,7 +115,7 @@ def test_wait_freq(se):
     from asyncgui import start
 
     async def async_fn():
-        async with se.wait_freq(1, 2) as event:
+        async with se.wait_freq(1, 2, priority=0) as event:
             return await event()
 
     task = start(async_fn())
@@ -129,7 +129,7 @@ def test_wait_freq_with_filter(se):
     from asyncgui import start
 
     async def async_fn():
-        async with se.wait_freq(1, 2, filter=lambda e: e.value == 'A') as event:
+        async with se.wait_freq(1, 2, filter=lambda e: e.value == 'A', priority=0) as event:
             return await event()
 
     task = start(async_fn())
@@ -168,7 +168,7 @@ def test_wait_freq_mixed_with_another_type_of_awaitable(se):
     from asyncgui import start, Event
 
     async def async_fn():
-        async with se.wait_freq(1, 2) as event:
+        async with se.wait_freq(1, 2, priority=0) as event:
             await event()
             await ae.wait()
             await event()