Source code for discord.ui.view

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.


from __future__ import annotations

import asyncio
import os
import sys
import time
import traceback
from functools import partial
from itertools import groupby
from typing import TYPE_CHECKING, Any, Callable, ClassVar, Iterator, Sequence

from ..components import ActionRow as ActionRowComponent
from ..components import Button as ButtonComponent
from ..components import Component
from ..components import SelectMenu as SelectComponent
from ..components import _component_factory
from ..utils import get
from .item import Item, ItemCallbackType

__all__ = ("View",)

    from ..interactions import Interaction, InteractionMessage
    from ..message import Message
    from ..state import ConnectionState
    from ..types.components import Component as ComponentPayload

def _walk_all_components(components: list[Component]) -> Iterator[Component]:
    for item in components:
        if isinstance(item, ActionRowComponent):
            yield from item.children
            yield item

def _component_to_item(component: Component) -> Item:
    if isinstance(component, ButtonComponent):
        from .button import Button

        return Button.from_component(component)
    if isinstance(component, SelectComponent):
        from .select import Select

        return Select.from_component(component)
    return Item.from_component(component)

class _ViewWeights:
    __slots__ = ("weights",)

    def __init__(self, children: list[Item]):
        self.weights: list[int] = [0, 0, 0, 0, 0]

        key = lambda i: sys.maxsize if i.row is None else i.row
        children = sorted(children, key=key)
        for row, group in groupby(children, key=key):
            for item in group:

    def find_open_space(self, item: Item) -> int:
        for index, weight in enumerate(self.weights):
            if weight + item.width <= 5:
                return index

        raise ValueError("could not find open space for item")

    def add_item(self, item: Item) -> None:
        if item.row is not None:
            total = self.weights[item.row] + item.width
            if total > 5:
                raise ValueError(
                    f"item would not fit at row {item.row} ({total} > 5 width)"
            self.weights[item.row] = total
            item._rendered_row = item.row
            index = self.find_open_space(item)
            self.weights[index] += item.width
            item._rendered_row = index

    def remove_item(self, item: Item) -> None:
        if item._rendered_row is not None:
            self.weights[item._rendered_row] -= item.width
            item._rendered_row = None

    def clear(self) -> None:
        self.weights = [0, 0, 0, 0, 0]

[docs]class View: """Represents a UI view. This object must be inherited to create a UI within Discord. .. versionadded:: 2.0 Parameters ---------- *items: :class:`Item` The initial items attached to this view. timeout: Optional[:class:`float`] Timeout in seconds from last interaction with the UI before no longer accepting input. If ``None`` then there is no timeout. Attributes ---------- timeout: Optional[:class:`float`] Timeout from last interaction with the UI before no longer accepting input. If ``None`` then there is no timeout. children: List[:class:`Item`] The list of children attached to this view. disable_on_timeout: :class:`bool` Whether to disable the view when the timeout is reached. Defaults to ``False``. message: Optional[:class:`.Message`] The message that this view is attached to. If ``None`` then the view has not been sent with a message. """ __discord_ui_view__: ClassVar[bool] = True __view_children_items__: ClassVar[list[ItemCallbackType]] = [] def __init_subclass__(cls) -> None: children: list[ItemCallbackType] = [] for base in reversed(cls.__mro__): for member in base.__dict__.values(): if hasattr(member, "__discord_ui_model_type__"): children.append(member) if len(children) > 25: raise TypeError("View cannot have more than 25 children") cls.__view_children_items__ = children def __init__( self, *items: Item, timeout: float | None = 180.0, disable_on_timeout: bool = False, ): self.timeout = timeout self.disable_on_timeout = disable_on_timeout self.children: list[Item] = [] for func in self.__view_children_items__: item: Item = func.__discord_ui_model_type__( **func.__discord_ui_model_kwargs__ ) item.callback = partial(func, self, item) item._view = self setattr(self, func.__name__, item) self.children.append(item) self.__weights = _ViewWeights(self.children) for item in items: self.add_item(item) loop = asyncio.get_running_loop() str = os.urandom(16).hex() self.__cancel_callback: Callable[[View], None] | None = None self.__timeout_expiry: float | None = None self.__timeout_task: asyncio.Task[None] | None = None self.__stopped: asyncio.Future[bool] = loop.create_future() self._message: Message | InteractionMessage | None = None def __repr__(self) -> str: return f"<{self.__class__.__name__} timeout={self.timeout} children={len(self.children)}>" async def __timeout_task_impl(self) -> None: while True: # Guard just in case someone changes the value of the timeout at runtime if self.timeout is None: return if self.__timeout_expiry is None: return self._dispatch_timeout() # Check if we've elapsed our currently set timeout now = time.monotonic() if now >= self.__timeout_expiry: return self._dispatch_timeout() # Wait N seconds to see if timeout data has been refreshed await asyncio.sleep(self.__timeout_expiry - now) def to_components(self) -> list[dict[str, Any]]: def key(item: Item) -> int: return item._rendered_row or 0 children = sorted(self.children, key=key) components: list[dict[str, Any]] = [] for _, group in groupby(children, key=key): children = [item.to_component_dict() for item in group] if not children: continue components.append( { "type": 1, "components": children, } ) return components
[docs] @classmethod def from_message( cls, message: Message, /, *, timeout: float | None = 180.0 ) -> View: """Converts a message's components into a :class:`View`. The :attr:`.Message.components` of a message are read-only and separate types from those in the ``discord.ui`` namespace. In order to modify and edit message components they must be converted into a :class:`View` first. Parameters ---------- message: :class:`.Message` The message with components to convert into a view. timeout: Optional[:class:`float`] The timeout of the converted view. Returns ------- :class:`View` The converted view. This always returns a :class:`View` and not one of its subclasses. """ view = View(timeout=timeout) for component in _walk_all_components(message.components): view.add_item(_component_to_item(component)) return view
@property def _expires_at(self) -> float | None: if self.timeout: return time.monotonic() + self.timeout return None
[docs] def add_item(self, item: Item) -> None: """Adds an item to the view. Parameters ---------- item: :class:`Item` The item to add to the view. Raises ------ TypeError An :class:`Item` was not passed. ValueError Maximum number of children has been exceeded (25) or the row the item is trying to be added to is full. """ if len(self.children) > 25: raise ValueError("maximum number of children exceeded") if not isinstance(item, Item): raise TypeError(f"expected Item not {item.__class__!r}") self.__weights.add_item(item) item._view = self self.children.append(item)
[docs] def remove_item(self, item: Item) -> None: """Removes an item from the view. Parameters ---------- item: :class:`Item` The item to remove from the view. """ try: self.children.remove(item) except ValueError: pass else: self.__weights.remove_item(item)
[docs] def clear_items(self) -> None: """Removes all items from the view.""" self.children.clear() self.__weights.clear()
[docs] def get_item(self, custom_id: str) -> Item | None: """Get an item from the view with the given custom ID. Alias for `utils.get(view.children, custom_id=custom_id)`. Parameters ---------- custom_id: :class:`str` The custom_id of the item to get Returns ------- Optional[:class:`Item`] The item with the matching ``custom_id`` if it exists. """ return get(self.children, custom_id=custom_id)
[docs] async def interaction_check(self, interaction: Interaction) -> bool: """|coro| A callback that is called when an interaction happens within the view that checks whether the view should process item callbacks for the interaction. This is useful to override if, for example, you want to ensure that the interaction author is a given user. The default implementation of this returns ``True``. If this returns ``False``, :meth:`on_check_failure` is called. .. note:: If an exception occurs within the body then the check is considered a failure and :meth:`on_error` is called. Parameters ---------- interaction: :class:`~discord.Interaction` The interaction that occurred. Returns ------- :class:`bool` Whether the view children's callbacks should be called. """ return True
[docs] async def on_timeout(self) -> None: """|coro| A callback that is called when a view's timeout elapses without being explicitly stopped. """ if self.disable_on_timeout: if self._message: self.disable_all_items() await self._message.edit(view=self)
[docs] async def on_check_failure(self, interaction: Interaction) -> None: """|coro| A callback that is called when a :meth:`View.interaction_check` returns ``False``. This can be used to send a response when a check failure occurs. Parameters ---------- interaction: :class:`~discord.Interaction` The interaction that occurred. """
[docs] async def on_error( self, error: Exception, item: Item, interaction: Interaction ) -> None: """|coro| A callback that is called when an item's callback or :meth:`interaction_check` fails with an error. The default implementation prints the traceback to stderr. Parameters ---------- error: :class:`Exception` The exception that was raised. item: :class:`Item` The item that failed the dispatch. interaction: :class:`~discord.Interaction` The interaction that led to the failure. """ print(f"Ignoring exception in view {self} for item {item}:", file=sys.stderr) traceback.print_exception( error.__class__, error, error.__traceback__, file=sys.stderr )
async def _scheduled_task(self, item: Item, interaction: Interaction): try: if self.timeout: self.__timeout_expiry = time.monotonic() + self.timeout allow = await self.interaction_check(interaction) if not allow: return await self.on_check_failure(interaction) await item.callback(interaction) except Exception as e: return await self.on_error(e, item, interaction) def _start_listening_from_store(self, store: ViewStore) -> None: self.__cancel_callback = partial(store.remove_view) if self.timeout: loop = asyncio.get_running_loop() if self.__timeout_task is not None: self.__timeout_task.cancel() self.__timeout_expiry = time.monotonic() + self.timeout self.__timeout_task = loop.create_task(self.__timeout_task_impl()) def _dispatch_timeout(self): if self.__stopped.done(): return self.__stopped.set_result(True) asyncio.create_task( self.on_timeout(), name=f"discord-ui-view-timeout-{}" ) def _dispatch_item(self, item: Item, interaction: Interaction): if self.__stopped.done(): return asyncio.create_task( self._scheduled_task(item, interaction), name=f"discord-ui-view-dispatch-{}", ) def refresh(self, components: list[Component]): # This is pretty hacky at the moment old_state: dict[tuple[int, str], Item] = { (item.type.value, item.custom_id): item for item in self.children if item.is_dispatchable() # type: ignore } children: list[Item] = [ item for item in self.children if not item.is_dispatchable() ] for component in _walk_all_components(components): try: older = old_state[(component.type.value, component.custom_id)] # type: ignore except (KeyError, AttributeError): item = _component_to_item(component) if not item.is_dispatchable(): continue children.append(item) else: older.refresh_component(component) children.append(older) self.children = children
[docs] def stop(self) -> None: """Stops listening to interaction events from this view. This operation cannot be undone. """ if not self.__stopped.done(): self.__stopped.set_result(False) self.__timeout_expiry = None if self.__timeout_task is not None: self.__timeout_task.cancel() self.__timeout_task = None if self.__cancel_callback: self.__cancel_callback(self) self.__cancel_callback = None
[docs] def is_finished(self) -> bool: """Whether the view has finished interacting.""" return self.__stopped.done()
[docs] def is_dispatching(self) -> bool: """Whether the view has been added for dispatching purposes.""" return self.__cancel_callback is not None
[docs] def is_persistent(self) -> bool: """Whether the view is set up as persistent. A persistent view has all their components with a set ``custom_id`` and a :attr:`timeout` set to ``None``. """ return self.timeout is None and all( item.is_persistent() for item in self.children )
[docs] async def wait(self) -> bool: """Waits until the view has finished interacting. A view is considered finished when :meth:`stop` is called, or it times out. Returns ------- :class:`bool` If ``True``, then the view timed out. If ``False`` then the view finished normally. """ return await self.__stopped
[docs] def disable_all_items(self, *, exclusions: list[Item] | None = None) -> None: """ Disables all items in the view. Parameters ---------- exclusions: Optional[List[:class:`Item`]] A list of items in `self.children` to not disable from the view. """ for child in self.children: if exclusions is None or child not in exclusions: child.disabled = True
[docs] def enable_all_items(self, *, exclusions: list[Item] | None = None) -> None: """ Enables all items in the view. Parameters ---------- exclusions: Optional[List[:class:`Item`]] A list of items in `self.children` to not enable from the view. """ for child in self.children: if exclusions is None or child not in exclusions: child.disabled = False
@property def message(self): return self._message @message.setter def message(self, value): self._message = value
class ViewStore: def __init__(self, state: ConnectionState): # (component_type, message_id, custom_id): (View, Item) self._views: dict[tuple[int, int | None, str], tuple[View, Item]] = {} # message_id: View self._synced_message_views: dict[int, View] = {} self._state: ConnectionState = state @property def persistent_views(self) -> Sequence[View]: views = { view for (_, (view, _)) in self._views.items() if view.is_persistent() } return list(views.values()) def __verify_integrity(self): to_remove: list[tuple[int, int | None, str]] = [] for k, (view, _) in self._views.items(): if view.is_finished(): to_remove.append(k) for k in to_remove: del self._views[k] def add_view(self, view: View, message_id: int | None = None): self.__verify_integrity() view._start_listening_from_store(self) for item in view.children: if item.is_dispatchable(): self._views[(item.type.value, message_id, item.custom_id)] = (view, item) # type: ignore if message_id is not None: self._synced_message_views[message_id] = view def remove_view(self, view: View): for item in view.children: if item.is_dispatchable(): self._views.pop((item.type.value, item.custom_id), None) # type: ignore for key, value in self._synced_message_views.items(): if == del self._synced_message_views[key] break def dispatch(self, component_type: int, custom_id: str, interaction: Interaction): self.__verify_integrity() message_id: int | None = interaction.message and key = (component_type, message_id, custom_id) # Fallback to None message_id searches in case a persistent view # was added without an associated message_id value = self._views.get(key) or self._views.get( (component_type, None, custom_id) ) if value is None: return view, item = value item.refresh_state(interaction) view._dispatch_item(item, interaction) def is_message_tracked(self, message_id: int): return message_id in self._synced_message_views def remove_message_tracking(self, message_id: int) -> View | None: return self._synced_message_views.pop(message_id, None) def update_from_message(self, message_id: int, components: list[ComponentPayload]): # pre-req: is_message_tracked == true view = self._synced_message_views[message_id] view.refresh([_component_factory(d) for d in components])