""" The MIT License (MIT) Copyright (c) 2015-2021 Rapptz Copyright (c) 2021-present Pycord Development 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 from typing import TYPE_CHECKING, Any, ClassVar, TypeVar from .enums import ButtonStyle, ChannelType, ComponentType, InputTextStyle, try_enum from .partial_emoji import PartialEmoji, _EmojiTag from .utils import MISSING, get_slots if TYPE_CHECKING: from .emoji import Emoji from .types.components import ActionRow as ActionRowPayload from .types.components import ButtonComponent as ButtonComponentPayload from .types.components import Component as ComponentPayload from .types.components import InputText as InputTextComponentPayload from .types.components import SelectMenu as SelectMenuPayload from .types.components import SelectOption as SelectOptionPayload __all__ = ( "Component", "ActionRow", "Button", "SelectMenu", "SelectOption", "InputText", ) C = TypeVar("C", bound="Component") class Component: """Represents a Discord Bot UI Kit Component. Currently, the only components supported by Discord are: - :class:`ActionRow` - :class:`Button` - :class:`SelectMenu` This class is abstract and cannot be instantiated. .. versionadded:: 2.0 Attributes ---------- type: :class:`ComponentType` The type of component. """ __slots__: tuple[str, ...] = ("type",) __repr_info__: ClassVar[tuple[str, ...]] type: ComponentType def __repr__(self) -> str: attrs = " ".join(f"{key}={getattr(self, key)!r}" for key in self.__repr_info__) return f"<{self.__class__.__name__} {attrs}>" @classmethod def _raw_construct(cls: type[C], **kwargs) -> C: self: C = cls.__new__(cls) for slot in get_slots(cls): try: value = kwargs[slot] except KeyError: pass else: setattr(self, slot, value) return self def to_dict(self) -> dict[str, Any]: raise NotImplementedError class ActionRow(Component): """Represents a Discord Bot UI Kit Action Row. This is a component that holds up to 5 children components in a row. This inherits from :class:`Component`. .. versionadded:: 2.0 Attributes ---------- type: :class:`ComponentType` The type of component. children: List[:class:`Component`] The children components that this holds, if any. """ __slots__: tuple[str, ...] = ("children",) __repr_info__: ClassVar[tuple[str, ...]] = __slots__ def __init__(self, data: ComponentPayload): self.type: ComponentType = try_enum(ComponentType, data["type"]) self.children: list[Component] = [ _component_factory(d) for d in data.get("components", []) ] def to_dict(self) -> ActionRowPayload: return { "type": int(self.type), "components": [child.to_dict() for child in self.children], } # type: ignore class InputText(Component): """Represents an Input Text field from the Discord Bot UI Kit. This inherits from :class:`Component`. Attributes ---------- style: :class:`.InputTextStyle` The style of the input text field. custom_id: Optional[:class:`str`] The ID of the input text field that gets received during an interaction. label: :class:`str` The label for the input text field. placeholder: Optional[:class:`str`] The placeholder text that is shown if nothing is selected, if any. min_length: Optional[:class:`int`] The minimum number of characters that must be entered Defaults to 0 max_length: Optional[:class:`int`] The maximum number of characters that can be entered required: Optional[:class:`bool`] Whether the input text field is required or not. Defaults to `True`. value: Optional[:class:`str`] The value that has been entered in the input text field. """ __slots__: tuple[str, ...] = ( "type", "style", "custom_id", "label", "placeholder", "min_length", "max_length", "required", "value", ) __repr_info__: ClassVar[tuple[str, ...]] = __slots__ def __init__(self, data: InputTextComponentPayload): self.type = ComponentType.input_text self.style: InputTextStyle = try_enum(InputTextStyle, data["style"]) self.custom_id = data["custom_id"] self.label: str = data.get("label", None) self.placeholder: str | None = data.get("placeholder", None) self.min_length: int | None = data.get("min_length", None) self.max_length: int | None = data.get("max_length", None) self.required: bool = data.get("required", True) self.value: str | None = data.get("value", None) def to_dict(self) -> InputTextComponentPayload: payload = { "type": 4, "style": self.style.value, "label": self.label, } if self.custom_id: payload["custom_id"] = self.custom_id if self.placeholder: payload["placeholder"] = self.placeholder if self.min_length: payload["min_length"] = self.min_length if self.max_length: payload["max_length"] = self.max_length if not self.required: payload["required"] = self.required if self.value: payload["value"] = self.value return payload # type: ignore class Button(Component): """Represents a button from the Discord Bot UI Kit. This inherits from :class:`Component`. .. note:: The user constructible and usable type to create a button is :class:`discord.ui.Button` not this one. .. versionadded:: 2.0 Attributes ---------- style: :class:`.ButtonStyle` The style of the button. custom_id: Optional[:class:`str`] The ID of the button that gets received during an interaction. If this button is for a URL, it does not have a custom ID. url: Optional[:class:`str`] The URL this button sends you to. disabled: :class:`bool` Whether the button is disabled or not. label: Optional[:class:`str`] The label of the button, if any. emoji: Optional[:class:`PartialEmoji`] The emoji of the button, if available. sku_id: Optional[:class:`int`] The ID of the SKU this button refers to. """ __slots__: tuple[str, ...] = ( "style", "custom_id", "url", "disabled", "label", "emoji", "sku_id", ) __repr_info__: ClassVar[tuple[str, ...]] = __slots__ def __init__(self, data: ButtonComponentPayload): self.type: ComponentType = try_enum(ComponentType, data["type"]) self.style: ButtonStyle = try_enum(ButtonStyle, data["style"]) self.custom_id: str | None = data.get("custom_id") self.url: str | None = data.get("url") self.disabled: bool = data.get("disabled", False) self.label: str | None = data.get("label") self.emoji: PartialEmoji | None try: self.emoji = PartialEmoji.from_dict(data["emoji"]) except KeyError: self.emoji = None self.sku_id: str | None = data.get("sku_id") def to_dict(self) -> ButtonComponentPayload: payload = { "type": 2, "style": int(self.style), "label": self.label, "disabled": self.disabled, } if self.custom_id: payload["custom_id"] = self.custom_id if self.url: payload["url"] = self.url if self.emoji: payload["emoji"] = self.emoji.to_dict() if self.sku_id: payload["sku_id"] = self.sku_id return payload # type: ignore class SelectMenu(Component): """Represents a select menu from the Discord Bot UI Kit. A select menu is functionally the same as a dropdown, however on mobile it renders a bit differently. .. note:: The user constructible and usable type to create a select menu is :class:`discord.ui.Select` not this one. .. versionadded:: 2.0 .. versionchanged:: 2.3 Added support for :attr:`ComponentType.user_select`, :attr:`ComponentType.role_select`, :attr:`ComponentType.mentionable_select`, and :attr:`ComponentType.channel_select`. Attributes ---------- type: :class:`ComponentType` The select menu's type. custom_id: Optional[:class:`str`] The ID of the select menu that gets received during an interaction. placeholder: Optional[:class:`str`] The placeholder text that is shown if nothing is selected, if any. 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:`SelectOption`] A list of options that can be selected in this menu. Will be an empty list for all component types except for :attr:`ComponentType.string_select`. channel_types: List[:class:`ChannelType`] A list of channel types that can be selected. Will be an empty list for all component types except for :attr:`ComponentType.channel_select`. disabled: :class:`bool` Whether the select is disabled or not. """ __slots__: tuple[str, ...] = ( "custom_id", "placeholder", "min_values", "max_values", "options", "channel_types", "disabled", ) __repr_info__: ClassVar[tuple[str, ...]] = __slots__ def __init__(self, data: SelectMenuPayload): self.type = try_enum(ComponentType, data["type"]) self.custom_id: str = data["custom_id"] self.placeholder: str | None = data.get("placeholder") self.min_values: int = data.get("min_values", 1) self.max_values: int = data.get("max_values", 1) self.disabled: bool = data.get("disabled", False) self.options: list[SelectOption] = [ SelectOption.from_dict(option) for option in data.get("options", []) ] self.channel_types: list[ChannelType] = [ try_enum(ChannelType, ct) for ct in data.get("channel_types", []) ] def to_dict(self) -> SelectMenuPayload: payload: SelectMenuPayload = { "type": self.type.value, "custom_id": self.custom_id, "min_values": self.min_values, "max_values": self.max_values, "disabled": self.disabled, } if self.type is ComponentType.string_select: payload["options"] = [op.to_dict() for op in self.options] if self.type is ComponentType.channel_select and self.channel_types: payload["channel_types"] = [ct.value for ct in self.channel_types] if self.placeholder: payload["placeholder"] = self.placeholder return payload class SelectOption: """Represents a :class:`discord.SelectMenu`'s option. These can be created by users. .. versionadded:: 2.0 Attributes ---------- label: :class:`str` The label of the option. This is displayed to users. Can only be up to 100 characters. value: :class:`str` The value of the option. This is not displayed to users. If not provided when constructed then it defaults to the label. Can only be up to 100 characters. description: Optional[:class:`str`] An additional description of the option, if any. Can only be up to 100 characters. default: :class:`bool` Whether this option is selected by default. """ __slots__: tuple[str, ...] = ( "label", "value", "description", "_emoji", "default", ) def __init__( self, *, label: str, value: str = MISSING, description: str | None = None, emoji: str | Emoji | PartialEmoji | None = None, default: bool = False, ) -> None: if len(label) > 100: raise ValueError("label must be 100 characters or fewer") if value is not MISSING and len(value) > 100: raise ValueError("value must be 100 characters or fewer") if description is not None and len(description) > 100: raise ValueError("description must be 100 characters or fewer") self.label = label self.value = label if value is MISSING else value self.description = description self.emoji = emoji self.default = default def __repr__(self) -> str: return ( "" ) def __str__(self) -> str: base = f"{self.emoji} {self.label}" if self.emoji else self.label if self.description: return f"{base}\n{self.description}" return base @property def emoji(self) -> str | Emoji | PartialEmoji | None: """The emoji of the option, if available.""" return self._emoji @emoji.setter def emoji(self, value) -> None: if value is not None: if isinstance(value, str): value = PartialEmoji.from_str(value) elif isinstance(value, _EmojiTag): value = value._to_partial() else: raise TypeError( "expected emoji to be str, Emoji, or PartialEmoji not" f" {value.__class__}" ) self._emoji = value @classmethod def from_dict(cls, data: SelectOptionPayload) -> SelectOption: try: emoji = PartialEmoji.from_dict(data["emoji"]) except KeyError: emoji = None return cls( label=data["label"], value=data["value"], description=data.get("description"), emoji=emoji, default=data.get("default", False), ) def to_dict(self) -> SelectOptionPayload: payload: SelectOptionPayload = { "label": self.label, "value": self.value, "default": self.default, } if self.emoji: payload["emoji"] = self.emoji.to_dict() # type: ignore if self.description: payload["description"] = self.description return payload def _component_factory(data: ComponentPayload) -> Component: component_type = data["type"] if component_type == 1: return ActionRow(data) elif component_type == 2: return Button(data) # type: ignore elif component_type == 4: return InputText(data) # type: ignore elif component_type in (3, 5, 6, 7, 8): return SelectMenu(data) # type: ignore else: as_enum = try_enum(ComponentType, component_type) return Component._raw_construct(type=as_enum)