Move actions and HandlersRegistry under event_handlers/ directory

Author: strohganoff

streamdeck/__init__.py

@@ -1,11 +1,11 @@
 from . import (
-    actions,
     command_sender,
     manager,
     models,
     utils,
     websocket,
 )
+from .event_handlers import actions
 
 
 __all__ = [

streamdeck/actions.py streamdeck/event_handlers/actions.pystreamdeck/actions.py renamed to streamdeck/event_handlers/actions.py

@@ -102,39 +102,3 @@ def name(self) -> str:
         return self.uuid.split(".")[-1]
 
 
-class HandlersRegistry:
-    """Manages the registration and retrieval of actions and their event handlers."""
-    _plugin_actions: list[SupportsEventHandlers]
-    """List of registered actions."""
-
-    def __init__(self) -> None:
-        """Initialize an HandlersRegistry instance."""
-        self._plugin_actions = []
-
-    def register(self, action: SupportsEventHandlers) -> None:
-        """Register an action with the registry.
-
-        Args:
-            action (Action): The action to register.
-        """
-        self._plugin_actions.append(action)
-
-    def get_event_handlers(self, event_name: EventNameStr, event_action_uuid: ActionUUIDStr | None = None) -> Generator[EventHandlerFunc, None, None]:
-        """Get all event handlers for a specific event from all registered actions.
-
-        Args:
-            event_name (EventName): The name of the event to retrieve handlers for.
-            event_action_uuid (str | None): The action UUID to get handlers for.
-                If None (i.e., the event is not action-specific), get all handlers for the event.
-
-        Yields:
-            EventHandlerFunc: The event handler functions for the specified event.
-        """
-        for action in self._plugin_actions:
-            # If the event is action-specific (i.e is not a GlobalAction and has a UUID attribute),
-            # only get handlers for that action, as we don't want to trigger
-            # and pass this event to handlers for other actions.
-            if event_action_uuid is not None and (isinstance(action, Action) and action.uuid != event_action_uuid):
-                continue
-
-            yield from action.get_event_handlers(event_name)

streamdeck/event_handlers/registry.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from streamdeck.event_handlers.actions import Action
+
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
+    from streamdeck.event_handlers.protocol import EventHandlerFunc, SupportsEventHandlers
+    from streamdeck.types import ActionUUIDStr, EventNameStr
+
+
+class HandlersRegistry:
+    """Manages the registration and retrieval of actions and their event handlers."""
+    _plugin_actions: list[SupportsEventHandlers]
+    """List of registered actions."""
+
+    def __init__(self) -> None:
+        """Initialize an HandlersRegistry instance."""
+        self._plugin_actions = []
+
+    def register(self, action: SupportsEventHandlers) -> None:
+        """Register an action with the registry.
+
+        Args:
+            action (Action): The action to register.
+        """
+        self._plugin_actions.append(action)
+
+    def get_event_handlers(self, event_name: EventNameStr, event_action_uuid: ActionUUIDStr | None = None) -> Generator[EventHandlerFunc, None, None]:
+        """Get all event handlers for a specific event from all registered actions.
+
+        Args:
+            event_name (EventName): The name of the event to retrieve handlers for.
+            event_action_uuid (str | None): The action UUID to get handlers for.
+                If None (i.e., the event is not action-specific), get all handlers for the event.
+
+        Yields:
+            EventHandlerFunc: The event handler functions for the specified event.
+        """
+        for action in self._plugin_actions:
+            # If the event is action-specific (i.e is not a GlobalAction and has a UUID attribute),
+            # only get handlers for that action, as we don't want to trigger
+            # and pass this event to handlers for other actions.
+            if event_action_uuid is not None and (isinstance(action, Action) and action.uuid != event_action_uuid):
+                continue
+
+            yield from action.get_event_handlers(event_name)

streamdeck/manager.py

@@ -6,13 +6,14 @@
 
 from pydantic import ValidationError
 
-from streamdeck.actions import Action, ActionBase, HandlersRegistry
 from streamdeck.command_sender import StreamDeckCommandSender
+from streamdeck.event_handlers.actions import Action, ActionBase
 from streamdeck.event_handlers.protocol import (
     SupportsEventHandlers,
     is_bindable_handler,
     is_not_bindable_handler,
 )
+from streamdeck.event_handlers.registry import HandlersRegistry
 from streamdeck.event_listener import EventListener, EventListenerManager
 from streamdeck.models.events.adapter import EventAdapter
 from streamdeck.models.events.common import ContextualEventMixin

tests/actions/test_action_event_handler_filtering.py

@@ -4,7 +4,8 @@
 from unittest.mock import create_autospec
 
 import pytest
-from streamdeck.actions import Action, GlobalAction, HandlersRegistry
+from streamdeck.event_handlers.actions import Action, GlobalAction
+from streamdeck.event_handlers.registry import HandlersRegistry
 from streamdeck.models.events.common import ContextualEventMixin
 
 from tests.test_utils.fake_event_factories import (

tests/actions/test_action_registry.py

@@ -3,7 +3,8 @@
 from typing import TYPE_CHECKING
 
 import pytest
-from streamdeck.actions import Action, HandlersRegistry
+from streamdeck.event_handlers.actions import Action
+from streamdeck.event_handlers.registry import HandlersRegistry
 
 from tests.test_utils.fake_event_factories import (
     DialDownEventFactory,

tests/actions/test_actions.py

@@ -3,7 +3,7 @@
 from typing import TYPE_CHECKING, Any, cast
 
 import pytest
-from streamdeck.actions import Action, ActionBase, GlobalAction
+from streamdeck.event_handlers.actions import Action, ActionBase, GlobalAction
 from streamdeck.models.events import DEFAULT_EVENT_NAMES
 
 

tests/data/test_action1.py

@@ -1,5 +1,5 @@
-from streamdeck.actions import Action
 from streamdeck.command_sender import StreamDeckCommandSender
+from streamdeck.event_handlers.actions import Action
 from streamdeck.models.events import KeyDown, WillAppear
 
 

tests/data/test_action2.py

@@ -1,4 +1,4 @@
-from streamdeck.actions import Action, GlobalAction
+from streamdeck.event_handlers.actions import Action, GlobalAction
 from streamdeck.models.events import ApplicationDidLaunch
 
 

tests/plugin_manager/test_command_sender_binding.py

@@ -5,7 +5,7 @@
 from unittest.mock import Mock, create_autospec
 
 import pytest
-from streamdeck.actions import Action
+from streamdeck.event_handlers.actions import Action
 
 
 if TYPE_CHECKING: