You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
443 lines
15 KiB
443 lines
15 KiB
"""
|
|
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
|
|
import os
|
|
import sys
|
|
from typing import (
|
|
TYPE_CHECKING,
|
|
Any,
|
|
ClassVar,
|
|
Coroutine,
|
|
Dict,
|
|
Generator,
|
|
List,
|
|
Literal,
|
|
Optional,
|
|
Tuple,
|
|
Type,
|
|
TypeVar,
|
|
Union,
|
|
)
|
|
|
|
from .item import Item, ItemCallbackType
|
|
from .view import _component_to_item, LayoutView
|
|
from .dynamic import DynamicItem
|
|
from ..enums import ComponentType
|
|
from ..utils import MISSING, get as _utils_get
|
|
|
|
if TYPE_CHECKING:
|
|
from typing_extensions import Self
|
|
|
|
from ..colour import Colour, Color
|
|
from ..components import Container as ContainerComponent
|
|
from ..interactions import Interaction
|
|
|
|
V = TypeVar('V', bound='LayoutView', covariant=True)
|
|
|
|
__all__ = ('Container',)
|
|
|
|
|
|
class _ContainerCallback:
|
|
__slots__ = ('container', 'callback', 'item')
|
|
|
|
def __init__(self, callback: ItemCallbackType[Any], container: Container, item: Item[Any]) -> None:
|
|
self.callback: ItemCallbackType[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]):
|
|
"""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, and :class:`File` 's in it.
|
|
|
|
This can be inherited.
|
|
|
|
.. note::
|
|
|
|
Containers can contain up to 10 top-level components.
|
|
|
|
.. 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``.
|
|
row: Optional[:class:`int`]
|
|
The relative row this container belongs to. By default
|
|
items are arranged automatically into those rows. If you'd
|
|
like to control the relative positioning of the row then
|
|
passing an index is advised. For example, row=1 will show
|
|
up before row=2. Defaults to ``None``, which is automatic
|
|
ordering. The row number must be between 0 and 39 (i.e. zero indexed)
|
|
id: Optional[:class:`int`]
|
|
The ID of this component. This must be unique across the view.
|
|
"""
|
|
|
|
__container_children_items__: ClassVar[Dict[str, Union[ItemCallbackType[Any], Item[Any]]]] = {}
|
|
__discord_ui_update_view__: ClassVar[bool] = True
|
|
__discord_ui_container__: ClassVar[bool] = True
|
|
|
|
def __init__(
|
|
self,
|
|
*children: Item[V],
|
|
accent_colour: Optional[Union[Colour, int]] = None,
|
|
accent_color: Optional[Union[Color, int]] = None,
|
|
spoiler: bool = False,
|
|
row: Optional[int] = None,
|
|
id: Optional[int] = None,
|
|
) -> None:
|
|
super().__init__()
|
|
self.__dispatchable: List[Item[V]] = []
|
|
self._children: List[Item[V]] = self._init_children()
|
|
|
|
if children is not MISSING:
|
|
for child in children:
|
|
self.add_item(child)
|
|
|
|
self.spoiler: bool = spoiler
|
|
self._colour = accent_colour or accent_color
|
|
|
|
self.row = row
|
|
self.id = id
|
|
|
|
def _add_dispatchable(self, item: Item[Any]) -> None:
|
|
self.__dispatchable.append(item)
|
|
|
|
def _remove_dispatchable(self, item: Item[Any]) -> None:
|
|
try:
|
|
self.__dispatchable.remove(item)
|
|
except ValueError:
|
|
pass
|
|
|
|
def _init_children(self) -> List[Item[Any]]:
|
|
children = []
|
|
parents = {}
|
|
|
|
for name, raw in self.__container_children_items__.items():
|
|
if isinstance(raw, Item):
|
|
item = copy.deepcopy(raw)
|
|
item._parent = self
|
|
if getattr(item, '__discord_ui_action_row__', False):
|
|
if item.is_dispatchable():
|
|
self.__dispatchable.extend(item._children) # type: ignore
|
|
if getattr(item, '__discord_ui_section__', False):
|
|
if item.accessory.is_dispatchable(): # type: ignore
|
|
if item.accessory._provided_custom_id is False: # type: ignore
|
|
item.accessory.custom_id = os.urandom(16).hex() # type: ignore
|
|
self.__dispatchable.append(item.accessory) # type: ignore
|
|
|
|
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 RuntimeError(f'{raw.__name__} is not a valid item for a Container')
|
|
parents.get(parent, parent)._children.append(item)
|
|
# we donnot append it to the children list because technically these buttons and
|
|
# selects are not from the container but the action row itself.
|
|
self.__dispatchable.append(item)
|
|
|
|
return children
|
|
|
|
def is_dispatchable(self) -> bool:
|
|
return bool(self.__dispatchable)
|
|
|
|
def is_persistent(self) -> bool:
|
|
return all(c.is_persistent() for c in self.children)
|
|
|
|
def __init_subclass__(cls) -> None:
|
|
super().__init_subclass__()
|
|
|
|
children: Dict[str, Union[ItemCallbackType[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_children_view(self, view) -> None:
|
|
for child in self._children:
|
|
child._view = view
|
|
if getattr(child, '__discord_ui_update_view__', False):
|
|
# if the item is an action row which child's view can be updated, then update it
|
|
child._update_children_view(view) # type: ignore
|
|
|
|
@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:
|
|
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 = []
|
|
|
|
key = lambda i: (i._rendered_row or i._row or sys.maxsize) + 1
|
|
for i in sorted(self._children, key=key):
|
|
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
|
|
|
|
def _update_store_data(
|
|
self,
|
|
dispatch_info: Dict[Tuple[int, str], Item[Any]],
|
|
dynamic_items: Dict[Any, Type[DynamicItem]],
|
|
) -> bool:
|
|
is_fully_dynamic = True
|
|
for item in self.__dispatchable:
|
|
if isinstance(item, DynamicItem):
|
|
pattern = item.__discord_ui_compiled_template__
|
|
dynamic_items[pattern] = item.__class__
|
|
elif item.is_dispatchable():
|
|
dispatch_info[(item.type.value, item.custom_id)] = item
|
|
is_fully_dynamic = False
|
|
return is_fully_dynamic
|
|
|
|
@classmethod
|
|
def from_component(cls, component: ContainerComponent) -> Self:
|
|
return cls(
|
|
*[_component_to_item(c) for c in component.children],
|
|
accent_colour=component.accent_colour,
|
|
spoiler=component.spoiler,
|
|
id=component.id,
|
|
)
|
|
|
|
def walk_children(self) -> Generator[Item[V], None, None]:
|
|
"""An iterator that recursively walks through all the children of this container
|
|
and it's children, if applicable.
|
|
|
|
Yields
|
|
------
|
|
:class:`Item`
|
|
An item in the container.
|
|
"""
|
|
|
|
for child in self.children:
|
|
yield child
|
|
|
|
if getattr(child, '__discord_ui_update_view__', False):
|
|
# if it has this attribute then it can contain 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)
|
|
|
|
if item.is_dispatchable():
|
|
if getattr(item, '__discord_ui_section__', False):
|
|
self.__dispatchable.append(item.accessory) # type: ignore
|
|
elif getattr(item, '__discord_ui_action_row__', False):
|
|
self.__dispatchable.extend([i for i in item._children if i.is_dispatchable()]) # type: ignore
|
|
else:
|
|
self.__dispatchable.append(item)
|
|
|
|
is_layout_view = self._view and getattr(self._view, '__discord_ui_layout_view__', False)
|
|
|
|
if getattr(item, '__discord_ui_update_view__', False):
|
|
item._update_children_view(self.view) # type: ignore
|
|
|
|
if is_layout_view:
|
|
self._view._total_children += sum(1 for _ in item.walk_children()) # type: ignore
|
|
elif is_layout_view:
|
|
self._view._total_children += 1 # type: ignore
|
|
|
|
item._view = self.view
|
|
item._parent = self
|
|
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:`TextDisplay`
|
|
The item to remove from the section.
|
|
"""
|
|
|
|
try:
|
|
self._children.remove(item)
|
|
except ValueError:
|
|
pass
|
|
else:
|
|
if item.is_dispatchable():
|
|
if getattr(item, '__discord_ui_section__', False):
|
|
self._remove_dispatchable(item.accessory) # type: ignore
|
|
elif getattr(item, '__discord_ui_action_row__', False):
|
|
for c in item._children: # type: ignore
|
|
if not c.is_dispatchable():
|
|
continue
|
|
self._remove_dispatchable(c)
|
|
else:
|
|
self._remove_dispatchable(item)
|
|
|
|
if self._view and getattr(self._view, '__discord_ui_layout_view__', False):
|
|
if getattr(item, '__discord_ui_update_view__', False):
|
|
self._view._total_children -= len(tuple(item.walk_children())) # type: ignore
|
|
else:
|
|
self._view._total_children -= 1
|
|
return self
|
|
|
|
def get_item_by_id(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._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 getattr(self._view, '__discord_ui_layout_view__', False):
|
|
self._view._total_children -= sum(1 for _ in self.walk_children())
|
|
self._children.clear()
|
|
self.__dispatchable.clear()
|
|
return self
|
|
|