mirror of
https://github.com/Rapptz/discord.py.git
synced 2025-09-05 09:26:10 +00:00
Add support for components V2
Co-authored-by: Michael H <michael@michaelhall.tech> Co-authored-by: Soheab <33902984+Soheab@users.noreply.github.com> Co-authored-by: owocado <24418520+owocado@users.noreply.github.com> Co-authored-by: Jay3332 <40323796+jay3332@users.noreply.github.com> Co-authored-by: Danny <1695103+Rapptz@users.noreply.github.com>
This commit is contained in:
DA344
GitHub
369
discord/ui/container.py
Normal file
369
discord/ui/container.py
Normal file
@ -0,0 +1,369 @@
|
||||
"""
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015-present Rapptz
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a
|
||||
copy of this software and associated documentation files (the "Software"),
|
||||
to deal in the Software without restriction, including without limitation
|
||||
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||
and/or sell copies of the Software, and to permit persons to whom the
|
||||
Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
||||
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
DEALINGS IN THE SOFTWARE.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import copy
|
||||
from typing import (
|
||||
TYPE_CHECKING,
|
||||
Any,
|
||||
Callable,
|
||||
ClassVar,
|
||||
Coroutine,
|
||||
Dict,
|
||||
Generator,
|
||||
List,
|
||||
Literal,
|
||||
Optional,
|
||||
TypeVar,
|
||||
Union,
|
||||
)
|
||||
|
||||
from .item import Item, I
|
||||
from .view import _component_to_item, LayoutView
|
||||
from ..enums import ComponentType
|
||||
from ..utils import get as _utils_get
|
||||
from ..colour import Colour, Color
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from typing_extensions import Self
|
||||
|
||||
from ..components import Container as ContainerComponent
|
||||
from ..interactions import Interaction
|
||||
|
||||
ItemCallbackType = Callable[['S', Interaction[Any], I], Coroutine[Any, Any, Any]]
|
||||
|
||||
S = TypeVar('S', bound='Container', covariant=True)
|
||||
V = TypeVar('V', bound='LayoutView', covariant=True)
|
||||
|
||||
__all__ = ('Container',)
|
||||
|
||||
|
||||
class _ContainerCallback:
|
||||
__slots__ = ('container', 'callback', 'item')
|
||||
|
||||
def __init__(self, callback: ItemCallbackType[S, Any], container: Container, item: Item[Any]) -> None:
|
||||
self.callback: ItemCallbackType[Any, Any] = callback
|
||||
self.container: Container = container
|
||||
self.item: Item[Any] = item
|
||||
|
||||
def __call__(self, interaction: Interaction) -> Coroutine[Any, Any, Any]:
|
||||
return self.callback(self.container, interaction, self.item)
|
||||
|
||||
|
||||
class Container(Item[V]):
|
||||
r"""Represents a UI container.
|
||||
|
||||
This is a top-level layout component that can only be used on :class:`LayoutView`
|
||||
and can contain :class:`ActionRow`\s, :class:`TextDisplay`\s, :class:`Section`\s,
|
||||
:class:`MediaGallery`\s, :class:`File`\s, and :class:`Separator`\s in it.
|
||||
|
||||
This can be inherited.
|
||||
|
||||
|
||||
.. versionadded:: 2.6
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. code-block:: python3
|
||||
|
||||
import discord
|
||||
from discord import ui
|
||||
|
||||
# you can subclass it and add components as you would add them
|
||||
# in a LayoutView
|
||||
class MyContainer(ui.Container):
|
||||
action_row = ui.ActionRow()
|
||||
|
||||
@action_row.button(label='A button in a container!')
|
||||
async def a_button(self, interaction: discord.Interaction, button: discord.ui.Button):
|
||||
await interaction.response.send_message('You clicked a button!')
|
||||
|
||||
# or use it directly on LayoutView
|
||||
class MyView(ui.LayoutView):
|
||||
container = ui.Container(ui.TextDisplay('I am a text display on a container!'))
|
||||
# or you can use your subclass:
|
||||
# container = MyContainer()
|
||||
|
||||
Parameters
|
||||
----------
|
||||
\*children: :class:`Item`
|
||||
The initial children of this container.
|
||||
accent_colour: Optional[Union[:class:`.Colour`, :class:`int`]]
|
||||
The colour of the container. Defaults to ``None``.
|
||||
accent_color: Optional[Union[:class:`.Colour`, :class:`int`]]
|
||||
The color of the container. Defaults to ``None``.
|
||||
spoiler: :class:`bool`
|
||||
Whether to flag this container as a spoiler. Defaults
|
||||
to ``False``.
|
||||
id: Optional[:class:`int`]
|
||||
The ID of this component. This must be unique across the view.
|
||||
"""
|
||||
|
||||
__container_children_items__: ClassVar[Dict[str, Union[ItemCallbackType[Self, Any], Item[Any]]]] = {}
|
||||
__discord_ui_container__: ClassVar[bool] = True
|
||||
__item_repr_attributes__ = (
|
||||
'accent_colour',
|
||||
'spoiler',
|
||||
'id',
|
||||
)
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
*children: Item[V],
|
||||
accent_colour: Optional[Union[Colour, int]] = None,
|
||||
accent_color: Optional[Union[Color, int]] = None,
|
||||
spoiler: bool = False,
|
||||
id: Optional[int] = None,
|
||||
) -> None:
|
||||
super().__init__()
|
||||
self._children: List[Item[V]] = self._init_children()
|
||||
for child in children:
|
||||
self.add_item(child)
|
||||
|
||||
self.spoiler: bool = spoiler
|
||||
self._colour = accent_colour if accent_colour is not None else accent_color
|
||||
self.id = id
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f'<{self.__class__.__name__} children={len(self._children)}>'
|
||||
|
||||
def _init_children(self) -> List[Item[Any]]:
|
||||
children = []
|
||||
parents = {}
|
||||
|
||||
for name, raw in self.__container_children_items__.items():
|
||||
if isinstance(raw, Item):
|
||||
item = raw.copy()
|
||||
item._parent = self
|
||||
setattr(self, name, item)
|
||||
children.append(item)
|
||||
parents[raw] = item
|
||||
else:
|
||||
# action rows can be created inside containers, and then callbacks can exist here
|
||||
# so we create items based off them
|
||||
item: Item = raw.__discord_ui_model_type__(**raw.__discord_ui_model_kwargs__)
|
||||
item.callback = _ContainerCallback(raw, self, item) # type: ignore
|
||||
setattr(self, raw.__name__, item)
|
||||
# this should not fail because in order for a function to be here it should be from
|
||||
# an action row and must have passed the check in __init_subclass__, but still
|
||||
# guarding it
|
||||
parent = getattr(raw, '__discord_ui_parent__', None)
|
||||
if parent is None:
|
||||
raise ValueError(f'{raw.__name__} is not a valid item for a Container')
|
||||
parents.get(parent, parent)._children.append(item)
|
||||
# we do not append it to the children list because technically these buttons and
|
||||
# selects are not from the container but the action row itself.
|
||||
|
||||
return children
|
||||
|
||||
def __init_subclass__(cls) -> None:
|
||||
super().__init_subclass__()
|
||||
|
||||
children: Dict[str, Union[ItemCallbackType[Self, Any], Item[Any]]] = {}
|
||||
for base in reversed(cls.__mro__):
|
||||
for name, member in base.__dict__.items():
|
||||
if isinstance(member, Item):
|
||||
children[name] = member
|
||||
if hasattr(member, '__discord_ui_model_type__') and getattr(member, '__discord_ui_parent__', None):
|
||||
children[name] = copy.copy(member)
|
||||
|
||||
cls.__container_children_items__ = children
|
||||
|
||||
def _update_view(self, view) -> bool:
|
||||
self._view = view
|
||||
for child in self._children:
|
||||
child._update_view(view)
|
||||
return True
|
||||
|
||||
def _has_children(self):
|
||||
return True
|
||||
|
||||
@property
|
||||
def children(self) -> List[Item[V]]:
|
||||
"""List[:class:`Item`]: The children of this container."""
|
||||
return self._children.copy()
|
||||
|
||||
@children.setter
|
||||
def children(self, value: List[Item[V]]) -> None:
|
||||
self._children = value
|
||||
|
||||
@property
|
||||
def accent_colour(self) -> Optional[Union[Colour, int]]:
|
||||
"""Optional[Union[:class:`discord.Colour`, :class:`int`]]: The colour of the container, or ``None``."""
|
||||
return self._colour
|
||||
|
||||
@accent_colour.setter
|
||||
def accent_colour(self, value: Optional[Union[Colour, int]]) -> None:
|
||||
if value is not None and not isinstance(value, (int, Colour)):
|
||||
raise TypeError(f'expected an int, or Colour, not {value.__class__.__name__!r}')
|
||||
|
||||
self._colour = value
|
||||
|
||||
accent_color = accent_colour
|
||||
|
||||
@property
|
||||
def type(self) -> Literal[ComponentType.container]:
|
||||
return ComponentType.container
|
||||
|
||||
@property
|
||||
def width(self):
|
||||
return 5
|
||||
|
||||
def _is_v2(self) -> bool:
|
||||
return True
|
||||
|
||||
def to_components(self) -> List[Dict[str, Any]]:
|
||||
components = []
|
||||
for i in self._children:
|
||||
components.append(i.to_component_dict())
|
||||
return components
|
||||
|
||||
def to_component_dict(self) -> Dict[str, Any]:
|
||||
components = self.to_components()
|
||||
|
||||
colour = None
|
||||
if self._colour:
|
||||
colour = self._colour if isinstance(self._colour, int) else self._colour.value
|
||||
|
||||
base = {
|
||||
'type': self.type.value,
|
||||
'accent_color': colour,
|
||||
'spoiler': self.spoiler,
|
||||
'components': components,
|
||||
}
|
||||
if self.id is not None:
|
||||
base['id'] = self.id
|
||||
return base
|
||||
|
||||
@classmethod
|
||||
def from_component(cls, component: ContainerComponent) -> Self:
|
||||
self = cls(
|
||||
accent_colour=component.accent_colour,
|
||||
spoiler=component.spoiler,
|
||||
id=component.id,
|
||||
)
|
||||
self._children = [_component_to_item(cmp, self) for cmp in component.children]
|
||||
return self
|
||||
|
||||
def walk_children(self) -> Generator[Item[V], None, None]:
|
||||
"""An iterator that recursively walks through all the children of this container
|
||||
and its children, if applicable.
|
||||
|
||||
Yields
|
||||
------
|
||||
:class:`Item`
|
||||
An item in the container.
|
||||
"""
|
||||
|
||||
for child in self.children:
|
||||
yield child
|
||||
|
||||
if child._has_children():
|
||||
yield from child.walk_children() # type: ignore
|
||||
|
||||
def add_item(self, item: Item[Any]) -> Self:
|
||||
"""Adds an item to this container.
|
||||
|
||||
This function returns the class instance to allow for fluent-style
|
||||
chaining.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
item: :class:`Item`
|
||||
The item to append.
|
||||
|
||||
Raises
|
||||
------
|
||||
TypeError
|
||||
An :class:`Item` was not passed.
|
||||
"""
|
||||
if not isinstance(item, Item):
|
||||
raise TypeError(f'expected Item not {item.__class__.__name__}')
|
||||
|
||||
self._children.append(item)
|
||||
item._update_view(self.view)
|
||||
item._parent = self
|
||||
|
||||
if item._has_children() and self._view:
|
||||
self._view._total_children += len(tuple(item.walk_children())) # type: ignore
|
||||
elif self._view:
|
||||
self._view._total_children += 1
|
||||
return self
|
||||
|
||||
def remove_item(self, item: Item[Any]) -> Self:
|
||||
"""Removes an item from this container.
|
||||
|
||||
This function returns the class instance to allow for fluent-style
|
||||
chaining.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
item: :class:`Item`
|
||||
The item to remove from the container.
|
||||
"""
|
||||
|
||||
try:
|
||||
self._children.remove(item)
|
||||
except ValueError:
|
||||
pass
|
||||
else:
|
||||
if self._view and self._view._is_layout():
|
||||
if item._has_children():
|
||||
self._view._total_children -= len(tuple(item.walk_children())) # type: ignore
|
||||
else:
|
||||
self._view._total_children -= 1
|
||||
return self
|
||||
|
||||
def find_item(self, id: int, /) -> Optional[Item[V]]:
|
||||
"""Gets an item with :attr:`Item.id` set as ``id``, or ``None`` if
|
||||
not found.
|
||||
|
||||
.. warning::
|
||||
|
||||
This is **not the same** as ``custom_id``.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
id: :class:`int`
|
||||
The ID of the component.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Optional[:class:`Item`]
|
||||
The item found, or ``None``.
|
||||
"""
|
||||
return _utils_get(self.walk_children(), id=id)
|
||||
|
||||
def clear_items(self) -> Self:
|
||||
"""Removes all the items from the container.
|
||||
|
||||
This function returns the class instance to allow for fluent-style
|
||||
chaining.
|
||||
"""
|
||||
|
||||
if self._view and self._view._is_layout():
|
||||
self._view._total_children -= len(tuple(self.walk_children()))
|
||||
self._children.clear()
|
||||
return self
|
||||
Reference in New Issue
Block a user