feat: More general enhancements for views

CHANGELOG.md

@@ -12,6 +12,8 @@ These changes are available on the `master` branch, but have not yet been releas
 
 ### Added
 
+- Added `replace_item` to `DesignerView`, `Section`, `Container`, `ActionRow`, &
+  `MediaGallery` ([#3032](https://github.com/Pycord-Development/pycord/pull/3032))
 - Added `.extension` attribute to emojis to get their file extension.
   ([#3055](https://github.com/Pycord-Development/pycord/pull/3055))
 
@@ -22,6 +24,8 @@ These changes are available on the `master` branch, but have not yet been releas
 
 ### Fixed
 
+- Fixed core issues with modifying items in `Container` and `Section`
+  ([#3032](https://github.com/Pycord-Development/pycord/pull/3032))
 - Fixed `RawMessageUpdateEvent.cached_message` being always `None` even when the message
   was cached. ([#3038](https://github.com/Pycord-Development/pycord/pull/3038))
 - Fixed downloading animated emojis which were originally uploaded as WebP files by

discord/client.py

@@ -594,7 +594,7 @@ async def on_modal_error(self, error: Exception, interaction: Interaction) -> No
         The default modal error handler provided by the client.
         The default implementation prints the traceback to stderr.
 
-        This only fires for a modal if you did not define its :func:`~discord.ui.Modal.on_error`.
+        This only fires for a modal if you did not define its :func:`~discord.ui.BaseModal.on_error`.
 
         Parameters
         ----------

discord/colour.py

@@ -118,6 +118,18 @@ def to_rgb(self) -> tuple[int, int, int]:
         """Returns an (r, g, b) tuple representing the colour."""
         return self.r, self.g, self.b
 
+    @classmethod
+    def resolve_value(cls: type[CT], value: int | Colour | None) -> CT:
+        if value is None or isinstance(value, Colour):
+            return value
+        elif isinstance(value, int):
+            return cls(value=value)
+        else:
+            raise TypeError(
+                "Expected discord.Colour, int, or None but received"
+                f" {value.__class__.__name__} instead."
+            )
+
     @classmethod
     def from_rgb(cls: type[CT], r: int, g: int, b: int) -> CT:
         """Constructs a :class:`Colour` from an RGB tuple."""

discord/components.py

@@ -134,7 +134,7 @@ def _raw_construct(cls: type[C], **kwargs) -> C:
             try:
                 value = kwargs[slot]
             except KeyError:
-                pass
+                setattr(self, slot, None)
             else:
                 setattr(self, slot, value)
         return self

discord/embeds.py

@@ -522,15 +522,7 @@ def colour(self) -> Colour | None:
 
     @colour.setter
     def colour(self, value: int | Colour | None):  # type: ignore
-        if value is None or isinstance(value, Colour):
-            self._colour = value
-        elif isinstance(value, int):
-            self._colour = Colour(value=value)
-        else:
-            raise TypeError(
-                "Expected discord.Colour, int, or None but received"
-                f" {value.__class__.__name__} instead."
-            )
+        self._colour = Colour.resolve_value(value)
 
     color = colour
 

discord/ext/pages/pagination.py

@@ -26,6 +26,8 @@
 
 from typing import List
 
+from typing_extensions import Self
+
 import discord
 from discord.errors import DiscordException
 from discord.ext.bridge import BridgeContext
@@ -911,6 +913,12 @@ def update_custom_view(self, custom_view: discord.ui.View):
         for item in custom_view.children:
             self.add_item(item)
 
+    def clear_items(self) -> Self:
+        # Necessary override due to behavior of Item.parent, see #3057
+        self.children.clear()
+        self._View__weights.clear()
+        return self
+
     def get_page_group_content(self, page_group: PageGroup) -> list[Page]:
         """Returns a converted list of `Page` objects for the given page group based on the content of its pages."""
         return [self.get_page_content(page) for page in page_group.pages]

discord/interactions.py

@@ -88,7 +88,7 @@
     from .types.interactions import InteractionCallbackResponse, InteractionData
     from .types.interactions import InteractionMetadata as InteractionMetadataPayload
     from .types.interactions import MessageInteraction as MessageInteractionPayload
-    from .ui.modal import Modal
+    from .ui.modal import BaseModal
     from .ui.view import BaseView
 
     InteractionChannel = Union[
@@ -168,7 +168,7 @@ class Interaction:
         The view that this interaction belongs to.
 
         .. versionadded:: 2.7
-    modal: Optional[:class:`Modal`]
+    modal: Optional[:class:`BaseModal`]
         The modal that this interaction belongs to.
 
         .. versionadded:: 2.7
@@ -258,7 +258,7 @@ def _from_data(self, data: InteractionPayload):
 
         self.command: ApplicationCommand | None = None
         self.view: BaseView | None = None
-        self.modal: Modal | None = None
+        self.modal: BaseModal | None = None
         self.attachment_size_limit: int = data.get("attachment_size_limit")
 
         self.message: Message | None = None
@@ -1343,14 +1343,14 @@ async def send_autocomplete_result(
         self._responded = True
         await self._process_callback_response(callback_response)
 
-    async def send_modal(self, modal: Modal) -> Interaction:
+    async def send_modal(self, modal: BaseModal) -> Interaction:
         """|coro|
         Responds to this interaction by sending a modal dialog.
         This cannot be used to respond to another modal dialog submission.
 
         Parameters
         ----------
-        modal: :class:`discord.ui.Modal`
+        modal: :class:`discord.ui.BaseModal`
             The modal dialog to display to the user.
 
         Raises

discord/state.py

@@ -70,7 +70,7 @@
 from .stage_instance import StageInstance
 from .sticker import GuildSticker
 from .threads import Thread, ThreadMember
-from .ui.modal import Modal, ModalStore
+from .ui.modal import BaseModal, ModalStore
 from .ui.view import BaseView, ViewStore
 from .user import ClientUser, User
 
@@ -413,7 +413,7 @@ def store_view(self, view: BaseView, message_id: int | None = None) -> None:
     def purge_message_view(self, message_id: int) -> None:
         self._view_store.remove_message_view(message_id)
 
-    def store_modal(self, modal: Modal, message_id: int) -> None:
+    def store_modal(self, modal: BaseModal, message_id: int) -> None:
         self._modal_store.add_modal(modal, message_id)
 
     def prevent_view_updates_for(self, message_id: int) -> BaseView | None:

discord/ui/action_row.py

@@ -95,11 +95,7 @@ def __init__(
 
         self.children: list[ViewItem] = []
 
-        self._underlying = ActionRowComponent._raw_construct(
-            type=ComponentType.action_row,
-            id=id,
-            children=[],
-        )
+        self._underlying = self._generate_underlying(id=id)
 
         for func in self.__row_children_items__:
             item: ViewItem = func.__discord_ui_model_type__(
@@ -111,14 +107,33 @@ def __init__(
         for i in items:
             self.add_item(i)
 
+    @property
+    def items(self) -> list[ViewItem]:
+        return self.children
+
+    @items.setter
+    def items(self, value: list[ViewItem]) -> None:
+        self.children = value
+
     def _add_component_from_item(self, item: ViewItem):
-        self._underlying.children.append(item._underlying)
+        self.underlying.children.append(item._generate_underlying())
 
     def _set_components(self, items: list[ViewItem]):
-        self._underlying.children.clear()
+        self.underlying.children.clear()
         for item in items:
             self._add_component_from_item(item)
 
+    def _generate_underlying(self, id: int | None = None) -> ActionRowComponent:
+        super()._generate_underlying(ActionRowComponent)
+        row = ActionRowComponent._raw_construct(
+            type=ComponentType.action_row,
+            id=id or self.id,
+            children=[],
+        )
+        for i in self.children:
+            row.children.append(i._generate_underlying())
+        return row
+
     def add_item(self, item: ViewItem) -> Self:
         """Adds an item to the action row.
 
@@ -164,6 +179,36 @@ def remove_item(self, item: ViewItem | str | int) -> Self:
         item.parent = None
         return self
 
+    def replace_item(
+        self, original_item: ViewItem | str | int, new_item: ViewItem
+    ) -> Self:
+        """Directly replace an item in this row.
+        If an :class:`int` is provided, the item will be replaced by ``id``, otherwise by  ``custom_id``.
+
+        Parameters
+        ----------
+        original_item: Union[:class:`ViewItem`, :class:`int`, :class:`str`]
+            The item, item ``id``, or item ``custom_id`` to replace in the row.
+        new_item: :class:`ViewItem`
+            The new item to insert into the row.
+        """
+
+        if not isinstance(new_item, (Select, Button)):
+            raise TypeError(f"expected Select or Button, not {new_item.__class__!r}")
+
+        if isinstance(original_item, (str, int)):
+            original_item = self.get_item(original_item)
+        if not original_item:
+            raise ValueError(f"Could not find original_item in row.")
+        try:
+            i = self.children.index(original_item)
+            new_item.parent = self
+            self.children[i] = new_item
+            original_item.parent = None
+        except ValueError:
+            raise ValueError(f"Could not find original_item in row.")
+        return self
+
     def get_item(self, id: str | int) -> ViewItem | None:
         """Get an item from this action row. Roughly equivalent to `utils.get(row.children, ...)`.
         If an ``int`` is provided, the item will be retrieved by ``id``, otherwise by ``custom_id``.
@@ -296,7 +341,7 @@ def add_select(
         id: int | None = None,
         default_values: Sequence[SelectDefaultValue] | None = None,
     ) -> Self:
-        """Adds a :class:`Select` to the container.
+        """Adds a :class:`Select` to the action row.
 
         To append a pre-existing :class:`Select`, use the
         :meth:`add_item` method instead.
@@ -358,7 +403,7 @@ def is_persistent(self) -> bool:
         return all(item.is_persistent() for item in self.children)
 
     def refresh_component(self, component: ActionRowComponent) -> None:
-        self._underlying = component
+        self.underlying = component
         for i, y in enumerate(component.components):
             x = self.children[i]
             x.refresh_component(y)
@@ -396,14 +441,14 @@ def width(self):
         """Return the sum of the items' widths."""
         t = 0
         for item in self.children:
-            t += 1 if item._underlying.type is ComponentType.button else 5
+            t += 1 if item.underlying.type is ComponentType.button else 5
         return t
 
     def walk_items(self) -> Iterator[ViewItem]:
         yield from self.children
 
     def to_component_dict(self) -> ActionRowPayload:
-        self._set_components(self.children)
+        self._underlying = self._generate_underlying()
         return super().to_component_dict()
 
     @classmethod