feat: redo CV2 and New Modal implementation (#2904)

Signed-off-by: UK <[email protected]>
Signed-off-by: Nelo <[email protected]>
Signed-off-by: Paillat <[email protected]>
Signed-off-by: Lala Sabathil <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Lala Sabathil <[email protected]>
Co-authored-by: Timo <[email protected]>
Co-authored-by: Paillat <[email protected]>

Author: 5 people

CHANGELOG.md

@@ -30,6 +30,10 @@ These changes are available on the `master` branch, but have not yet been releas
   - Adds pre-typed and pre-constructed with select_type `ui.Select` aliases for the
     different select types: `ui.StringSelect`, `ui.UserSelect`, `ui.RoleSelect`,
     `ui.MentionableSelect`, and `ui.ChannelSelect`.
+- Added `store` parameter to `View` and `Modal` classes.
+  ([#2904](https://github.com/Pycord-Development/pycord/pull/2904/))
+- Added `Webhook.parent` and `Webhook.from_interaction`
+  ([#2904](https://github.com/Pycord-Development/pycord/pull/2904/))
 - Added the ability to use functions with any number of optional arguments and functions
   returning an awaitable as `Option.autocomplete`.
   ([#2914](https://github.com/Pycord-Development/pycord/pull/2914))
@@ -41,6 +45,23 @@ These changes are available on the `master` branch, but have not yet been releas
 
 ### Changed
 
+- Overhauled support for Components V2 and new Modal components
+  ([#2904](https://github.com/Pycord-Development/pycord/pull/2904/))
+  - Revert `discord.ui.View` and `discord.ui.Modal` to 2.6.1 behavior; not compatible
+    with new features.
+  - Implemented `discord.ui.DesignerView` and `discord.ui.DesignerModal` to support new
+    components.
+  - `DesignerView` and `Container` do not support `Button` and `Select` directly; use
+    `discord.ui.ActionRow` instead.
+  - `DesignerModal` does not support `InputText` and `Select` directly; use
+    `discord.ui.Label` instead.
+  - Removed `InputText.description`, `Select.label` and `Select.description`; these are
+    now attributes of `Label`.
+  - `discord.ui.Item` is now a base class for `ViewItem` and `ModalItem`; all items
+    inherit from these.
+  - All view and modal classes now inherit from a base `ItemInterface` class, split into
+    `BaseView` and `BaseModal`
+
 ### Fixed
 
 - Manage silence for new SSRC with existing user_id.

discord/abc.py

@@ -95,7 +95,7 @@
     from .types.channel import GuildChannel as GuildChannelPayload
     from .types.channel import OverwriteType
     from .types.channel import PermissionOverwrite as PermissionOverwritePayload
-    from .ui.view import View
+    from .ui.view import BaseView
     from .user import ClientUser
 
     PartialMessageableChannel = Union[
@@ -1355,7 +1355,7 @@ async def send(
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
         mention_author: bool = ...,
-        view: View = ...,
+        view: BaseView = ...,
         poll: Poll = ...,
         suppress: bool = ...,
         silent: bool = ...,
@@ -1376,7 +1376,7 @@ async def send(
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
         mention_author: bool = ...,
-        view: View = ...,
+        view: BaseView = ...,
         poll: Poll = ...,
         suppress: bool = ...,
         silent: bool = ...,
@@ -1397,7 +1397,7 @@ async def send(
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
         mention_author: bool = ...,
-        view: View = ...,
+        view: BaseView = ...,
         poll: Poll = ...,
         suppress: bool = ...,
         silent: bool = ...,
@@ -1418,7 +1418,7 @@ async def send(
         allowed_mentions: AllowedMentions = ...,
         reference: Message | MessageReference | PartialMessage = ...,
         mention_author: bool = ...,
-        view: View = ...,
+        view: BaseView = ...,
         poll: Poll = ...,
         suppress: bool = ...,
         silent: bool = ...,
@@ -1509,7 +1509,7 @@ async def send(
             If set, overrides the :attr:`~discord.AllowedMentions.replied_user` attribute of ``allowed_mentions``.
 
             .. versionadded:: 1.6
-        view: :class:`discord.ui.View`
+        view: :class:`discord.ui.BaseView`
             A Discord UI View to add to the message.
         embeds: List[:class:`~discord.Embed`]
             A list of embeds to upload. Must be a maximum of 10.
@@ -1611,7 +1611,7 @@ async def send(
         if view:
             if not hasattr(view, "__discord_ui_view__"):
                 raise InvalidArgument(
-                    f"view parameter must be View not {view.__class__!r}"
+                    f"view parameter must be BaseView not {view.__class__!r}"
                 )
 
             components = view.to_components()

discord/channel.py

@@ -107,7 +107,7 @@
     from .types.channel import VoiceChannelEffectSendEvent as VoiceChannelEffectSend
     from .types.snowflake import SnowflakeList
     from .types.threads import ThreadArchiveDuration
-    from .ui.view import View
+    from .ui.view import BaseView
     from .user import BaseUser, ClientUser, User
     from .webhook import Webhook
 
@@ -1217,7 +1217,7 @@ async def create_thread(
         delete_message_after: float | None = None,
         nonce: int | str | None = None,
         allowed_mentions: AllowedMentions | None = None,
-        view: View | None = None,
+        view: BaseView | None = None,
         applied_tags: list[ForumTag] | None = None,
         suppress: bool = False,
         silent: bool = False,
@@ -1262,7 +1262,7 @@ async def create_thread(
             to the object, otherwise it uses the attributes set in :attr:`~discord.Client.allowed_mentions`.
             If no object is passed at all then the defaults given by :attr:`~discord.Client.allowed_mentions`
             are used instead.
-        view: :class:`discord.ui.View`
+        view: :class:`discord.ui.BaseView`
             A Discord UI View to add to the message.
         applied_tags: List[:class:`discord.ForumTag`]
             A list of tags to apply to the new thread.
@@ -1328,7 +1328,7 @@ async def create_thread(
         if view:
             if not hasattr(view, "__discord_ui_view__"):
                 raise InvalidArgument(
-                    f"view parameter must be View not {view.__class__!r}"
+                    f"view parameter must be BaseView not {view.__class__!r}"
                 )
 
             components = view.to_components()

discord/client.py

@@ -67,7 +67,7 @@
 from .sticker import GuildSticker, StandardSticker, StickerPack, _sticker_factory
 from .template import Template
 from .threads import Thread
-from .ui.view import View
+from .ui.view import BaseView
 from .user import ClientUser, User
 from .utils import _D, _FETCHABLE, MISSING
 from .voice_client import VoiceClient
@@ -90,7 +90,7 @@
     from .poll import Poll
     from .soundboard import SoundboardSound
     from .threads import Thread, ThreadMember
-    from .ui.item import Item
+    from .ui.item import Item, ViewItem
     from .voice_client import VoiceProtocol
 
 __all__ = ("Client",)
@@ -562,19 +562,19 @@ async def on_error(self, event_method: str, *args: Any, **kwargs: Any) -> None:
         traceback.print_exc()
 
     async def on_view_error(
-        self, error: Exception, item: Item, interaction: Interaction
+        self, error: Exception, item: ViewItem, interaction: Interaction
     ) -> None:
         """|coro|
 
         The default view error handler provided by the client.
 
-        This only fires for a view if you did not define its :func:`~discord.ui.View.on_error`.
+        This only fires for a view if you did not define its :func:`~discord.ui.BaseView.on_error`.
 
         Parameters
         ----------
         error: :class:`Exception`
             The exception that was raised.
-        item: :class:`Item`
+        item: :class:`ViewItem`
             The item that the user interacted with.
         interaction: :class:`Interaction`
             The interaction that was received.
@@ -2100,8 +2100,8 @@ async def create_dm(self, user: Snowflake) -> DMChannel:
         data = await state.http.start_private_message(user.id)
         return state.add_dm_channel(data)
 
-    def add_view(self, view: View, *, message_id: int | None = None) -> None:
-        """Registers a :class:`~discord.ui.View` for persistent listening.
+    def add_view(self, view: BaseView, *, message_id: int | None = None) -> None:
+        """Registers a :class:`~discord.ui.BaseView` for persistent listening.
 
         This method should be used for when a view is comprised of components
         that last longer than the lifecycle of the program.
@@ -2110,7 +2110,7 @@ def add_view(self, view: View, *, message_id: int | None = None) -> None:
 
         Parameters
         ----------
-        view: :class:`discord.ui.View`
+        view: :class:`discord.ui.BaseView`
             The view to register for dispatching.
         message_id: Optional[:class:`int`]
             The message ID that the view is attached to. This is currently used to
@@ -2126,8 +2126,8 @@ def add_view(self, view: View, *, message_id: int | None = None) -> None:
             and all their components have an explicitly provided ``custom_id``.
         """
 
-        if not isinstance(view, View):
-            raise TypeError(f"expected an instance of View not {view.__class__!r}")
+        if not isinstance(view, BaseView):
+            raise TypeError(f"expected an instance of BaseView not {view.__class__!r}")
 
         if not view.is_persistent():
             raise ValueError(
@@ -2138,7 +2138,7 @@ def add_view(self, view: View, *, message_id: int | None = None) -> None:
         self._connection.store_view(view, message_id)
 
     @property
-    def persistent_views(self) -> Sequence[View]:
+    def persistent_views(self) -> Sequence[BaseView]:
         """A sequence of persistent views added to the client.
 
         .. versionadded:: 2.0

discord/components.py

@@ -178,7 +178,7 @@ def __init__(self, data: ComponentPayload):
 
     @property
     def width(self):
-        """Return the sum of the children's widths."""
+        """Returns the sum of the item's widths."""
         t = 0
         for item in self.children:
             t += 1 if item.type is ComponentType.button else 5
@@ -194,6 +194,10 @@ def to_dict(self) -> ActionRowPayload:
     def walk_components(self) -> Iterator[Component]:
         yield from self.children
 
+    @property
+    def components(self) -> list[Component]:
+        return self.children
+
     def get_component(self, id: str | int) -> Component | None:
         """Get a component from this action row. Roughly equivalent to `utils.get(row.children, ...)`.
         If an ``int`` is provided, the component will be retrieved by ``id``, otherwise by ``custom_id``.
@@ -268,7 +272,7 @@ def __init__(self, data: InputTextComponentPayload):
         self.id: int | None = data.get("id")
         self.style: InputTextStyle = try_enum(InputTextStyle, data["style"])
         self.custom_id = data["custom_id"]
-        self.label: str = data.get("label", None)
+        self.label: str | None = data.get("label", None)
         self.placeholder: str | None = data.get("placeholder", None)
         self.min_length: int | None = data.get("min_length", None)
         self.max_length: int | None = data.get("max_length", None)
@@ -280,7 +284,6 @@ def to_dict(self) -> InputTextComponentPayload:
             "type": 4,
             "id": self.id,
             "style": self.style.value,
-            "label": self.label,
         }
         if self.custom_id:
             payload["custom_id"] = self.custom_id
@@ -300,6 +303,9 @@ def to_dict(self) -> InputTextComponentPayload:
         if self.value:
             payload["value"] = self.value
 
+        if self.label:
+            payload["label"] = self.label
+
         return payload  # type: ignore
 
 
@@ -1306,7 +1312,7 @@ class Label(Component):
     ``component`` may only be:
 
     - :class:`InputText`
-    - :class:`SelectMenu` (string)
+    - :class:`SelectMenu`
 
     This inherits from :class:`Component`.