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.
599 lines
23 KiB
599 lines
23 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 sys
|
|
from itertools import groupby
|
|
from typing import (
|
|
TYPE_CHECKING,
|
|
Any,
|
|
Callable,
|
|
ClassVar,
|
|
Coroutine,
|
|
Dict,
|
|
Generator,
|
|
List,
|
|
Literal,
|
|
Optional,
|
|
Sequence,
|
|
Type,
|
|
TypeVar,
|
|
Union,
|
|
overload,
|
|
)
|
|
|
|
from .item import Item, ItemCallbackType
|
|
from .button import Button, button as _button
|
|
from .dynamic import DynamicItem
|
|
from .select import select as _select, Select, UserSelect, RoleSelect, ChannelSelect, MentionableSelect
|
|
from ..components import ActionRow as ActionRowComponent
|
|
from ..enums import ButtonStyle, ComponentType, ChannelType
|
|
from ..partial_emoji import PartialEmoji
|
|
from ..utils import MISSING, get as _utils_get
|
|
|
|
if TYPE_CHECKING:
|
|
from typing_extensions import Self
|
|
|
|
from .view import LayoutView
|
|
from .select import (
|
|
BaseSelectT,
|
|
ValidDefaultValues,
|
|
MentionableSelectT,
|
|
ChannelSelectT,
|
|
RoleSelectT,
|
|
UserSelectT,
|
|
SelectT,
|
|
SelectCallbackDecorator,
|
|
)
|
|
from ..emoji import Emoji
|
|
from ..components import SelectOption
|
|
from ..interactions import Interaction
|
|
|
|
V = TypeVar('V', bound='LayoutView', covariant=True)
|
|
|
|
__all__ = ('ActionRow',)
|
|
|
|
|
|
class _ActionRowCallback:
|
|
__slots__ = ('row', 'callback', 'item')
|
|
|
|
def __init__(self, callback: ItemCallbackType[Any], row: ActionRow, item: Item[Any]) -> None:
|
|
self.callback: ItemCallbackType[Any] = callback
|
|
self.row: ActionRow = row
|
|
self.item: Item[Any] = item
|
|
|
|
def __call__(self, interaction: Interaction) -> Coroutine[Any, Any, Any]:
|
|
return self.callback(self.row, interaction, self.item)
|
|
|
|
|
|
class ActionRow(Item[V]):
|
|
"""Represents a UI action row.
|
|
|
|
This is a top-level layout component that can only be used on :class:`LayoutView`
|
|
and can contain :class:`Button` 's and :class:`Select` 's in it.
|
|
|
|
This can be inherited.
|
|
|
|
.. note::
|
|
|
|
Action rows can contain up to 5 components, which is, 5 buttons or 1 select.
|
|
|
|
.. versionadded:: 2.6
|
|
|
|
Examples
|
|
--------
|
|
|
|
.. code-block:: python3
|
|
|
|
import discord
|
|
from discord import ui
|
|
|
|
# you can subclass it and add components with the decorators
|
|
class MyActionRow(ui.ActionRow):
|
|
@ui.button(label='Click Me!')
|
|
async def click_me(self, interaction: discord.Interaction, button: discord.ui.Button):
|
|
await interaction.response.send_message('You clicked me!')
|
|
|
|
# or use it directly on LayoutView
|
|
class MyView(ui.LayoutView):
|
|
row = ui.ActionRow()
|
|
# or you can use your subclass:
|
|
# row = MyActionRow()
|
|
|
|
# you can create items with row.button and row.select
|
|
@row.button(label='A button!')
|
|
async def row_button(self, interaction: discord.Interaction, button: discord.ui.Button):
|
|
await interaction.response.send_message('You clicked a button!')
|
|
|
|
Parameters
|
|
----------
|
|
*children: :class:`Item`
|
|
The initial children of this action row.
|
|
row: Optional[:class:`int`]
|
|
The relative row this action row 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.
|
|
"""
|
|
|
|
__action_row_children_items__: ClassVar[List[ItemCallbackType[Any]]] = []
|
|
__discord_ui_action_row__: ClassVar[bool] = True
|
|
__discord_ui_update_view__: ClassVar[bool] = True
|
|
|
|
def __init__(
|
|
self,
|
|
*children: Item[V],
|
|
row: Optional[int] = None,
|
|
id: Optional[int] = None,
|
|
) -> None:
|
|
super().__init__()
|
|
self._weight: int = 0
|
|
self._children: List[Item[V]] = self._init_children()
|
|
self._children.extend(children)
|
|
self._weight += sum(i.width for i in children)
|
|
|
|
if self._weight > 5:
|
|
raise ValueError('maximum number of children exceeded')
|
|
|
|
self.id = id
|
|
self.row = row
|
|
|
|
def __init_subclass__(cls) -> None:
|
|
super().__init_subclass__()
|
|
|
|
children: Dict[str, ItemCallbackType[Any]] = {}
|
|
for base in reversed(cls.__mro__):
|
|
for name, member in base.__dict__.items():
|
|
if hasattr(member, '__discord_ui_model_type__'):
|
|
children[name] = member
|
|
|
|
if len(children) > 5:
|
|
raise TypeError('ActionRow cannot have more than 5 children')
|
|
|
|
cls.__action_row_children_items__ = list(children.values())
|
|
|
|
def _init_children(self) -> List[Item[Any]]:
|
|
children = []
|
|
|
|
for func in self.__action_row_children_items__:
|
|
item: Item = func.__discord_ui_model_type__(**func.__discord_ui_model_kwargs__)
|
|
item.callback = _ActionRowCallback(func, self, item) # type: ignore
|
|
item._parent = getattr(func, '__discord_ui_parent__', self)
|
|
setattr(self, func.__name__, item)
|
|
self._weight += item.width
|
|
children.append(item)
|
|
return children
|
|
|
|
def _update_store_data(self, dispatch_info: Dict, dynamic_items: Dict) -> bool:
|
|
is_fully_dynamic = True
|
|
|
|
for item in self._children:
|
|
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
|
|
|
|
def is_dispatchable(self) -> bool:
|
|
return any(c.is_dispatchable() for c in self.children)
|
|
|
|
def is_persistent(self) -> bool:
|
|
return all(c.is_persistent() for c in self.children)
|
|
|
|
def _update_children_view(self, view: LayoutView) -> None:
|
|
for child in self._children:
|
|
child._view = view # pyright: ignore[reportAttributeAccessIssue]
|
|
|
|
def _is_v2(self) -> bool:
|
|
# although it is not really a v2 component the only usecase here is for
|
|
# LayoutView which basically represents the top-level payload of components
|
|
# and ActionRow is only allowed there anyways.
|
|
# If the user tries to add any V2 component to a View instead of LayoutView
|
|
# it should error anyways.
|
|
return True
|
|
|
|
@property
|
|
def width(self):
|
|
return 5
|
|
|
|
@property
|
|
def type(self) -> Literal[ComponentType.action_row]:
|
|
return ComponentType.action_row
|
|
|
|
@property
|
|
def children(self) -> List[Item[V]]:
|
|
"""List[:class:`Item`]: The list of children attached to this action row."""
|
|
return self._children.copy()
|
|
|
|
def walk_children(self) -> Generator[Item[V], Any, None]:
|
|
"""An iterator that recursively walks through all the children of this view
|
|
and it's children, if applicable.
|
|
|
|
Yields
|
|
------
|
|
:class:`Item`
|
|
An item in the action row.
|
|
"""
|
|
|
|
for child in self.children:
|
|
yield child
|
|
|
|
def add_item(self, item: Item[Any]) -> Self:
|
|
"""Adds an item to this row.
|
|
|
|
This function returns the class instance to allow for fluent-style
|
|
chaining.
|
|
|
|
Parameters
|
|
----------
|
|
item: :class:`Item`
|
|
The item to add to the row.
|
|
|
|
Raises
|
|
------
|
|
TypeError
|
|
An :class:`Item` was not passed.
|
|
ValueError
|
|
Maximum number of children has been exceeded (5).
|
|
"""
|
|
|
|
if len(self._children) >= 5:
|
|
raise ValueError('maximum number of children exceeded')
|
|
|
|
if not isinstance(item, Item):
|
|
raise TypeError(f'expected Item not {item.__class__.__name__}')
|
|
|
|
item._view = self._view
|
|
item._parent = self
|
|
self._children.append(item)
|
|
|
|
if self._view and getattr(self._view, '__discord_ui_layout_view__', False):
|
|
self._view._total_children += 1
|
|
|
|
if item.is_dispatchable() and self._parent and getattr(self._parent, '__discord_ui_container__', False):
|
|
self._parent._add_dispatchable(item) # type: ignore
|
|
|
|
return self
|
|
|
|
def remove_item(self, item: Item[Any]) -> Self:
|
|
"""Removes an item from the row.
|
|
|
|
This function returns the class instance to allow for fluent-style
|
|
chaining.
|
|
|
|
Parameters
|
|
----------
|
|
item: :class:`Item`
|
|
The item to remove from the view.
|
|
"""
|
|
|
|
try:
|
|
self._children.remove(item)
|
|
except ValueError:
|
|
pass
|
|
else:
|
|
if self._view and getattr(self._view, '__discord_ui_layout_view__', False):
|
|
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 items from the row.
|
|
|
|
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 -= len(self._children)
|
|
self._children.clear()
|
|
return self
|
|
|
|
def to_component_dict(self) -> Dict[str, Any]:
|
|
components = []
|
|
|
|
def key(item: Item) -> int:
|
|
if item._rendered_row is not None:
|
|
return item._rendered_row
|
|
if item._row is not None:
|
|
return item._row
|
|
return sys.maxsize
|
|
|
|
for _, cmps in groupby(self._children, key=key):
|
|
components.extend(c.to_component_dict() for c in cmps)
|
|
|
|
base = {
|
|
'type': self.type.value,
|
|
'components': components,
|
|
}
|
|
if self.id is not None:
|
|
base['id'] = self.id
|
|
return base
|
|
|
|
def button(
|
|
self,
|
|
*,
|
|
label: Optional[str] = None,
|
|
custom_id: Optional[str] = None,
|
|
disabled: bool = False,
|
|
style: ButtonStyle = ButtonStyle.secondary,
|
|
emoji: Optional[Union[str, Emoji, PartialEmoji]] = None,
|
|
) -> Callable[[ItemCallbackType[Button[V]]], Button[V]]:
|
|
"""A decorator that attaches a button to a component.
|
|
|
|
The function being decorated should have three parameters, ``self`` representing
|
|
the :class:`discord.ui.LayoutView`, the :class:`discord.Interaction` you receive and
|
|
the :class:`discord.ui.Button` being pressed.
|
|
|
|
.. note::
|
|
|
|
Buttons with a URL or a SKU cannot be created with this function.
|
|
Consider creating a :class:`Button` manually and adding it via
|
|
:meth:`ActionRow.add_item` instead. This is beacuse these buttons
|
|
cannot have a callback associated with them since Discord does not
|
|
do any processing with them.
|
|
|
|
Parameters
|
|
----------
|
|
label: Optional[:class:`str`]
|
|
The label of the button, if any.
|
|
Can only be up to 80 characters.
|
|
custom_id: Optional[:class:`str`]
|
|
The ID of the button that gets received during an interaction.
|
|
It is recommended to not set this parameters to prevent conflicts.
|
|
Can only be up to 100 characters.
|
|
style: :class:`.ButtonStyle`
|
|
The style of the button. Defaults to :attr:`.ButtonStyle.grey`.
|
|
disabled: :class:`bool`
|
|
Whether the button is disabled or not. Defaults to ``False``.
|
|
emoji: Optional[Union[:class:`str`, :class:`.Emoji`, :class:`.PartialEmoji`]]
|
|
The emoji of the button. This can be in string form or a :class:`.PartialEmoji`
|
|
or a full :class:`.Emoji`.
|
|
"""
|
|
|
|
def decorator(func: ItemCallbackType[Button[V]]) -> ItemCallbackType[Button[V]]:
|
|
ret = _button(
|
|
label=label,
|
|
custom_id=custom_id,
|
|
disabled=disabled,
|
|
style=style,
|
|
emoji=emoji,
|
|
row=None,
|
|
)(func)
|
|
ret.__discord_ui_parent__ = self # type: ignore
|
|
return ret # type: ignore
|
|
|
|
return decorator # type: ignore
|
|
|
|
@overload
|
|
def select(
|
|
self,
|
|
*,
|
|
cls: Type[SelectT] = Select[Any],
|
|
options: List[SelectOption] = MISSING,
|
|
channel_types: List[ChannelType] = ...,
|
|
placeholder: Optional[str] = ...,
|
|
custom_id: str = ...,
|
|
min_values: int = ...,
|
|
max_values: int = ...,
|
|
disabled: bool = ...,
|
|
) -> SelectCallbackDecorator[SelectT]:
|
|
...
|
|
|
|
@overload
|
|
def select(
|
|
self,
|
|
*,
|
|
cls: Type[UserSelectT] = UserSelect[Any],
|
|
options: List[SelectOption] = MISSING,
|
|
channel_types: List[ChannelType] = ...,
|
|
placeholder: Optional[str] = ...,
|
|
custom_id: str = ...,
|
|
min_values: int = ...,
|
|
max_values: int = ...,
|
|
disabled: bool = ...,
|
|
default_values: Sequence[ValidDefaultValues] = ...,
|
|
) -> SelectCallbackDecorator[UserSelectT]:
|
|
...
|
|
|
|
@overload
|
|
def select(
|
|
self,
|
|
*,
|
|
cls: Type[RoleSelectT] = RoleSelect[Any],
|
|
options: List[SelectOption] = MISSING,
|
|
channel_types: List[ChannelType] = ...,
|
|
placeholder: Optional[str] = ...,
|
|
custom_id: str = ...,
|
|
min_values: int = ...,
|
|
max_values: int = ...,
|
|
disabled: bool = ...,
|
|
default_values: Sequence[ValidDefaultValues] = ...,
|
|
) -> SelectCallbackDecorator[RoleSelectT]:
|
|
...
|
|
|
|
@overload
|
|
def select(
|
|
self,
|
|
*,
|
|
cls: Type[ChannelSelectT] = ChannelSelect[Any],
|
|
options: List[SelectOption] = MISSING,
|
|
channel_types: List[ChannelType] = ...,
|
|
placeholder: Optional[str] = ...,
|
|
custom_id: str = ...,
|
|
min_values: int = ...,
|
|
max_values: int = ...,
|
|
disabled: bool = ...,
|
|
default_values: Sequence[ValidDefaultValues] = ...,
|
|
) -> SelectCallbackDecorator[ChannelSelectT]:
|
|
...
|
|
|
|
@overload
|
|
def select(
|
|
self,
|
|
*,
|
|
cls: Type[MentionableSelectT] = MentionableSelect[Any],
|
|
options: List[SelectOption] = MISSING,
|
|
channel_types: List[ChannelType] = MISSING,
|
|
placeholder: Optional[str] = ...,
|
|
custom_id: str = ...,
|
|
min_values: int = ...,
|
|
max_values: int = ...,
|
|
disabled: bool = ...,
|
|
default_values: Sequence[ValidDefaultValues] = ...,
|
|
) -> SelectCallbackDecorator[MentionableSelectT]:
|
|
...
|
|
|
|
def select(
|
|
self,
|
|
*,
|
|
cls: Type[BaseSelectT] = Select[Any],
|
|
options: List[SelectOption] = MISSING,
|
|
channel_types: List[ChannelType] = MISSING,
|
|
placeholder: Optional[str] = None,
|
|
custom_id: str = MISSING,
|
|
min_values: int = 1,
|
|
max_values: int = 1,
|
|
disabled: bool = False,
|
|
default_values: Sequence[ValidDefaultValues] = MISSING,
|
|
) -> SelectCallbackDecorator[BaseSelectT]:
|
|
"""A decorator that attaches a select menu to a component.
|
|
|
|
The function being decorated should have three parameters, ``self`` representing
|
|
the :class:`discord.ui.LayoutView`, the :class:`discord.Interaction` you receive and
|
|
the chosen select class.
|
|
|
|
To obtain the selected values inside the callback, you can use the ``values`` attribute of the chosen class in the callback. The list of values
|
|
will depend on the type of select menu used. View the table below for more information.
|
|
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| Select Type | Resolved Values |
|
|
+========================================+=================================================================================================================+
|
|
| :class:`discord.ui.Select` | List[:class:`str`] |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| :class:`discord.ui.UserSelect` | List[Union[:class:`discord.Member`, :class:`discord.User`]] |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| :class:`discord.ui.RoleSelect` | List[:class:`discord.Role`] |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| :class:`discord.ui.MentionableSelect` | List[Union[:class:`discord.Role`, :class:`discord.Member`, :class:`discord.User`]] |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
| :class:`discord.ui.ChannelSelect` | List[Union[:class:`~discord.app_commands.AppCommandChannel`, :class:`~discord.app_commands.AppCommandThread`]] |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------+
|
|
|
|
Example
|
|
---------
|
|
.. code-block:: python3
|
|
|
|
class ActionRow(discord.ui.ActionRow):
|
|
|
|
@discord.ui.select(cls=ChannelSelect, channel_types=[discord.ChannelType.text])
|
|
async def select_channels(self, interaction: discord.Interaction, select: ChannelSelect):
|
|
return await interaction.response.send_message(f'You selected {select.values[0].mention}')
|
|
|
|
Parameters
|
|
------------
|
|
cls: Union[Type[:class:`discord.ui.Select`], Type[:class:`discord.ui.UserSelect`], Type[:class:`discord.ui.RoleSelect`], \
|
|
Type[:class:`discord.ui.MentionableSelect`], Type[:class:`discord.ui.ChannelSelect`]]
|
|
The class to use for the select menu. Defaults to :class:`discord.ui.Select`. You can use other
|
|
select types to display different select menus to the user. See the table above for the different
|
|
values you can get from each select type. Subclasses work as well, however the callback in the subclass will
|
|
get overridden.
|
|
placeholder: Optional[:class:`str`]
|
|
The placeholder text that is shown if nothing is selected, if any.
|
|
Can only be up to 150 characters.
|
|
custom_id: :class:`str`
|
|
The ID of the select menu that gets received during an interaction.
|
|
It is recommended not to set this parameter to prevent conflicts.
|
|
Can only be up to 100 characters.
|
|
min_values: :class:`int`
|
|
The minimum number of items that must be chosen for this select menu.
|
|
Defaults to 1 and must be between 0 and 25.
|
|
max_values: :class:`int`
|
|
The maximum number of items that must be chosen for this select menu.
|
|
Defaults to 1 and must be between 1 and 25.
|
|
options: List[:class:`discord.SelectOption`]
|
|
A list of options that can be selected in this menu. This can only be used with
|
|
:class:`Select` instances.
|
|
Can only contain up to 25 items.
|
|
channel_types: List[:class:`~discord.ChannelType`]
|
|
The types of channels to show in the select menu. Defaults to all channels. This can only be used
|
|
with :class:`ChannelSelect` instances.
|
|
disabled: :class:`bool`
|
|
Whether the select is disabled or not. Defaults to ``False``.
|
|
default_values: Sequence[:class:`~discord.abc.Snowflake`]
|
|
A list of objects representing the default values for the select menu. This cannot be used with regular :class:`Select` instances.
|
|
If ``cls`` is :class:`MentionableSelect` and :class:`.Object` is passed, then the type must be specified in the constructor.
|
|
Number of items must be in range of ``min_values`` and ``max_values``.
|
|
"""
|
|
|
|
def decorator(func: ItemCallbackType[BaseSelectT]) -> ItemCallbackType[BaseSelectT]:
|
|
r = _select( # type: ignore
|
|
cls=cls, # type: ignore
|
|
placeholder=placeholder,
|
|
custom_id=custom_id,
|
|
min_values=min_values,
|
|
max_values=max_values,
|
|
options=options,
|
|
channel_types=channel_types,
|
|
disabled=disabled,
|
|
default_values=default_values,
|
|
)(func)
|
|
r.__discord_ui_parent__ = self
|
|
return r
|
|
|
|
return decorator # type: ignore
|
|
|
|
@classmethod
|
|
def from_component(cls, component: ActionRowComponent) -> ActionRow:
|
|
from .view import _component_to_item
|
|
|
|
self = cls()
|
|
for cmp in component.children:
|
|
self.add_item(_component_to_item(cmp))
|
|
return self
|
|
|