"""
The MIT License (MIT)
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
import os
from typing import TYPE_CHECKING
from typing_extensions import Self
from ..components import RadioGroup as RadioGroupComponent
from ..components import RadioGroupOption
from ..enums import ComponentType
from ..utils import MISSING
from .item import ModalItem
__all__ = ("RadioGroup",)
if TYPE_CHECKING:
from ..interactions import Interaction
from ..types.components import RadioGroupComponent as RadioGroupComponentPayload
[docs]
class RadioGroup(ModalItem):
"""Represents a UI Radio Group component.
.. versionadded:: 2.8
Attributes
----------
custom_id: Optional[:class:`str`]
The ID of the radio group that gets received during an interaction.
options: List[:class:`discord.RadioGroupOption`]
A list of options that can be selected from this group. Must provide between 2 and 10 options.
required: Optional[:class:`bool`]
Whether an option selection is required or not. Defaults to ``True``.
id: Optional[:class:`int`]
The radio group's ID.
"""
__item_repr_attributes__: tuple[str, ...] = (
"options",
"required",
"custom_id",
"id",
)
def __init__(
self,
*,
custom_id: str | None = None,
options: list[RadioGroupOption] | None = None,
required: bool = True,
id: int | None = None,
):
super().__init__()
if custom_id is not None and not isinstance(custom_id, str):
raise TypeError(
f"expected custom_id to be str, not {custom_id.__class__.__name__}"
)
if not isinstance(required, bool):
raise TypeError(f"required must be bool not {required.__class__.__name__}")
custom_id = os.urandom(16).hex() if custom_id is None else custom_id
self._selected_value: str | None = None
self._underlying: RadioGroupComponent = self._generate_underlying(
custom_id=custom_id,
options=[],
required=required,
id=id,
)
if options:
self.options = options
def _generate_underlying(
self,
custom_id: str | None = None,
options: list[RadioGroupOption] | None = None,
required: bool | None = None,
id: int | None = None,
) -> RadioGroupComponent:
super()._generate_underlying(RadioGroupComponent)
return RadioGroupComponent._raw_construct(
type=ComponentType.radio_group,
custom_id=custom_id or self.custom_id,
options=options if options is not None else self.options,
required=required if required is not None else self.required,
id=id or self.id,
)
@property
def custom_id(self) -> str:
"""The custom id that gets received during an interaction."""
return self.underlying.custom_id
@custom_id.setter
def custom_id(self, value: str):
if not isinstance(value, str):
raise TypeError(f"custom_id must be str not {value.__class__.__name__}")
if len(value) > 100:
raise ValueError("custom_id must be 100 characters or fewer")
self.underlying.custom_id = value
@property
def required(self) -> bool:
"""Whether an option selection is required or not. Defaults to ``True``"""
return self.underlying.required
@required.setter
def required(self, value: bool):
if not isinstance(value, bool):
raise TypeError(f"required must be bool, not {value.__class__.__name__}")
self.underlying.required = bool(value)
@property
def value(self) -> str | None:
"""The value selected by the user. May return ``None`` if this radio group is optional or has not been sent yet."""
return self._selected_value
@property
def options(self) -> list[RadioGroupOption]:
"""A list of options that can be selected in this group."""
return self.underlying.options
@options.setter
def options(self, value: list[RadioGroupOption]):
if not isinstance(value, list):
raise TypeError("options must be a list of RadioGroupOption")
if not (2 <= len(value) <= 10) and len(value) != 0:
raise ValueError("you must provide between 2 and 10 options.")
if not all(isinstance(obj, RadioGroupOption) for obj in value):
raise TypeError("all list items must subclass RadioGroupOption")
if len([o for o in value if o.default]) > 1:
raise ValueError("only 1 option can be set as default.")
self.underlying.options = value
[docs]
def add_option(
self,
*,
label: str,
value: str = MISSING,
description: str | None = None,
default: bool = False,
) -> Self:
"""Adds an option to the radio group.
To append a pre-existing :class:`discord.RadioGroupOption` use the
:meth:`append_option` method instead.
Parameters
----------
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 given, 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.
Raises
------
ValueError
The number of options exceeds 10.
"""
option = RadioGroupOption(
label=label,
value=value,
description=description,
default=default,
)
return self.append_option(option)
[docs]
def append_option(self, option: RadioGroupOption) -> Self:
"""Appends an option to the radio group.
Parameters
----------
option: :class:`discord.RadioGroupOption`
The option to append to the radio group.
Raises
------
ValueError
The number of options exceeds 10.
"""
if len(self.underlying.options) >= 10:
raise ValueError("maximum number of options already provided")
self.underlying.options.append(option)
return self
[docs]
def clear_options(self) -> Self:
"""Remove all options from the radio group."""
self.underlying.options.clear()
return self
def to_component_dict(self) -> RadioGroupComponentPayload:
return self.underlying.to_dict()
def refresh_state(self, data) -> None:
self._selected_value = data.get("value", None)
def refresh_from_modal(
self, interaction: Interaction, data: RadioGroupComponentPayload
) -> None:
return self.refresh_state(data)