Remove generic alias type alias from EventBase annotations

strohganoff · strohganoff · commit 8efe19da5457 · 2025-04-21T17:34:19.000-06:00
diff --git a/streamdeck/actions.py b/streamdeck/actions.py
@@ -49,7 +49,7 @@ def _wrapper(func: EventHandlerFunc[TEvent_contra]) -> EventHandlerFunc[TEvent_c
 
         return _wrapper
 
-    def get_event_handlers(self, event_name: EventNameStr, /) -> Generator[EventHandlerFunc[EventBase[LiteralStrGenericAlias]], None, None]:
+    def get_event_handlers(self, event_name: EventNameStr, /) -> Generator[EventHandlerFunc[EventBase], None, None]:
         """Get all event handlers for a specific event.
 
         Args:
@@ -66,14 +66,15 @@ def get_event_handlers(self, event_name: EventNameStr, /) -> Generator[EventHand
 
         yield from self._events[event_name]
 
-    def get_registered_event_names(self) -> list[str]:
+    def get_registered_event_names(self) -> list[EventNameStr]:
         """Get all event names for which event handlers are registered.
 
         Returns:
             list[str]: The list of event names for which event handlers are registered.
         """
         return list(self._events.keys())
 
+
 class GlobalAction(ActionBase):
     """Represents an action that is performed at the plugin level, meaning it isn't associated with a specific device or action."""
 
@@ -111,7 +112,7 @@ def register(self, action: ActionBase) -> None:
         """
         self._plugin_actions.append(action)
 
-    def get_action_handlers(self, event_name: EventNameStr, event_action_uuid: str | None = None) -> Generator[EventHandlerFunc[EventBase[LiteralStrGenericAlias]], None, None]:
+    def get_action_handlers(self, event_name: EventNameStr, event_action_uuid: str | None = None) -> Generator[EventHandlerFunc[EventBase], None, None]:
         """Get all event handlers for a specific event from all registered actions.
 
         Args:
diff --git a/streamdeck/event_listener.py b/streamdeck/event_listener.py
@@ -14,7 +14,6 @@
     from typing_extensions import TypeIs
 
     from streamdeck.models.events import EventBase
-    from streamdeck.models.events.base import LiteralStrGenericAlias
 
 
 
@@ -120,7 +119,7 @@ class EventListener(ABC):
     Event listeners are classes that listen for events and simply yield them as they come.
     The EventListenerManager will handle the threading and pushing the events yielded into a shared queue.
     """
-    event_models: ClassVar[list[type[EventBase[LiteralStrGenericAlias]]]]
+    event_models: ClassVar[list[type[EventBase]]]
     """A list of event models that the listener can yield. Read in by the PluginManager to model the incoming event data off of.
 
     The plugin-developer must define this list in their subclass.
diff --git a/streamdeck/manager.py b/streamdeck/manager.py
@@ -26,7 +26,6 @@
     from typing import Any, Literal
 
     from streamdeck.models.events import EventBase
-    from streamdeck.models.events.base import LiteralStrGenericAlias
 
 
 # TODO: Fix this up to push to a log in the apropos directory and filename.
@@ -121,7 +120,7 @@ def _inject_command_sender(self, handler: EventHandlerFunc[TEvent_contra], comma
 
         return handler
 
-    def _stream_event_data(self) -> Generator[EventBase[LiteralStrGenericAlias], None, None]:
+    def _stream_event_data(self) -> Generator[EventBase, None, None]:
         """Stream event data from the event listeners.
 
         Validate and model the incoming event data before yielding it.
@@ -131,7 +130,7 @@ def _stream_event_data(self) -> Generator[EventBase[LiteralStrGenericAlias], Non
         """
         for message in self._event_listener_manager.event_stream():
             try:
-                data: EventBase[LiteralStrGenericAlias] = self._event_adapter.validate_json(message)
+                data: EventBase = self._event_adapter.validate_json(message)
             except ValidationError:
                 logger.exception("Error modeling event data.")
                 continue
diff --git a/streamdeck/models/events/__init__.py b/streamdeck/models/events/__init__.py
@@ -31,10 +31,8 @@
 if TYPE_CHECKING:
     from typing import Final
 
-    from streamdeck.models.events.base import LiteralStrGenericAlias
 
-
-DEFAULT_EVENT_MODELS: Final[list[type[EventBase[LiteralStrGenericAlias]]]] = [
+DEFAULT_EVENT_MODELS: Final[list[type[EventBase]]] = [
     ApplicationDidLaunch,
     ApplicationDidTerminate,
     DeviceDidConnect,
diff --git a/streamdeck/models/events/adapter.py b/streamdeck/models/events/adapter.py
@@ -8,14 +8,14 @@
 
 
 if TYPE_CHECKING:
-    from streamdeck.models.events.base import EventBase, LiteralStrGenericAlias
+    from streamdeck.models.events.base import EventBase
 
 
 class EventAdapter:
     """TypeAdapter-encompassing class for handling and extending available event models."""
     def __init__(self) -> None:
-        self._models: list[type[EventBase[LiteralStrGenericAlias]]] = []
-        self._type_adapter: TypeAdapter[EventBase[LiteralStrGenericAlias]] | None = None
+        self._models: list[type[EventBase]] = []
+        self._type_adapter: TypeAdapter[EventBase] | None = None
 
         self._event_names: set[str] = set()
         """A set of all event names that have been registered with the adapter.
@@ -25,7 +25,7 @@ def __init__(self) -> None:
         for model in DEFAULT_EVENT_MODELS:
             self.add_model(model)
 
-    def add_model(self, model: type[EventBase[LiteralStrGenericAlias]]) -> None:
+    def add_model(self, model: type[EventBase]) -> None:
         """Add a model to the adapter, and add the event name of the model to the set of registered event names."""
         self._models.append(model)
         # Models can have multiple event names defined in the Literal args of the event field,
@@ -37,7 +37,7 @@ def event_name_exists(self, event_name: str) -> bool:
         return event_name in self._event_names
 
     @property
-    def type_adapter(self) -> TypeAdapter[EventBase[LiteralStrGenericAlias]]:
+    def type_adapter(self) -> TypeAdapter[EventBase]:
         """Get the TypeAdapter instance for the event models."""
         if self._type_adapter is None:
             self._type_adapter = TypeAdapter(
@@ -49,7 +49,7 @@ def type_adapter(self) -> TypeAdapter[EventBase[LiteralStrGenericAlias]]:
 
         return self._type_adapter
 
-    def validate_json(self, data: str | bytes) -> EventBase[LiteralStrGenericAlias]:
+    def validate_json(self, data: str | bytes) -> EventBase:
         """Validate a JSON string or bytes object as an event model."""
         return self.type_adapter.validate_json(data)
 
diff --git a/streamdeck/models/events/application.py b/streamdeck/models/events/application.py
@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-from typing import Literal
-
 from streamdeck.models.events.base import ConfiguredBaseModel, EventBase
 
 
@@ -11,13 +9,13 @@ class ApplicationPayload(ConfiguredBaseModel):
     """Name of the application that triggered the event."""
 
 
-class ApplicationDidLaunch(EventBase[Literal["applicationDidLaunch"]]):
+class ApplicationDidLaunch(EventBase["applicationDidLaunch"]):
     """Occurs when a monitored application is launched."""
     payload: ApplicationPayload
     """Payload containing the name of the application that triggered the event."""
 
 
-class ApplicationDidTerminate(EventBase[Literal["applicationDidTerminate"]]):
+class ApplicationDidTerminate(EventBase["applicationDidTerminate"]):
     """Occurs when a monitored application terminates."""
     payload: ApplicationPayload
     """Payload containing the name of the application that triggered the event."""
diff --git a/streamdeck/models/events/deep_link.py b/streamdeck/models/events/deep_link.py
@@ -1,5 +1,3 @@
-from typing import Literal
-
 from streamdeck.models.events.base import ConfiguredBaseModel, EventBase
 
 
@@ -9,7 +7,7 @@ class DeepLinkPayload(ConfiguredBaseModel):
     """The deep-link URL, with the prefix omitted."""
 
 
-class DidReceiveDeepLink(EventBase[Literal["didReceiveDeepLink"]]):
+class DidReceiveDeepLink(EventBase["didReceiveDeepLink"]):
     """Occurs when Stream Deck receives a deep-link message intended for the plugin.
 
     The message is re-routed to the plugin, and provided as part of the payload.
diff --git a/streamdeck/models/events/devices.py b/streamdeck/models/events/devices.py
@@ -78,11 +78,11 @@ def __repr__(self) -> str:
         return f"DeviceInfo(name={self.name}, type={self.type}, size={self.size})"
 
 
-class DeviceDidConnect(EventBase[Literal["deviceDidConnect"]], DeviceSpecificEventMixin):
+class DeviceDidConnect(EventBase["deviceDidConnect"], DeviceSpecificEventMixin):
     """Occurs when a Stream Deck device is connected."""
     device_info: Annotated[DeviceInfo, Field(alias="deviceInfo")]
     """Information about the newly connected device."""
 
 
-class DeviceDidDisconnect(EventBase[Literal["deviceDidDisconnect"]], DeviceSpecificEventMixin):
+class DeviceDidDisconnect(EventBase["deviceDidDisconnect"], DeviceSpecificEventMixin):
     """Occurs when a Stream Deck device is disconnected."""
diff --git a/streamdeck/models/events/dials.py b/streamdeck/models/events/dials.py
@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-from typing import Literal
-
 from streamdeck.models.events.base import EventBase
 from streamdeck.models.events.common import (
     BasePayload,
@@ -28,19 +26,19 @@ class DialRotatePayload(EncoderPayload):
 
 ## Event models for DialDown, DialRotate, and DialUp events
 
-class DialDown(EventBase[Literal["dialDown"]], ContextualEventMixin, DeviceSpecificEventMixin):
+class DialDown(EventBase["dialDown"], ContextualEventMixin, DeviceSpecificEventMixin):
     """Occurs when the user presses a dial (Stream Deck +)."""
     payload: EncoderPayload
     """Contextualized information for this event."""
 
 
-class DialRotate(EventBase[Literal["dialRotate"]], ContextualEventMixin, DeviceSpecificEventMixin):
+class DialRotate(EventBase["dialRotate"], ContextualEventMixin, DeviceSpecificEventMixin):
     """Occurs when the user rotates a dial (Stream Deck +)."""
     payload: DialRotatePayload
     """Contextualized information for this event."""
 
 
-class DialUp(EventBase[Literal["dialUp"]], ContextualEventMixin, DeviceSpecificEventMixin):
+class DialUp(EventBase["dialUp"], ContextualEventMixin, DeviceSpecificEventMixin):
     """Occurs when the user releases a pressed dial (Stream Deck +)."""
     payload: EncoderPayload
     """Contextualized information for this event."""
diff --git a/streamdeck/models/events/keys.py b/streamdeck/models/events/keys.py
@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Annotated, Literal
+from typing import Annotated
 
 from pydantic import Field
 
@@ -48,13 +48,13 @@ class MultiActionKeyGesturePayload(
 
 ## Event models for KeyDown and KeyUp events
 
-class KeyDown(EventBase[Literal["keyDown"]], ContextualEventMixin, DeviceSpecificEventMixin):
+class KeyDown(EventBase["keyDown"], ContextualEventMixin, DeviceSpecificEventMixin):
     """Occurs when the user presses a action down."""
     payload: CardinalityDiscriminated[SingleActionKeyGesturePayload, MultiActionKeyGesturePayload]
     """Contextualized information for this event."""
 
 
-class KeyUp(EventBase[Literal["keyUp"]], ContextualEventMixin, DeviceSpecificEventMixin):
+class KeyUp(EventBase["keyUp"], ContextualEventMixin, DeviceSpecificEventMixin):
     """Occurs when the user releases a pressed action."""
     payload: CardinalityDiscriminated[SingleActionKeyGesturePayload, MultiActionKeyGesturePayload]
     """Contextualized information for this event."""
diff --git a/streamdeck/models/events/property_inspector.py b/streamdeck/models/events/property_inspector.py
@@ -1,31 +1,27 @@
 from __future__ import annotations
 
-from typing import Literal
-
-from streamdeck.models.events.base import (
-    EventBase,
-)
+from streamdeck.models.events.base import EventBase
 from streamdeck.models.events.common import (
     ContextualEventMixin,
     DeviceSpecificEventMixin,
     PluginDefinedData,
 )
 
 
-class DidReceivePropertyInspectorMessage(EventBase[Literal["sendToPlugin"]], ContextualEventMixin):
+class DidReceivePropertyInspectorMessage(EventBase["sendToPlugin"], ContextualEventMixin):
     """Occurs when a message was received from the UI."""
     payload: PluginDefinedData
     """The data payload received from the UI."""
 
 
-class PropertyInspectorDidAppear(EventBase[Literal["propertyInspectorDidAppear"]], ContextualEventMixin, DeviceSpecificEventMixin):
+class PropertyInspectorDidAppear(EventBase["propertyInspectorDidAppear"], ContextualEventMixin, DeviceSpecificEventMixin):
     """Occurs when the property inspector associated with the action becomes visible.
 
     I.e. the user selected an action in the Stream Deck application.
     """
 
 
-class PropertyInspectorDidDisappear(EventBase[Literal["propertyInspectorDidDisappear"]], ContextualEventMixin, DeviceSpecificEventMixin):
+class PropertyInspectorDidDisappear(EventBase["propertyInspectorDidDisappear"], ContextualEventMixin, DeviceSpecificEventMixin):
     """Occurs when the property inspector associated with the action becomes invisible.
 
     I.e. the user unselected the action in the Stream Deck application.
diff --git a/streamdeck/models/events/settings.py b/streamdeck/models/events/settings.py
@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-from typing import Literal
-
 from streamdeck.models.events.base import ConfiguredBaseModel, EventBase
 from streamdeck.models.events.common import (
     BasePayload,
@@ -40,7 +38,7 @@ class MultiActionSettingsPayload(
     """
 
 
-class DidReceiveSettings(EventBase[Literal["didReceiveSettings"]], ContextualEventMixin, DeviceSpecificEventMixin):
+class DidReceiveSettings(EventBase["didReceiveSettings"], ContextualEventMixin, DeviceSpecificEventMixin):
     """Occurs when the settings associated with an action instance are requested, or when the the settings were updated by the property inspector."""
     payload: CardinalityDiscriminated[SingleActionSettingsPayload, MultiActionSettingsPayload]
     """Contextualized information for this event."""
@@ -54,7 +52,7 @@ class GlobalSettingsPayload(ConfiguredBaseModel):
     """The global settings received from the Stream Deck."""
 
 
-class DidReceiveGlobalSettings(EventBase[Literal["didReceiveGlobalSettings"]]):
+class DidReceiveGlobalSettings(EventBase["didReceiveGlobalSettings"]):
     """Occurs when the plugin receives the global settings from the Stream Deck."""
     payload: GlobalSettingsPayload
     """Additional information about the event that occurred."""
diff --git a/streamdeck/models/events/system.py b/streamdeck/models/events/system.py
@@ -1,9 +1,7 @@
 from __future__ import annotations
 
-from typing import Literal
-
 from streamdeck.models.events.base import EventBase
 
 
-class SystemDidWakeUp(EventBase[Literal["systemDidWakeUp"]]):
+class SystemDidWakeUp(EventBase["systemDidWakeUp"]):
     """Occurs when the computer wakes up."""
diff --git a/streamdeck/models/events/title_parameters.py b/streamdeck/models/events/title_parameters.py
@@ -47,7 +47,7 @@ class TitleParametersDidChangePayload(
     """Defines aesthetic properties that determine how the title should be rendered."""
 
 
-class TitleParametersDidChange(EventBase[Literal["titleParametersDidChange"]], DeviceSpecificEventMixin):
+class TitleParametersDidChange(EventBase["titleParametersDidChange"], DeviceSpecificEventMixin):
     """Occurs when the user updates an action's title settings in the Stream Deck application."""
     context: str
     """Identifies the instance of an action that caused the event, i.e. the specific key or dial."""
diff --git a/streamdeck/models/events/touch_tap.py b/streamdeck/models/events/touch_tap.py
@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Annotated, Literal
+from typing import Annotated
 
 from pydantic import Field
 
@@ -22,7 +22,7 @@ class TouchTapPayload(BasePayload[EncoderControllerType], CoordinatesPayloadMixi
     """Coordinates of where the touchscreen tap occurred, relative to the canvas of the action."""
 
 
-class TouchTap(EventBase[Literal["touchTap"]], ContextualEventMixin, DeviceSpecificEventMixin):
+class TouchTap(EventBase["touchTap"], ContextualEventMixin, DeviceSpecificEventMixin):
     """Occurs when the user taps the touchscreen (Stream Deck +)."""
     payload: TouchTapPayload
     """Contextualized information for this event."""
diff --git a/streamdeck/models/events/visibility.py b/streamdeck/models/events/visibility.py
@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-from typing import Literal
-
 from streamdeck.models.events.base import EventBase
 from streamdeck.models.events.common import (
     BasePayload,
@@ -35,7 +33,7 @@ class MultiActionVisibilityPayload(
 
 ## Event models for WillAppear and WillDisappear events
 
-class WillAppear(EventBase[Literal["willAppear"]], ContextualEventMixin, DeviceSpecificEventMixin):
+class WillAppear(EventBase["willAppear"], ContextualEventMixin, DeviceSpecificEventMixin):
     """Occurs when an action appears on the Stream Deck due to the user navigating to another page, profile, folder, etc.
 
     This also occurs during startup if the action is on the "front page".
@@ -44,7 +42,7 @@ class WillAppear(EventBase[Literal["willAppear"]], ContextualEventMixin, DeviceS
     payload: CardinalityDiscriminated[SingleActionVisibilityPayload, MultiActionVisibilityPayload]
 
 
-class WillDisappear(EventBase[Literal["willDisappear"]], ContextualEventMixin, DeviceSpecificEventMixin):
+class WillDisappear(EventBase["willDisappear"], ContextualEventMixin, DeviceSpecificEventMixin):
     """Occurs when an action disappears from the Stream Deck due to the user navigating to another page, profile, folder, etc.
 
     An action refers to all types of actions, e.g. keys, dials, touchscreens, pedals, etc.
diff --git a/tests/actions/test_action_event_handler_filtering.py b/tests/actions/test_action_event_handler_filtering.py
diff --git a/tests/actions/test_action_registry.py b/tests/actions/test_action_registry.py
diff --git a/tests/actions/test_actions.py b/tests/actions/test_actions.py
diff --git a/tests/event_listener/test_event_listener.py b/tests/event_listener/test_event_listener.py
diff --git a/tests/models/test_event_adapter.py b/tests/models/test_event_adapter.py
diff --git a/tests/plugin_manager/test_command_sender_binding.py b/tests/plugin_manager/test_command_sender_binding.py
diff --git a/tests/plugin_manager/test_plugin_manager.py b/tests/plugin_manager/test_plugin_manager.py
