Finish design of BasePayload model and mixin classes, including new mixin that provides the attribute

Author: strohganoff

streamdeck/models/events/common.py

@@ -28,6 +28,10 @@ class DeviceSpecificEventMixin:
 ## Payload models and metadata used by multiple event models.
 
 
+PluginDefinedData = dict[str, Any]
+"""Data of arbitrary structure that is defined in and relevant to the plugin."""
+
+
 EncoderControllerType = Literal["Encoder"]
 """The 'Encoder' controller type refers to a dial or touchscreen on a 'Stream Deck +' device."""
 KeypadControllerType = Literal["Keypad"]
@@ -38,8 +42,16 @@ class DeviceSpecificEventMixin:
 CT = TypeVar("CT", bound=ControllerType, default=ControllerType)
 
 
-PluginDefinedData = dict[str, Any]
-"""Data of arbitrary structure that is defined in and relevant to the plugin."""
+class BasePayload(ConfiguredBaseModel, Generic[CT], ABC):
+    """Base class for all complex payload models."""
+    controller: CT
+    """Defines the controller type the action is applicable to.
+
+    'Keypad' refers to a standard action on a Stream Deck device, e.g. buttons or a pedal.
+    'Encoder' refers to a dial / touchscreen on a 'Stream Deck +' device.
+    """
+    settings: PluginDefinedData
+    """Settings associated with the action instance."""
 
 
 class CoordinatesDict(TypedDict):
@@ -81,21 +93,8 @@ def coordinates(self) -> Coordinates:
         return Coordinates(**self.coordinates_obj)
 
 
-class BasePayload(ConfiguredBaseModel, Generic[CT], ABC):
-    """Base class for all complex payload models."""
-    controller: CT
-    """Defines the controller type the action is applicable to.
-
-    'Keypad' refers to a standard action on a Stream Deck device, e.g. buttons or a pedal.
-    'Encoder' refers to a dial / touchscreen on a 'Stream Deck +' device.
-    """
-    settings: PluginDefinedData
-    """Settings associated with the action instance."""
-
-
-class BaseActionPayload(BasePayload[CT], ABC):
-    """Base class for payloads of action events."""
-
+class StatefulActionPayloadMixin:
+    """Mixin class for payload models that have an optional state field."""
     state: Optional[int] = None  # noqa: UP007
     """Current state of the action.
 

streamdeck/models/events/keys.py

@@ -6,14 +6,15 @@
 
 from streamdeck.models.events.base import EventBase
 from streamdeck.models.events.common import (
-    BaseActionPayload,
+    BasePayload,
     CardinalityDiscriminated,
     ContextualEventMixin,
     CoordinatesPayloadMixin,
     DeviceSpecificEventMixin,
     KeypadControllerType,
     MultiActionPayloadMixin,
     SingleActionPayloadMixin,
+    StatefulActionPayloadMixin,
 )
 
 
@@ -23,11 +24,20 @@
 OptionalKeyControllerTypeField = Annotated[KeypadControllerType, Field(default=None)]
 
 
-class SingleActionKeyGesturePayload(BaseActionPayload[OptionalKeyControllerTypeField], SingleActionPayloadMixin, CoordinatesPayloadMixin):
+class SingleActionKeyGesturePayload(
+    BasePayload[OptionalKeyControllerTypeField],
+    SingleActionPayloadMixin,
+    StatefulActionPayloadMixin,
+    CoordinatesPayloadMixin,
+):
     """Contextualized information for a KeyDown or KeyUp event that is not part of a multi-action."""
 
 
-class MultiActionKeyGesturePayload(BaseActionPayload[OptionalKeyControllerTypeField], MultiActionPayloadMixin):
+class MultiActionKeyGesturePayload(
+    BasePayload[OptionalKeyControllerTypeField],
+    MultiActionPayloadMixin,
+    StatefulActionPayloadMixin,
+):
     """Contextualized information for a KeyDown or KeyUp event that is part of a multi-action."""
     user_desired_state: Annotated[int, Field(alias="userDesiredState")]
     """Desired state as specified by the user.

streamdeck/models/events/settings.py

@@ -4,7 +4,7 @@
 
 from streamdeck.models.events.base import ConfiguredBaseModel, EventBase
 from streamdeck.models.events.common import (
-    BaseActionPayload,
+    BasePayload,
     CardinalityDiscriminated,
     ContextualEventMixin,
     CoordinatesPayloadMixin,
@@ -13,16 +13,27 @@
     MultiActionPayloadMixin,
     PluginDefinedData,
     SingleActionPayloadMixin,
+    StatefulActionPayloadMixin,
 )
 
 
 ## Models for didReceiveSettings event and its specific payloads.
 
-class SingleActionSettingsPayload(BaseActionPayload, SingleActionPayloadMixin, CoordinatesPayloadMixin):
+
+class SingleActionSettingsPayload(
+    BasePayload,
+    SingleActionPayloadMixin,
+    StatefulActionPayloadMixin,
+    CoordinatesPayloadMixin,
+):
     """Contextualized information for a didReceiveSettings events that are not part of a multi-action."""
 
 
-class MultiActionSettingsPayload(BaseActionPayload[KeypadControllerType], MultiActionPayloadMixin):
+class MultiActionSettingsPayload(
+    BasePayload[KeypadControllerType],
+    MultiActionPayloadMixin,
+    StatefulActionPayloadMixin,
+):
     """Contextualized information for a didReceiveSettings events that are part of a multi-action.
 
     NOTE: Action instances that are part of a multi-action are only applicable to the 'Keypad' controller type.

streamdeck/models/events/title_parameters.py

@@ -6,9 +6,10 @@
 
 from streamdeck.models.events.base import ConfiguredBaseModel, EventBase
 from streamdeck.models.events.common import (
-    BaseActionPayload,
+    BasePayload,
     CoordinatesPayloadMixin,
     DeviceSpecificEventMixin,
+    StatefulActionPayloadMixin,
 )
 
 
@@ -34,7 +35,11 @@ class TitleParameters(ConfiguredBaseModel):
     """Color of the title, represented as a hexadecimal value."""
 
 
-class TitleParametersDidChangePayload(BaseActionPayload, CoordinatesPayloadMixin):
+class TitleParametersDidChangePayload(
+    BasePayload,
+    CoordinatesPayloadMixin,
+    StatefulActionPayloadMixin,
+):
     """Contextualized information for this event."""
     title: str
     """Title of the action, as specified by the user or dynamically by the plugin."""

streamdeck/models/events/visibility.py

@@ -4,22 +4,32 @@
 
 from streamdeck.models.events.base import EventBase
 from streamdeck.models.events.common import (
-    BaseActionPayload,
+    BasePayload,
     CardinalityDiscriminated,
     ContextualEventMixin,
     CoordinatesPayloadMixin,
     DeviceSpecificEventMixin,
     KeypadControllerType,
     MultiActionPayloadMixin,
     SingleActionPayloadMixin,
+    StatefulActionPayloadMixin,
 )
 
 
-class SingleActionVisibilityPayload(BaseActionPayload, SingleActionPayloadMixin, CoordinatesPayloadMixin):
+class SingleActionVisibilityPayload(
+    BasePayload,
+    SingleActionPayloadMixin,
+    StatefulActionPayloadMixin,
+    CoordinatesPayloadMixin,
+):
     """Contextualized information for willAppear and willDisappear events that is not part of a multi-action."""
 
 
-class MultiActionVisibilityPayload(BaseActionPayload[KeypadControllerType], MultiActionPayloadMixin):
+class MultiActionVisibilityPayload(
+    BasePayload[KeypadControllerType],
+    MultiActionPayloadMixin,
+    StatefulActionPayloadMixin,
+):
     """Contextualized information for willAppear and willDisappear events that is part of a multi-action."""