pincer.commands.components.button

Complexity

Total Complexity

1

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	Button.__post_init__()	0	2	1

# Copyright Pincer 2021-Present

Missing module docstring

# Full MIT License can be found in `LICENSE` at the project root.

from __future__ import annotations

from dataclasses import dataclass
from enum import IntEnum
from typing import TYPE_CHECKING

from ._component import _Component
from ...utils.types import MISSING

if TYPE_CHECKING:
    from ...utils.types import APINullable
    from ...objects.message.emoji import Emoji


class ButtonStyle(IntEnum):
    """Buttons come in a variety of styles to convey different types of actions.
    These styles also define what fields are valid for a button.

    Attributes
    ----------
    Primary:
        - color: blurple
        - required_field: custom_id
    Secondary:
        - color: gray
        - required_field: custom_id
    Success:
        - color: green
        - required_field: custom_id
    Danger:
        - color: red
        - required_field: custom_id
    Link:
        - color: gray, navigates to a URL
        - required_field: url
    """
    PRIMARY = 1
    SECONDARY = 2
    SUCCESS = 3
    DANGER = 4
    LINK = 5


@dataclass(repr=False)
class Button(_Component):
    """Represents a Discord Button object.
    Buttons are interactive components that render on messages.

    They can be clicked by users,
    and send an interaction to your app when clicked.

    Attributes
    ----------
    style: :class:`~pincer.commands.components.button.ButtonStyle`
        One of button styles. Use :class:`~pincer.commands.components.button.LinkButton`
        if you need the ``LINK`` style.
    label: APINullable[:class:`str`]
        text that appears on the button, max 80 characters
    emoji: APINullable[:class:`~pincer.objects.message.emoji.Emoji`]
        ``name``, ``id``, and ``animated``
    custom_id: APINullable[:class:`str`]
        A developer-defined identifier for the button,
        max 100 characters
    disabled: APINullable[:class:`bool`]
        Whether the button is disabled |default| :data:`False`
    """
    custom_id: APINullable[str]
    label: APINullable[str]
    style: ButtonStyle

    emoji: APINullable[Emoji] = MISSING
    disabled: APINullable[bool] = False

    type: int = 2

    def __post_init__(self):
        self.type = 2


@dataclass(repr=False)
class LinkButton(_Component):
    """
    Represents Button message component with a link.

    Attributes
    ----------
    label: APINullable[:class:`str`]
        text that appears on the button, max 80 characters
    emoji: APINullable[:class:`~pincer.objects.message.emoji.Emoji`]
        ``name``, ``id``, and ``animated``
    custom_id: APINullable[:class:`str`]
        A developer-defined identifier for the button,
        max 100 characters
    url: APINullable[:class:`str`]
        A url for link-style buttons
    disabled: APINullable[:class:`bool`]
        Whether the button is disabled (default `False`)
    """

    label: str
    url: str

    emoji: APINullable[Emoji] = MISSING
    disabled: APINullable[bool] = False

    type: int = 2
    style: ButtonStyle = ButtonStyle.LINK