Rename block_inputs()

src/asyncpygame/__init__.py

@@ -1,6 +1,6 @@
 __all__ = (
     'DEFAULT_PRIORITY', 'run', 'quit', 'Clock', 'SDLEvent', 'PriorityExecutor',
-    'capture_current_frame', 'block_inputs',
+    'capture_current_frame', 'block_input_events',
 )
 
 from asyncgui import *
@@ -9,4 +9,4 @@
 from .constants import DEFAULT_PRIORITY
 from ._sdlevent import SDLEvent
 from ._priority_executor import PriorityExecutor
-from ._utils import capture_current_frame, block_inputs
+from ._utils import capture_current_frame, block_input_events

src/asyncpygame/_sdlevent.py

@@ -45,15 +45,15 @@ class Subscriber:
         sub.callback = another_function
     '''
 
-    event_types: Container = None
+    topics: Container = None
     '''
     The types of :class:`pygame.event.Event` that the subscriber is interested in.
     You can change it by simply assigning to this attribute.
 
     .. code-block::
 
         sub = sdl_event.subscribe(...)
-        sub.event_types = (FINGERMOTION, FINGERUP, )
+        sub.topics = (FINGERMOTION, FINGERUP, )
     '''
 
     _cancelled: bool = False
@@ -133,19 +133,19 @@ def dispatch(self, event: Event):
                 if sub._cancelled:
                     continue
                 subs2_append(sub)
-                if event_type in sub.event_types and sub.callback(event):
+                if event_type in sub.topics and sub.callback(event):
                     subs2.extend(sub_iter)
                     return
         finally:
             subs.clear()
             self._subs = subs2
             self._subs_2 = subs
 
-    def subscribe(self, event_types, callback, priority=DEFAULT_PRIORITY) -> Subscriber:
+    def subscribe(self, topics, callback, priority=DEFAULT_PRIORITY) -> Subscriber:
         '''
         async型APIの礎となっているコールバック型API。直接触るべきではない。
         '''
-        sub = Subscriber(priority, callback, event_types)
+        sub = Subscriber(priority, callback, topics)
         self._subs_to_be_added.append(sub)
         return sub
 

src/asyncpygame/_utils.py

@@ -1,5 +1,5 @@
 __all__ = (
-    'capture_current_frame', 'block_inputs',
+    'capture_current_frame', 'block_input_events',
 )
 
 from typing import Awaitable, ContextManager
@@ -24,13 +24,13 @@ async def capture_current_frame(executor: PriorityExecutor, priority, source: Su
     return source.copy()
 
 
-def block_inputs(sdlevent: SDLEvent, priority) -> ContextManager[Subscriber]:
+def block_input_events(sdlevent: SDLEvent, priority) -> ContextManager[Subscriber]:
     '''
     Returns a context manager that blocks input events.
 
     .. code-block::
 
-        with block_inputs(sdlevent, priority):
+        with block_input_events(sdlevent, priority):
             ...
 
     .. warning::

src/asyncpygame/constants.py

@@ -11,4 +11,6 @@
     C.MOUSEMOTION, C.MOUSEBUTTONDOWN, C.MOUSEBUTTONUP, C.MOUSEWHEEL,
     C.FINGERDOWN, C.FINGERUP, C.FINGERMOTION,
     C.JOYAXISMOTION, C.JOYBALLMOTION, C.JOYHATMOTION, C.JOYBUTTONDOWN, C.JOYBUTTONUP,
+    C.TEXTEDITING, C.TEXTINPUT,
+    C.MULTIGESTURE,
 }

src/asyncpygame/scene_switcher.py

@@ -10,7 +10,7 @@
 import asyncgui as ag
 from pygame.math import Vector2
 
-from ._utils import capture_current_frame, block_inputs
+from ._utils import capture_current_frame, block_input_events
 
 
 Transition: TypeAlias = Callable[..., AsyncGenerator[None, None]]
@@ -87,7 +87,7 @@ async def run(self, first_scene, *, userdata: Any=None, priority, sdlevent, **kw
                 next_scene, transition = (await self._next_scene_request.wait())[0]
                 agen = transition(priority=priority, **common_params)
                 try:
-                    with block_inputs(sdlevent, priority):
+                    with block_input_events(sdlevent, priority):
                         await agen.asend(None)
                         task.cancel()
                         await agen.asend(None)

tests/test_block_inputs.py → tests/test_block_input_events.py

@@ -8,7 +8,7 @@ def test_lower_priority():
 
     received = []
     sdlevent.subscribe((KEYDOWN, ), received.append, priority=20)
-    with ap.block_inputs(sdlevent, priority=10):
+    with ap.block_input_events(sdlevent, priority=10):
         sdlevent.dispatch(Event(KEYDOWN))
         assert len(received) == 1
     sdlevent.dispatch(Event(KEYDOWN))
@@ -21,7 +21,7 @@ def test_higher_priority():
 
     received = []
     sdlevent.subscribe((KEYDOWN, ), received.append, priority=0)
-    with ap.block_inputs(sdlevent, priority=10):
+    with ap.block_input_events(sdlevent, priority=10):
         sdlevent.dispatch(Event(KEYDOWN))
         assert len(received) == 0
     sdlevent.dispatch(Event(KEYDOWN))