"""
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, Iterator, TypeVar
from .asset import AssetMixin
from .colour import Colour
from .enums import (
ButtonStyle,
ChannelType,
ComponentType,
InputTextStyle,
SeparatorSpacingSize,
try_enum,
)
from .flags import AttachmentFlags
from .partial_emoji import PartialEmoji, _EmojiTag
from .utils import MISSING, Undefined
from .utils.private import get_slots
if TYPE_CHECKING:
from .emoji import AppEmoji, GuildEmoji
from .types.components import ActionRow as ActionRowPayload
from .types.components import BaseComponent as BaseComponentPayload
from .types.components import ButtonComponent as ButtonComponentPayload
from .types.components import Component as ComponentPayload
from .types.components import ContainerComponent as ContainerComponentPayload
from .types.components import FileComponent as FileComponentPayload
from .types.components import InputText as InputTextComponentPayload
from .types.components import MediaGalleryComponent as MediaGalleryComponentPayload
from .types.components import MediaGalleryItem as MediaGalleryItemPayload
from .types.components import SectionComponent as SectionComponentPayload
from .types.components import SelectMenu as SelectMenuPayload
from .types.components import SelectOption as SelectOptionPayload
from .types.components import SeparatorComponent as SeparatorComponentPayload
from .types.components import TextDisplayComponent as TextDisplayComponentPayload
from .types.components import ThumbnailComponent as ThumbnailComponentPayload
from .types.components import UnfurledMediaItem as UnfurledMediaItemPayload
__all__ = (
"Component",
"ActionRow",
"Button",
"SelectMenu",
"SelectOption",
"InputText",
"Section",
"TextDisplay",
"Thumbnail",
"MediaGallery",
"MediaGalleryItem",
"UnfurledMediaItem",
"FileComponent",
"Separator",
"Container",
)
C = TypeVar("C", bound="Component")
[docs]
class Component:
"""Represents a Discord Bot UI Kit Component.
The components supported by Discord in messages are as follows:
- :class:`ActionRow`
- :class:`Button`
- :class:`SelectMenu`
- :class:`Section`
- :class:`TextDisplay`
- :class:`Thumbnail`
- :class:`MediaGallery`
- :class:`FileComponent`
- :class:`Separator`
- :class:`Container`
This class is abstract and cannot be instantiated.
.. versionadded:: 2.0
Attributes
----------
type: :class:`ComponentType`
The type of component.
id: :class:`int`
The component's ID. If not provided by the user, it is set sequentially by Discord.
The ID `0` is treated as if no ID was provided.
"""
__slots__: tuple[str, ...] = ("type", "id")
__repr_info__: ClassVar[tuple[str, ...]]
type: ComponentType
versions: tuple[int, ...]
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
[docs]
def is_v2(self) -> bool:
"""Whether this component was introduced in Components V2."""
return self.versions and 1 not in self.versions
[docs]
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__
versions: tuple[int, ...] = (1, 2)
def __init__(self, data: ComponentPayload):
self.type: ComponentType = try_enum(ComponentType, data["type"])
self.id: int = data.get("id")
self.children: list[Component] = [_component_factory(d) for d in data.get("components", [])]
@property
def width(self):
"""Return the sum of the children's widths."""
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),
"id": self.id,
"components": [child.to_dict() for child in self.children],
} # type: ignore
def walk_components(self) -> Iterator[Component]:
yield from self.children
@classmethod
def with_components(cls, *components, id=None):
return cls._raw_construct(type=ComponentType.action_row, id=id, children=[c for c in components])
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 custom 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.
id: Optional[:class:`int`]
The input text's ID.
"""
__slots__: tuple[str, ...] = (
"type",
"style",
"custom_id",
"label",
"placeholder",
"min_length",
"max_length",
"required",
"value",
"id",
)
__repr_info__: ClassVar[tuple[str, ...]] = __slots__
versions: tuple[int, ...] = (1, 2)
def __init__(self, data: InputTextComponentPayload):
self.type = ComponentType.input_text
self.id: int | None = data.get("id")
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,
"id": self.id,
"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
[docs]
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 | Undefined = MISSING,
description: str | None = None,
emoji: str | GuildEmoji | AppEmoji | 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 (
"<SelectOption"
f" label={self.label!r} value={self.value!r} description={self.description!r} "
f"emoji={self.emoji!r} default={self.default!r}>"
)
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 | GuildEmoji | AppEmoji | 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(
f"expected emoji to be str, GuildEmoji, AppEmoji, or PartialEmoji, not {value.__class__}"
)
self._emoji = value
@classmethod
def from_dict(cls, data: SelectOptionPayload) -> SelectOption:
if e := data.get("emoji"):
emoji = PartialEmoji.from_dict(e)
else:
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
[docs]
class Section(Component):
"""Represents a Section from Components V2.
This is a component that groups other components together with an additional component to the right as the accessory.
This inherits from :class:`Component`.
.. note::
This class is not useable by end-users; see :class:`discord.ui.Section` instead.
.. versionadded:: 2.7
Attributes
----------
components: List[:class:`Component`]
The components contained in this section. Currently supports :class:`TextDisplay`.
accessory: Optional[:class:`Component`]
The accessory attached to this Section. Currently supports :class:`Button` and :class:`Thumbnail`.
"""
__slots__: tuple[str, ...] = ("components", "accessory")
__repr_info__: ClassVar[tuple[str, ...]] = __slots__
versions: tuple[int, ...] = (2,)
def __init__(self, data: SectionComponentPayload, state=None):
self.type: ComponentType = try_enum(ComponentType, data["type"])
self.id: int = data.get("id")
self.components: list[Component] = [_component_factory(d, state=state) for d in data.get("components", [])]
self.accessory: Component | None = None
if _accessory := data.get("accessory"):
self.accessory = _component_factory(_accessory, state=state)
def to_dict(self) -> SectionComponentPayload:
payload = {
"type": int(self.type),
"id": self.id,
"components": [c.to_dict() for c in self.components],
}
if self.accessory:
payload["accessory"] = self.accessory.to_dict()
return payload
def walk_components(self) -> Iterator[Component]:
r = self.components
if self.accessory:
yield from r + [self.accessory]
yield from r
[docs]
class TextDisplay(Component):
"""Represents a Text Display from Components V2.
This is a component that displays text.
This inherits from :class:`Component`.
.. note::
This class is not useable by end-users; see :class:`discord.ui.TextDisplay` instead.
.. versionadded:: 2.7
Attributes
----------
content: :class:`str`
The component's text content.
"""
__slots__: tuple[str, ...] = ("content",)
__repr_info__: ClassVar[tuple[str, ...]] = __slots__
versions: tuple[int, ...] = (2,)
def __init__(self, data: TextDisplayComponentPayload):
self.type: ComponentType = try_enum(ComponentType, data["type"])
self.id: int = data.get("id")
self.content: str = data.get("content")
def to_dict(self) -> TextDisplayComponentPayload:
return {"type": int(self.type), "id": self.id, "content": self.content}
[docs]
class Thumbnail(Component):
"""Represents a Thumbnail from Components V2.
This is a component that displays media, such as images and videos.
This inherits from :class:`Component`.
.. note::
This class is not useable by end-users; see :class:`discord.ui.Thumbnail` instead.
.. versionadded:: 2.7
Attributes
----------
media: :class:`UnfurledMediaItem`
The component's underlying media object.
description: Optional[:class:`str`]
The thumbnail's description, up to 1024 characters.
spoiler: Optional[:class:`bool`]
Whether the thumbnail has the spoiler overlay.
"""
__slots__: tuple[str, ...] = (
"media",
"description",
"spoiler",
)
__repr_info__: ClassVar[tuple[str, ...]] = __slots__
versions: tuple[int, ...] = (2,)
def __init__(self, data: ThumbnailComponentPayload, state=None):
self.type: ComponentType = try_enum(ComponentType, data["type"])
self.id: int = data.get("id")
self.media: UnfurledMediaItem = (umi := data.get("media")) and UnfurledMediaItem.from_dict(umi, state=state)
self.description: str | None = data.get("description")
self.spoiler: bool | None = data.get("spoiler")
@property
def url(self) -> str:
"""Returns the URL of this thumbnail's underlying media item."""
return self.media.url
def to_dict(self) -> ThumbnailComponentPayload:
payload = {"type": int(self.type), "id": self.id, "media": self.media.to_dict()}
if self.description:
payload["description"] = self.description
if self.spoiler is not None:
payload["spoiler"] = self.spoiler
return payload
class MediaGalleryItem:
"""Represents an item used in the :class:`MediaGallery` component.
This is used as an underlying component for other media-based components such as :class:`Thumbnail`, :class:`FileComponent`, and :class:`MediaGalleryItem`.
.. versionadded:: 2.7
Attributes
----------
url: :class:`str`
The URL of this gallery item. This can either be an arbitrary URL or an ``attachment://`` URL to work with local files.
description: Optional[:class:`str`]
The gallery item's description, up to 1024 characters.
spoiler: Optional[:class:`bool`]
Whether the gallery item is a spoiler.
"""
def __init__(self, url, *, description=None, spoiler=False):
self._state = None
self.media: UnfurledMediaItem = UnfurledMediaItem(url)
self.description: str | None = description
self.spoiler: bool = spoiler
@property
def url(self) -> str:
"""Returns the URL of this gallery's underlying media item."""
return self.media.url
def is_dispatchable(self) -> bool:
return False
@classmethod
def from_dict(cls, data: MediaGalleryItemPayload, state=None) -> MediaGalleryItem:
media = (umi := data.get("media")) and UnfurledMediaItem.from_dict(umi, state=state)
description = data.get("description")
spoiler = data.get("spoiler", False)
r = cls(
url=media.url,
description=description,
spoiler=spoiler,
)
r._state = state
r.media = media
return r
def to_dict(self) -> dict[str, Any]:
payload = {"media": self.media.to_dict()}
if self.description:
payload["description"] = self.description
if self.spoiler is not None:
payload["spoiler"] = self.spoiler
return payload
[docs]
class FileComponent(Component):
"""Represents a File from Components V2.
This component displays a downloadable file in a message.
This inherits from :class:`Component`.
.. note::
This class is not useable by end-users; see :class:`discord.ui.File` instead.
.. versionadded:: 2.7
Attributes
----------
file: :class:`UnfurledMediaItem`
The file's media item.
name: :class:`str`
The file's name.
size: :class:`int`
The file's size in bytes.
spoiler: Optional[:class:`bool`]
Whether the file has the spoiler overlay.
"""
__slots__: tuple[str, ...] = (
"file",
"spoiler",
"name",
"size",
)
__repr_info__: ClassVar[tuple[str, ...]] = __slots__
versions: tuple[int, ...] = (2,)
def __init__(self, data: FileComponentPayload, state=None):
self.type: ComponentType = try_enum(ComponentType, data["type"])
self.id: int = data.get("id")
self.name: str = data.get("name")
self.size: int = data.get("size")
self.file: UnfurledMediaItem = UnfurledMediaItem.from_dict(data.get("file", {}), state=state)
self.spoiler: bool | None = data.get("spoiler")
def to_dict(self) -> FileComponentPayload:
payload = {"type": int(self.type), "id": self.id, "file": self.file.to_dict()}
if self.spoiler is not None:
payload["spoiler"] = self.spoiler
return payload
[docs]
class Separator(Component):
"""Represents a Separator from Components V2.
This is a component that visually separates components.
This inherits from :class:`Component`.
.. note::
This class is not useable by end-users; see :class:`discord.ui.Separator` instead.
.. versionadded:: 2.7
Attributes
----------
divider: :class:`bool`
Whether the separator will show a horizontal line in addition to vertical spacing.
spacing: Optional[:class:`SeparatorSpacingSize`]
The separator's spacing size.
"""
__slots__: tuple[str, ...] = (
"divider",
"spacing",
)
__repr_info__: ClassVar[tuple[str, ...]] = __slots__
versions: tuple[int, ...] = (2,)
def __init__(self, data: SeparatorComponentPayload):
self.type: ComponentType = try_enum(ComponentType, data["type"])
self.id: int = data.get("id")
self.divider: bool = data.get("divider")
self.spacing: SeparatorSpacingSize = try_enum(SeparatorSpacingSize, data.get("spacing", 1))
def to_dict(self) -> SeparatorComponentPayload:
return {
"type": int(self.type),
"id": self.id,
"divider": self.divider,
"spacing": int(self.spacing),
}
[docs]
class Container(Component):
"""Represents a Container from Components V2.
This is a component that contains different :class:`Component` objects.
It may only contain:
- :class:`ActionRow`
- :class:`TextDisplay`
- :class:`Section`
- :class:`MediaGallery`
- :class:`Separator`
- :class:`FileComponent`
This inherits from :class:`Component`.
.. note::
This class is not useable by end-users; see :class:`discord.ui.Container` instead.
.. versionadded:: 2.7
Attributes
----------
components: List[:class:`Component`]
The components contained in this container.
accent_color: Optional[:class:`Colour`]
The accent color of the container.
spoiler: Optional[:class:`bool`]
Whether the entire container has the spoiler overlay.
"""
__slots__: tuple[str, ...] = (
"accent_color",
"spoiler",
"components",
)
__repr_info__: ClassVar[tuple[str, ...]] = __slots__
versions: tuple[int, ...] = (2,)
def __init__(self, data: ContainerComponentPayload, state=None):
self.type: ComponentType = try_enum(ComponentType, data["type"])
self.id: int = data.get("id")
self.accent_color: Colour | None = (c := data.get("accent_color")) and Colour(
c
) # at this point, not adding alternative spelling
self.spoiler: bool | None = data.get("spoiler")
self.components: list[Component] = [_component_factory(d, state=state) for d in data.get("components", [])]
def to_dict(self) -> ContainerComponentPayload:
payload = {
"type": int(self.type),
"id": self.id,
"components": [c.to_dict() for c in self.components],
}
if self.accent_color:
payload["accent_color"] = self.accent_color.value
if self.spoiler is not None:
payload["spoiler"] = self.spoiler
return payload
def walk_components(self) -> Iterator[Component]:
for c in self.components:
if hasattr(c, "walk_components"):
yield from c.walk_components()
else:
yield c
COMPONENT_MAPPINGS = {
1: ActionRow,
2: Button,
3: SelectMenu,
4: InputText,
5: SelectMenu,
6: SelectMenu,
7: SelectMenu,
8: SelectMenu,
9: Section,
10: TextDisplay,
11: Thumbnail,
12: MediaGallery,
13: FileComponent,
14: Separator,
17: Container,
}
STATE_COMPONENTS = (Section, Container, Thumbnail, MediaGallery, FileComponent)
def _component_factory(data: ComponentPayload, state=None) -> Component:
component_type = data["type"]
if cls := COMPONENT_MAPPINGS.get(component_type):
if issubclass(cls, STATE_COMPONENTS):
return cls(data, state=state)
else:
return cls(data)
else:
as_enum = try_enum(ComponentType, component_type)
return Component._raw_construct(type=as_enum)