container

Author: NeloBlivion

discord/components.py

@@ -169,12 +169,27 @@ def __init__(self, data: ComponentPayload):
             _component_factory(d) for d in data.get("components", [])
         ]
 
+    @property
+    def width(self):
+        """Return the total item width used by this action row."""
+        t = 0
+        for item in self.children:
+            t += 1 if item.type is ComponentType.button else 5
+        return t
+
     def to_dict(self) -> ActionRowPayload:
         return {
             "type": int(self.type),
             "components": [child.to_dict() for child in self.children],
         }  # type: ignore
 
+    @classmethod
+    def with_components(cls, *components):
+        return cls._raw_construct(
+            type=ComponentType.action_row,
+            id=None,
+            children=[c for c in components]
+        )
 
 class InputText(Component):
     """Represents an Input Text field from the Discord Bot UI Kit.

discord/ui/__init__.py

@@ -18,3 +18,6 @@
 from .text_display import *
 from .thumbnail import *
 from .view import *
+from .file import *
+from .separator import *
+from .container import *

discord/ui/container.py

@@ -0,0 +1,249 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, TypeVar
+
+from ..colour import Colour
+from ..components import Container as ContainerComponent
+from ..components import _component_factory, ActionRow
+from ..enums import ComponentType, SeparatorSpacingSize
+from .item import Item
+from .text_display import TextDisplay
+from .section import Section
+from .media_gallery import MediaGallery
+from .separator import Separator
+from .file import File
+
+__all__ = ("Container",)
+
+if TYPE_CHECKING:
+    from ..types.components import ContainerComponent as ContainerComponentPayload
+    from .view import View
+
+
+C = TypeVar("C", bound="Container")
+V = TypeVar("V", bound="View", covariant=True)
+
+
+class Container(Item[V]):
+    """Represents a UI Container. Containers may contain up to 10 items.
+
+    The current items supported are:
+
+    - :class:`discord.ui.Button`
+    - :class:`discord.ui.Select`
+    - :class:`discord.ui.Section`
+    - :class:`discord.ui.TextDisplay`
+    - :class:`discord.ui.MediaGallery`
+    - :class:`discord.ui.File`
+    - :class:`discord.ui.Separator`
+
+
+    .. versionadded:: 2.7
+
+    Parameters
+    ----------
+    *items: :class:`Item`
+        The initial items in this container, up to 10.
+    colour: Union[:class:`Colour`, :class:`int`]
+        The accent colour of the container. Aliased to ``color`` as well.
+    """
+
+    def __init__(
+        self,
+        *items: Item, 
+        colour: int | Colour | None = None,
+        color: int | Colour | None = None,
+        spoiler: bool = False
+    ):
+        super().__init__()
+
+        self.items = [i for i in items]
+        components = [i._underlying for i in items]
+        self._color = colour
+
+        self._underlying = ContainerComponent._raw_construct(
+            type=ComponentType.section,
+            id=None,
+            components=components,
+            accent_color=colour,
+            spoiler=spoiler
+        )
+
+    def add_item(self, item: Item) -> None:
+        """Adds an item to the container.
+
+        Parameters
+        ----------
+        item: :class:`Item`
+            The item to add to the container.
+
+        Raises
+        ------
+        TypeError
+            An :class:`Item` was not passed.
+        ValueError
+            Maximum number of items has been exceeded (10).
+        """
+
+        if len(self.items) >= 10:
+            raise ValueError("maximum number of children exceeded")
+
+        if not isinstance(item, Item):
+            raise TypeError(f"expected Item not {item.__class__!r}")
+
+        self.items.append(item)
+
+        # reuse weight system?
+
+        if item._underlying.is_v2():
+            self._underlying.components.append(item._underlying)
+        else:
+            found = False
+            for i in range(len(self._underlying.components) - 1, 0, -1):
+                row = self._underlying.components[i]
+                if isinstance(row, ActionRow) and row.width + item.width <= 5:  # If an actionRow exists
+                    row.children.append(item._underlying)
+                    found = True
+            if not found:
+                row = ActionRow.with_components(item._underlying)
+                self._underlying.components.append(row)
+
+    def add_section(
+        self,
+        *items: Item, accessory: Item = None
+    ):
+        """Adds a :class:`Section` to the container.
+
+        To append a pre-existing :class:`Section` use the
+        :meth:`add_item` method instead.
+
+        Parameters
+        ----------
+        *items: :class:`Item`
+            The items contained in this section, up to 3.
+            Currently only supports :class:`~discord.ui.TextDisplay`.
+        accessory: Optional[:class:`Item`]
+            The section's accessory. This is displayed in the top right of the section.
+            Currently only supports :class:`~discord.ui.Button` and :class:`~discord.ui.Thumbnail`.
+        """
+        # accept raw strings?
+
+        section = Section(
+            *items, accessory=accessory
+        )
+
+        self.add_item(section)
+
+    def add_text(self, content: str) -> None:
+        """Adds a :class:`TextDisplay` to the container.
+
+        Parameters
+        ----------
+        content: :class:`str`
+            The content of the TextDisplay
+        """
+
+        text = TextDisplay(content)
+
+        self.add_item(text)
+
+    def add_gallery(
+        self,
+        *items: Item,
+    ):
+        """Adds a :class:`MediaGallery` to the container.
+
+        To append a pre-existing :class:`MediaGallery` use the
+        :meth:`add_item` method instead.
+
+        Parameters
+        ----------
+        *items: List[:class:`MediaGalleryItem`]
+            The media this gallery contains.
+        """
+        # accept raw urls?
+
+        g = MediaGallery(
+            *items
+        )
+
+        self.add_item(g)
+
+    def add_file(self, url: str, spoiler: bool = False) -> None:
+        """Adds a :class:`TextDisplay` to the container.
+
+        Parameters
+        ----------
+        url: :class:`str`
+            The URL of this file's media. This must be an ``attachment://`` URL that references a :class:`~discord.File`.
+        spoiler: Optional[:class:`bool`]
+            Whether the file is a spoiler. Defaults to ``False``.
+        """
+
+        f = File(url, spoiler=spoiler)
+
+        self.add_item(f)
+
+    def add_separator(self, *, divider: bool = True, spacing: SeparatorSpacingSize = SeparatorSpacingSize.small) -> None:
+        """Adds a :class:`Separator` to the container.
+
+        Parameters
+        ----------
+        divider: :class:`bool`
+            Whether the separator is a divider. Defaults to ``True``.
+        spacing: :class:`~discord.SeparatorSpacingSize`
+            The spacing size of the separator. Defaults to :attr:`~discord.SeparatorSpacingSize.small`.
+        """
+
+        s = Separator(divider=divider, spacing=spacing)
+
+        self.add_item(s)
+
+    @property
+    def spoiler(self) -> bool:
+        """Whether the container is a spoiler. Defaults to ``False``."""
+        return self._spoiler
+
+    @spoiler.setter
+    def spoiler(self, spoiler: bool) -> None:
+        self._spoiler = spoiler
+        self._underlying.spoiler = spoiler
+
+    @property
+    def colour(self) -> Colour | None:
+        return getattr(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._underlying.accent_color = self.colour
+
+    color = colour
+
+    @property
+    def type(self) -> ComponentType:
+        return self._underlying.type
+
+    @property
+    def width(self) -> int:
+        return 5
+
+    def to_component_dict(self) -> ContainerComponentPayload:
+        return self._underlying.to_dict()
+
+    @classmethod
+    def from_component(cls: type[C], component: ContainerComponent) -> C:
+        from .view import _component_to_item
+
+        items = [_component_to_item(c) for c in component.components]
+        return cls(*items, colour=component.accent_color, spoiler=component.spoiler)
+
+    callback = None

discord/ui/file.py

@@ -61,7 +61,7 @@ def url(self, value: str) -> None:
     @property
     def spoiler(self) -> bool:
         """Whether the file is a spoiler. Defaults to ``False``."""
-        return self.spoiler
+        return self._spoiler
 
     @spoiler.setter
     def spoiler(self, spoiler: bool) -> None:

discord/ui/section.py

@@ -30,7 +30,7 @@ class Section(Item[V]):
         The initial items contained in this section, up to 3.
         Currently only supports :class:`~discord.ui.TextDisplay`.
     accessory: Optional[:class:`Item`]
-        This section's accessory. This is displayed in the top right of the section.
+        The section's accessory. This is displayed in the top right of the section.
         Currently only supports :class:`~discord.ui.Button` and :class:`~discord.ui.Thumbnail`.
     """
 

discord/ui/thumbnail.py

@@ -74,7 +74,7 @@ def description(self, description: str | None) -> None:
     @property
     def spoiler(self) -> bool:
         """Whether the thumbnail is a spoiler. Defaults to ``False``."""
-        return self.spoiler
+        return self._spoiler
 
     @spoiler.setter
     def spoiler(self, spoiler: bool) -> None:

discord/ui/view.py

@@ -36,13 +36,14 @@
 
 from ..components import ActionRow as ActionRowComponent
 from ..components import Button as ButtonComponent
-from ..components import Component, FileComponent
 from ..components import MediaGallery as MediaGalleryComponent
 from ..components import Section as SectionComponent
 from ..components import SelectMenu as SelectComponent
 from ..components import TextDisplay as TextDisplayComponent
 from ..components import Thumbnail as ThumbnailComponent
-from ..components import _component_factory
+from ..components import Separator as SeparatorComponent
+from ..components import Container as ContainerComponent
+from ..components import _component_factory, Component, FileComponent
 from ..utils import get
 from .item import Item, ItemCallbackType
 
@@ -93,6 +94,14 @@ def _component_to_item(component: Component) -> Item:
         from .file import File
 
         return File.from_component(component)
+    if isinstance(component, SeparatorComponent):
+        from .separator import Separator
+
+        return Separator.from_component(component)
+    if isinstance(component, ContainerComponent):
+        from .container import Container
+
+        return Container.from_component(component)
     return Item.from_component(component)