♻️ WalkableComponent -> WalkableComponentMixin

Author: Paillat-dev

discord/components/__init__.py

@@ -26,7 +26,7 @@
 from .action_row import ActionRow
 from .button import Button
 from .channel_select_menu import ChannelSelect
-from .component import Component, ModalComponentMixin, StateComponentMixin, WalkableComponent
+from .component import Component, ModalComponentMixin, StateComponentMixin, WalkableComponentMixin
 from .components_holder import ComponentsHolder
 from .container import Container
 from .default_select_option import DefaultSelectOption
@@ -80,7 +80,7 @@
 __all__ = (
     "Component",
     "StateComponentMixin",
-    "WalkableComponent",
+    "WalkableComponentMixin",
     "ModalComponentMixin",
     "ComponentsHolder",
     "ActionRow",

discord/components/action_row.py

@@ -25,13 +25,14 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, ClassVar, Literal, TypeAlias, cast
+from typing import TYPE_CHECKING, ClassVar, Iterator, Literal, TypeAlias, cast
 
 from typing_extensions import override
 
 from ..enums import ComponentType
 from ..types.component_types import ActionRow as ActionRowPayload
-from .component import WalkableComponent
+from .component import Component, WalkableComponentMixin
+from .types import C
 
 if TYPE_CHECKING:
     from typing_extensions import Self
@@ -49,7 +50,7 @@
 )
 
 
-class ActionRow(WalkableComponent["ActionRowPayload", "AllowedActionRowComponents"]):
+class ActionRow(Component["ActionRowPayload"], WalkableComponentMixin["AllowedActionRowComponents"]):
     """Represents a Discord Bot UI Kit Action Row.
 
     This is a component that holds up to 5 children components in a row.
@@ -90,6 +91,10 @@ def __init__(self, *components: AllowedActionRowComponents, id: int | None = Non
         self.components: list[AllowedActionRowComponents] = list(components)
         super().__init__(id=id)
 
+    @override
+    def walk_components(self) -> Iterator[AllowedActionRowComponents]:
+        yield from self.components
+
     @classmethod
     @override
     def from_payload(cls, payload: ActionRowPayload) -> Self:

discord/components/component.py

@@ -109,43 +109,53 @@ def from_payload(cls, payload: P, state: ConnectionState | None = None) -> Self:
         ...
 
 
-class WalkableComponent(Component[P], ABC, Generic[P, C]):
+class WalkableComponentMixin(ABC, Generic[C]):
     """A component that can be walked through.
 
     This is an abstract class and cannot be instantiated directly.
     It is used to represent components that can be walked through, such as :class:`ActionRow`, :class:`Container` and :class:`Section`.
     """
 
-    __slots__: tuple[str, ...] = ("components",)  # pyright: ignore[reportIncompatibleUnannotatedOverride]
-    components: list[C]
-
-    def walk_components(self) -> Iterator[C]:
-        """Walks through the components in this component."""
-        for component in self.components:
-            if isinstance(component, WalkableComponent):
-                yield from component.walk_components()
-            else:
-                yield component
+    @abstractmethod
+    def walk_components(self) -> Iterator[C]: ...
 
     __iter__: Callable[[Self], Iterator[C]] = walk_components
 
-    @override
+    @abstractmethod
+    def is_v2(self) -> bool: ...
+
+    @abstractmethod
+    def is_dispatchable(self) -> bool: ...
+
     def any_is_v2(self) -> bool:
         """Whether this component or any of its children were introduced in Components V2."""
         return self.is_v2() or any(c.any_is_v2() for c in self.walk_components())
 
-    @override
     def any_is_dispatchable(self) -> bool:
         """Whether this component or any of its children can be interacted with and lead to a :class:`Interaction`"""
         return self.is_dispatchable() or any(c.any_is_dispatchable() for c in self.walk_components())
 
     def get_by_id(self, component_id: str | int) -> C | None:
+        """Gets a component by its ID or custom ID.
+
+        Parameters
+        ----------
+        component_id:
+            The ID (int) or custom ID (str) of the component to get.
+
+        Returns
+        -------
+        :class:`AllowedComponents` | :class:`None`
+            The children component with the given ID or custom ID, or :data:`None` if not found.
+        """
         for component in self.walk_components():
             if isinstance(component_id, str) and getattr(component, "custom_id", None) == component_id:
                 return component
             elif isinstance(component_id, int) and getattr(component, "id", None) == component_id:
                 return component
 
+        return None
+
 
 class ModalComponentMixin(ABC, Generic[P]):
     """A component that can be used in a modal.

discord/components/container.py

@@ -24,14 +24,15 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, ClassVar, Literal, TypeAlias, cast
+from typing import TYPE_CHECKING, ClassVar, Iterator, Literal, TypeAlias, cast
 
 from typing_extensions import override
 
 from ..colour import Colour
 from ..enums import ComponentType
 from ..types.component_types import ContainerComponent as ContainerComponentPayload
-from .component import WalkableComponent
+from .component import Component, WalkableComponentMixin
+from .types import C
 
 if TYPE_CHECKING:
     from typing_extensions import Self
@@ -48,7 +49,7 @@
 AllowedContainerComponents: TypeAlias = "ActionRow | TextDisplay | Section | MediaGallery | Separator | FileComponent"
 
 
-class Container(WalkableComponent["ContainerComponentPayload", "AllowedContainerComponents"]):
+class Container(Component["ContainerComponentPayload"], WalkableComponentMixin["AllowedContainerComponents"]):
     """Represents a Container from Components V2.
 
     This is a component that contains different :class:`Component` objects.
@@ -114,6 +115,10 @@ def __init__(
         self.components: list[AllowedContainerComponents] = list(components)
         super().__init__(id=id)
 
+    @override
+    def walk_components(self) -> Iterator[AllowedContainerComponents]:
+        yield from self.components
+
     @override
     def to_dict(self) -> ContainerComponentPayload:
         payload: ContainerComponentPayload = {

discord/components/label.py

@@ -32,7 +32,7 @@
 
 from ..enums import ComponentType
 from ..types.component_types import LabelComponent as LabelComponentPayload
-from .component import ModalComponentMixin, WalkableComponent
+from .component import Component, ModalComponentMixin, WalkableComponentMixin
 
 if TYPE_CHECKING:
     from typing_extensions import Self
@@ -48,7 +48,9 @@
 
 
 class Label(
-    WalkableComponent["LabelComponentPayload", "AllowedLabelComponents"], ModalComponentMixin["LabelComponentPayload"]
+    Component["LabelComponentPayload"],
+    WalkableComponentMixin["AllowedLabelComponents"],
+    ModalComponentMixin["LabelComponentPayload"],
 ):
     """Represents a Label component.
 
@@ -97,7 +99,6 @@ def __init__(
         description: str | None = None,
         id: int | None = None,
     ):
-        self.components: list = []  # pyright: ignore[reportMissingTypeArgument]
         self.label: str = label
         self.description: str | None = description
         self.component: AllowedLabelComponents = component

discord/components/partial_components.py

@@ -78,7 +78,7 @@ def from_payload(cls, payload: P) -> Self: ...
 C = TypeVar("C", bound="AnyPartialComponent", covariant=True)
 
 
-class PartialWalkableComponent(PartialComponent[T, P], ABC, Generic[T, P, C]):
+class PartialWalkableComponentMixin(ABC, Generic[C]):
     @abstractmethod
     def walk_components(self) -> Iterator[C]: ...
 
@@ -313,7 +313,8 @@ def from_payload(cls, payload: PartialTextInputPayload) -> Self:
 
 @dataclass
 class PartialLabel(
-    PartialWalkableComponent[Literal[ComponentType.label], PartialLabelPayload, AllowedPartialLabelComponents],
+    PartialComponent[Literal[ComponentType.label], PartialLabelPayload],
+    PartialWalkableComponentMixin[AllowedPartialLabelComponents],
     Generic[L_c],
 ):
     """Represents a :class:`Label` component as returned by Discord during a :class:`Interaction` of type :data:`InteractionType.modal_submit`.
@@ -347,7 +348,7 @@ def from_payload(cls, payload: PartialLabelPayload) -> Self:
     @override
     def walk_components(self) -> Iterator[AllowedPartialLabelComponents]:
         yield self.component
-        if isinstance(self.component, PartialWalkableComponent):
+        if isinstance(self.component, PartialWalkableComponentMixin):
             yield from self.component.walk_components()  # pyright: ignore[reportReturnType]
 
 

discord/components/section.py

@@ -32,7 +32,7 @@
 
 from ..enums import ComponentType
 from ..types.component_types import SectionComponent as SectionComponentPayload
-from .component import WalkableComponent
+from .component import Component, WalkableComponentMixin
 
 if TYPE_CHECKING:
     from typing_extensions import Self
@@ -48,7 +48,8 @@
 
 
 class Section(
-    WalkableComponent["SectionComponentPayload", "AllowedSectionComponents | AllowedSectionAccessoryComponents"],
+    Component["SectionComponentPayload"],
+    WalkableComponentMixin["AllowedSectionComponents | AllowedSectionAccessoryComponents"],
 ):
     """Represents a Section from Components V2.
 
@@ -128,6 +129,6 @@ def to_dict(self) -> SectionComponentPayload:
 
     @override
     def walk_components(self) -> Iterator[AllowedSectionComponents | AllowedSectionAccessoryComponents]:
-        yield from super().walk_components()
+        yield from self.components
         if self.accessory:
             yield self.accessory