blord0
2 months ago
committed by
GitHub
GitHub
71 changed files with 3206 additions and 546 deletions
@ -0,0 +1,391 @@ |
|||
""" |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015-present Rapptz |
|||
|
|||
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, List, Literal, Optional, Tuple, TypeVar, Dict |
|||
|
|||
import os |
|||
|
|||
from ..utils import MISSING |
|||
from ..components import CheckboxGroupComponent, CheckboxComponent, CheckboxGroupOption |
|||
from ..enums import ComponentType |
|||
from .item import Item |
|||
|
|||
if TYPE_CHECKING: |
|||
from typing_extensions import Self |
|||
|
|||
from ..interactions import Interaction |
|||
from ..types.interactions import ( |
|||
ModalSubmitCheckboxGroupInteractionData as ModalSubmitCheckboxGroupInteractionDataPayload, |
|||
ModalSubmitCheckboxInteractionData as ModalSubmitCheckboxInteractionDataPayload, |
|||
) |
|||
from ..types.components import ( |
|||
CheckboxGroupComponent as CheckboxGroupComponentPayload, |
|||
CheckboxComponent as CheckboxComponentPayload, |
|||
) |
|||
from .view import BaseView |
|||
from ..app_commands.namespace import ResolveKey |
|||
|
|||
|
|||
# fmt: off |
|||
__all__ = ( |
|||
'CheckboxGroup', |
|||
'Checkbox', |
|||
) |
|||
# fmt: on |
|||
|
|||
V = TypeVar('V', bound='BaseView', covariant=True) |
|||
|
|||
|
|||
class CheckboxGroup(Item[V]): |
|||
"""Represents a checkbox group component within a modal. |
|||
|
|||
.. versionadded:: 2.7 |
|||
|
|||
Parameters |
|||
------------ |
|||
id: Optional[:class:`int`] |
|||
The ID of the component. This must be unique across the view. |
|||
custom_id: Optional[:class:`str`] |
|||
The custom ID of the component. |
|||
options: List[:class:`discord.CheckboxGroupOption`] |
|||
A list of options that can be selected in this checkbox group. |
|||
Can only contain up to 10 items. |
|||
max_values: Optional[:class:`int`] |
|||
The maximum number of options that can be selected in this component. |
|||
Must be between 1 and 10. Defaults to 1. |
|||
min_values: Optional[:class:`int`] |
|||
The minimum number of options that must be selected in this component. |
|||
Must be between 0 and 10. Defaults to 0. |
|||
required: :class:`bool` |
|||
Whether this component is required to be filled before submitting the modal. |
|||
Defaults to ``True``. |
|||
""" |
|||
|
|||
__item_repr_attributes__: Tuple[str, ...] = ( |
|||
'id', |
|||
'custom_id', |
|||
'options', |
|||
'required', |
|||
) |
|||
|
|||
def __init__( |
|||
self, |
|||
*, |
|||
custom_id: str = MISSING, |
|||
required: bool = True, |
|||
min_values: Optional[int] = None, |
|||
max_values: Optional[int] = None, |
|||
options: List[CheckboxGroupOption] = MISSING, |
|||
id: Optional[int] = None, |
|||
) -> None: |
|||
super().__init__() |
|||
self._provided_custom_id = custom_id is not MISSING |
|||
custom_id = os.urandom(16).hex() if custom_id is MISSING else custom_id |
|||
if not isinstance(custom_id, str): |
|||
raise TypeError(f'expected custom_id to be str not {custom_id.__class__.__name__}') |
|||
|
|||
self._underlying: CheckboxGroupComponent = CheckboxGroupComponent._raw_construct( |
|||
id=id, |
|||
custom_id=custom_id, |
|||
required=required, |
|||
options=options or [], |
|||
min_values=min_values, |
|||
max_values=max_values, |
|||
) |
|||
self.id = id |
|||
self._values: List[str] = [] |
|||
|
|||
@property |
|||
def id(self) -> Optional[int]: |
|||
"""Optional[:class:`int`]: The ID of this component.""" |
|||
return self._underlying.id |
|||
|
|||
@id.setter |
|||
def id(self, value: Optional[int]) -> None: |
|||
self._underlying.id = value |
|||
|
|||
@property |
|||
def values(self) -> List[str]: |
|||
"""List[:class:`str`]: A list of values that have been selected by the user.""" |
|||
return self._values |
|||
|
|||
@property |
|||
def custom_id(self) -> str: |
|||
""":class:`str`: The ID of the component that gets received during an interaction.""" |
|||
return self._underlying.custom_id |
|||
|
|||
@custom_id.setter |
|||
def custom_id(self, value: str) -> None: |
|||
if not isinstance(value, str): |
|||
raise TypeError('custom_id must be a str') |
|||
|
|||
self._underlying.custom_id = value |
|||
self._provided_custom_id = True |
|||
|
|||
@property |
|||
def type(self) -> Literal[ComponentType.checkbox_group]: |
|||
""":class:`.ComponentType`: The type of this component.""" |
|||
return ComponentType.checkbox_group |
|||
|
|||
@property |
|||
def options(self) -> List[CheckboxGroupOption]: |
|||
"""List[:class:`discord.CheckboxGroupOption`]: A list of options that can be selected in this menu.""" |
|||
return self._underlying.options |
|||
|
|||
@options.setter |
|||
def options(self, value: List[CheckboxGroupOption]) -> None: |
|||
if not isinstance(value, list) or not all(isinstance(obj, CheckboxGroupOption) for obj in value): |
|||
raise TypeError('options must be a list of CheckboxGroupOption') |
|||
self._underlying.options = value |
|||
|
|||
@property |
|||
def min_values(self) -> int: |
|||
""":class:`int`: The minimum number of options that must be selected before submitting the modal.""" |
|||
return self._underlying.min_values |
|||
|
|||
@min_values.setter |
|||
def min_values(self, value: int) -> None: |
|||
self._underlying.min_values = int(value) |
|||
|
|||
@property |
|||
def max_values(self) -> int: |
|||
""":class:`int`: The maximum number of options that can be selected before submitting the modal.""" |
|||
return self._underlying.max_values |
|||
|
|||
@max_values.setter |
|||
def max_values(self, value: int) -> None: |
|||
self._underlying.max_values = int(value) |
|||
|
|||
def add_option( |
|||
self, |
|||
*, |
|||
label: str, |
|||
value: str = MISSING, |
|||
description: Optional[str] = None, |
|||
default: bool = False, |
|||
) -> None: |
|||
"""Adds an option to the checkbox group. |
|||
|
|||
To append a pre-existing :class:`discord.CheckboxGroupOption` 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 = CheckboxGroupOption( |
|||
label=label, |
|||
value=value, |
|||
description=description, |
|||
default=default, |
|||
) |
|||
|
|||
self.append_option(option) |
|||
|
|||
def append_option(self, option: CheckboxGroupOption) -> None: |
|||
"""Appends an option to the checkbox group. |
|||
|
|||
Parameters |
|||
----------- |
|||
option: :class:`discord.CheckboxGroupOption` |
|||
The option to append to the checkbox group. |
|||
|
|||
Raises |
|||
------- |
|||
ValueError |
|||
The number of options exceeds 10. |
|||
""" |
|||
|
|||
if len(self._underlying.options) >= 10: |
|||
raise ValueError('maximum number of options already provided (10)') |
|||
|
|||
self._underlying.options.append(option) |
|||
|
|||
@property |
|||
def required(self) -> bool: |
|||
""":class:`bool`: Whether the component is required or not.""" |
|||
return self._underlying.required |
|||
|
|||
@required.setter |
|||
def required(self, value: bool) -> None: |
|||
self._underlying.required = bool(value) |
|||
|
|||
@property |
|||
def width(self) -> int: |
|||
return 5 |
|||
|
|||
def to_component_dict(self) -> CheckboxGroupComponentPayload: |
|||
return self._underlying.to_dict() |
|||
|
|||
def _refresh_component(self, component: CheckboxGroupComponent) -> None: |
|||
self._underlying = component |
|||
|
|||
def _handle_submit( |
|||
self, interaction: Interaction, data: ModalSubmitCheckboxGroupInteractionDataPayload, resolved: Dict[ResolveKey, Any] |
|||
) -> None: |
|||
self._values = data.get('values', []) |
|||
|
|||
@classmethod |
|||
def from_component(cls, component: CheckboxGroupComponent) -> Self: |
|||
self = cls( |
|||
id=component.id, |
|||
custom_id=component.custom_id, |
|||
options=component.options, |
|||
required=component.required, |
|||
min_values=component.min_values, |
|||
max_values=component.max_values, |
|||
) |
|||
return self |
|||
|
|||
def is_dispatchable(self) -> bool: |
|||
return False |
|||
|
|||
|
|||
class Checkbox(Item[V]): |
|||
"""Represents a checkbox component within a modal. |
|||
|
|||
.. versionadded:: 2.7 |
|||
|
|||
Parameters |
|||
------------ |
|||
id: Optional[:class:`int`] |
|||
The ID of the component. This must be unique across the view. |
|||
custom_id: Optional[:class:`str`] |
|||
The custom ID of the component. |
|||
default: :class:`bool` |
|||
Whether this checkbox is selected by default. |
|||
""" |
|||
|
|||
__item_repr_attributes__: Tuple[str, ...] = ( |
|||
'id', |
|||
'custom_id', |
|||
'default', |
|||
) |
|||
|
|||
def __init__( |
|||
self, |
|||
*, |
|||
custom_id: str = MISSING, |
|||
default: bool = False, |
|||
id: Optional[int] = None, |
|||
) -> None: |
|||
super().__init__() |
|||
self._provided_custom_id = custom_id is not MISSING |
|||
custom_id = os.urandom(16).hex() if custom_id is MISSING else custom_id |
|||
if not isinstance(custom_id, str): |
|||
raise TypeError(f'expected custom_id to be str not {custom_id.__class__.__name__}') |
|||
|
|||
self._underlying: CheckboxComponent = CheckboxComponent._raw_construct( |
|||
id=id, |
|||
custom_id=custom_id, |
|||
default=default, |
|||
) |
|||
self.id = id |
|||
self._value: bool = default |
|||
|
|||
@property |
|||
def id(self) -> Optional[int]: |
|||
"""Optional[:class:`int`]: The ID of this component.""" |
|||
return self._underlying.id |
|||
|
|||
@id.setter |
|||
def id(self, value: Optional[int]) -> None: |
|||
self._underlying.id = value |
|||
|
|||
@property |
|||
def value(self) -> bool: |
|||
""":class:`bool`: ``True`` if this checkbox was selected, otherwise ``False``.""" |
|||
return self._value |
|||
|
|||
@property |
|||
def custom_id(self) -> str: |
|||
""":class:`str`: The ID of the component that gets received during an interaction.""" |
|||
return self._underlying.custom_id |
|||
|
|||
@custom_id.setter |
|||
def custom_id(self, value: str) -> None: |
|||
if not isinstance(value, str): |
|||
raise TypeError('custom_id must be a str') |
|||
|
|||
self._underlying.custom_id = value |
|||
self._provided_custom_id = True |
|||
|
|||
@property |
|||
def type(self) -> Literal[ComponentType.checkbox]: |
|||
""":class:`.ComponentType`: The type of this component.""" |
|||
return ComponentType.checkbox |
|||
|
|||
@property |
|||
def default(self) -> bool: |
|||
""":class:`bool`: Whether this checkbox is selected by default.""" |
|||
return self._underlying.default |
|||
|
|||
@default.setter |
|||
def default(self, value: bool) -> None: |
|||
self._underlying.default = bool(value) |
|||
|
|||
@property |
|||
def width(self) -> int: |
|||
return 5 |
|||
|
|||
def to_component_dict(self) -> CheckboxComponentPayload: |
|||
return self._underlying.to_dict() |
|||
|
|||
def _refresh_component(self, component: CheckboxComponent) -> None: |
|||
self._underlying = component |
|||
|
|||
def _handle_submit( |
|||
self, interaction: Interaction, data: ModalSubmitCheckboxInteractionDataPayload, resolved: Dict[ResolveKey, Any] |
|||
) -> None: |
|||
self._value = data.get('value', False) |
|||
|
|||
@classmethod |
|||
def from_component(cls, component: CheckboxComponent) -> Self: |
|||
self = cls( |
|||
id=component.id, |
|||
custom_id=component.custom_id, |
|||
default=component.default, |
|||
) |
|||
return self |
|||
|
|||
def is_dispatchable(self) -> bool: |
|||
return False |
|||
@ -0,0 +1,199 @@ |
|||
""" |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015-present Rapptz |
|||
|
|||
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, List, Literal, Optional, Tuple, TypeVar, Dict |
|||
|
|||
import os |
|||
|
|||
from ..utils import MISSING |
|||
from ..components import FileUploadComponent |
|||
from ..enums import ComponentType |
|||
from .item import Item |
|||
|
|||
if TYPE_CHECKING: |
|||
from typing_extensions import Self |
|||
|
|||
from ..message import Attachment |
|||
from ..interactions import Interaction |
|||
from ..types.interactions import ModalSubmitTextInputInteractionData as ModalSubmitFileUploadInteractionDataPayload |
|||
from ..types.components import FileUploadComponent as FileUploadComponentPayload |
|||
from .view import BaseView |
|||
from ..app_commands.namespace import ResolveKey |
|||
|
|||
|
|||
# fmt: off |
|||
__all__ = ( |
|||
'FileUpload', |
|||
) |
|||
# fmt: on |
|||
|
|||
V = TypeVar('V', bound='BaseView', covariant=True) |
|||
|
|||
|
|||
class FileUpload(Item[V]): |
|||
"""Represents a file upload component within a modal. |
|||
|
|||
.. versionadded:: 2.7 |
|||
|
|||
Parameters |
|||
------------ |
|||
id: Optional[:class:`int`] |
|||
The ID of the component. This must be unique across the view. |
|||
custom_id: Optional[:class:`str`] |
|||
The custom ID of the file upload component. |
|||
max_values: Optional[:class:`int`] |
|||
The maximum number of files that can be uploaded in this component. |
|||
Must be between 1 and 10. Defaults to 1. |
|||
min_values: Optional[:class:`int`] |
|||
The minimum number of files that must be uploaded in this component. |
|||
Must be between 0 and 10. Defaults to 0. |
|||
required: :class:`bool` |
|||
Whether this component is required to be filled before submitting the modal. |
|||
Defaults to ``True``. |
|||
""" |
|||
|
|||
__item_repr_attributes__: Tuple[str, ...] = ( |
|||
'id', |
|||
'custom_id', |
|||
'max_values', |
|||
'min_values', |
|||
'required', |
|||
) |
|||
|
|||
def __init__( |
|||
self, |
|||
*, |
|||
custom_id: str = MISSING, |
|||
required: bool = True, |
|||
min_values: Optional[int] = None, |
|||
max_values: Optional[int] = None, |
|||
id: Optional[int] = None, |
|||
) -> None: |
|||
super().__init__() |
|||
self._provided_custom_id = custom_id is not MISSING |
|||
custom_id = os.urandom(16).hex() if custom_id is MISSING else custom_id |
|||
if not isinstance(custom_id, str): |
|||
raise TypeError(f'expected custom_id to be str not {custom_id.__class__.__name__}') |
|||
|
|||
self._underlying: FileUploadComponent = FileUploadComponent._raw_construct( |
|||
id=id, |
|||
custom_id=custom_id, |
|||
max_values=max_values, |
|||
min_values=min_values, |
|||
required=required, |
|||
) |
|||
self.id = id |
|||
self._values: List[Attachment] = [] |
|||
|
|||
@property |
|||
def id(self) -> Optional[int]: |
|||
"""Optional[:class:`int`]: The ID of this component.""" |
|||
return self._underlying.id |
|||
|
|||
@id.setter |
|||
def id(self, value: Optional[int]) -> None: |
|||
self._underlying.id = value |
|||
|
|||
@property |
|||
def values(self) -> List[Attachment]: |
|||
"""List[:class:`discord.Attachment`]: The list of attachments uploaded by the user. |
|||
|
|||
You can call :meth:`~discord.Attachment.to_file` on each attachment |
|||
to get a :class:`~discord.File` for sending. |
|||
""" |
|||
return self._values |
|||
|
|||
@property |
|||
def custom_id(self) -> str: |
|||
""":class:`str`: The ID of the component that gets received during an interaction.""" |
|||
return self._underlying.custom_id |
|||
|
|||
@custom_id.setter |
|||
def custom_id(self, value: str) -> None: |
|||
if not isinstance(value, str): |
|||
raise TypeError('custom_id must be a str') |
|||
|
|||
self._underlying.custom_id = value |
|||
self._provided_custom_id = True |
|||
|
|||
@property |
|||
def min_values(self) -> int: |
|||
""":class:`int`: The minimum number of files that must be user upload before submitting the modal.""" |
|||
return self._underlying.min_values |
|||
|
|||
@min_values.setter |
|||
def min_values(self, value: int) -> None: |
|||
self._underlying.min_values = int(value) |
|||
|
|||
@property |
|||
def max_values(self) -> int: |
|||
""":class:`int`: The maximum number of files that the user must upload before submitting the modal.""" |
|||
return self._underlying.max_values |
|||
|
|||
@max_values.setter |
|||
def max_values(self, value: int) -> None: |
|||
self._underlying.max_values = int(value) |
|||
|
|||
@property |
|||
def required(self) -> bool: |
|||
""":class:`bool`: Whether the component is required or not.""" |
|||
return self._underlying.required |
|||
|
|||
@required.setter |
|||
def required(self, value: bool) -> None: |
|||
self._underlying.required = bool(value) |
|||
|
|||
@property |
|||
def width(self) -> int: |
|||
return 5 |
|||
|
|||
def to_component_dict(self) -> FileUploadComponentPayload: |
|||
return self._underlying.to_dict() |
|||
|
|||
def _refresh_component(self, component: FileUploadComponent) -> None: |
|||
self._underlying = component |
|||
|
|||
def _handle_submit( |
|||
self, interaction: Interaction, data: ModalSubmitFileUploadInteractionDataPayload, resolved: Dict[ResolveKey, Any] |
|||
) -> None: |
|||
self._values = [v for k, v in resolved.items() if k.id in data.get('values', [])] |
|||
|
|||
@classmethod |
|||
def from_component(cls, component: FileUploadComponent) -> Self: |
|||
self = cls( |
|||
id=component.id, |
|||
custom_id=component.custom_id, |
|||
max_values=component.max_values, |
|||
min_values=component.min_values, |
|||
required=component.required, |
|||
) |
|||
return self |
|||
|
|||
@property |
|||
def type(self) -> Literal[ComponentType.file_upload]: |
|||
return self._underlying.type |
|||
|
|||
def is_dispatchable(self) -> bool: |
|||
return False |
|||
@ -0,0 +1,246 @@ |
|||
""" |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015-present Rapptz |
|||
|
|||
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, List, Literal, Optional, Tuple, TypeVar, Dict |
|||
|
|||
import os |
|||
|
|||
from ..utils import MISSING |
|||
from ..components import RadioGroupComponent, RadioGroupOption |
|||
from ..enums import ComponentType |
|||
from .item import Item |
|||
|
|||
if TYPE_CHECKING: |
|||
from typing_extensions import Self |
|||
|
|||
from ..interactions import Interaction |
|||
from ..types.interactions import ( |
|||
ModalSubmitRadioGroupInteractionData as ModalSubmitRadioGroupInteractionDataPayload, |
|||
) |
|||
from ..types.components import RadioGroupComponent as RadioGroupComponentPayload |
|||
from .view import BaseView |
|||
from ..app_commands.namespace import ResolveKey |
|||
|
|||
|
|||
# fmt: off |
|||
__all__ = ( |
|||
'RadioGroup', |
|||
) |
|||
# fmt: on |
|||
|
|||
V = TypeVar('V', bound='BaseView', covariant=True) |
|||
|
|||
|
|||
class RadioGroup(Item[V]): |
|||
"""Represents a radio group component within a modal. |
|||
|
|||
.. versionadded:: 2.7 |
|||
|
|||
Parameters |
|||
------------ |
|||
id: Optional[:class:`int`] |
|||
The ID of the component. This must be unique across the view. |
|||
custom_id: Optional[:class:`str`] |
|||
The custom ID of the component. |
|||
options: List[:class:`discord.RadioGroupOption`] |
|||
A list of options that can be selected in this radio group. |
|||
Can contain between 2 and 10 items. |
|||
required: :class:`bool` |
|||
Whether this component is required to be filled before submitting the modal. |
|||
Defaults to ``True``. |
|||
""" |
|||
|
|||
__item_repr_attributes__: Tuple[str, ...] = ( |
|||
'id', |
|||
'custom_id', |
|||
'options', |
|||
'required', |
|||
) |
|||
|
|||
def __init__( |
|||
self, |
|||
*, |
|||
custom_id: str = MISSING, |
|||
required: bool = True, |
|||
options: List[RadioGroupOption] = MISSING, |
|||
id: Optional[int] = None, |
|||
) -> None: |
|||
super().__init__() |
|||
self._provided_custom_id = custom_id is not MISSING |
|||
custom_id = os.urandom(16).hex() if custom_id is MISSING else custom_id |
|||
if not isinstance(custom_id, str): |
|||
raise TypeError(f'expected custom_id to be str not {custom_id.__class__.__name__}') |
|||
|
|||
self._underlying: RadioGroupComponent = RadioGroupComponent._raw_construct( |
|||
id=id, |
|||
custom_id=custom_id, |
|||
required=required, |
|||
options=options or [], |
|||
) |
|||
self.id = id |
|||
self._value: Optional[str] = None |
|||
|
|||
@property |
|||
def id(self) -> Optional[int]: |
|||
"""Optional[:class:`int`]: The ID of this component.""" |
|||
return self._underlying.id |
|||
|
|||
@id.setter |
|||
def id(self, value: Optional[int]) -> None: |
|||
self._underlying.id = value |
|||
|
|||
@property |
|||
def value(self) -> Optional[str]: |
|||
"""Optional[:class:`str`]: The value have been selected by the user, if any.""" |
|||
return self._value |
|||
|
|||
@property |
|||
def custom_id(self) -> str: |
|||
""":class:`str`: The ID of the component that gets received during an interaction.""" |
|||
return self._underlying.custom_id |
|||
|
|||
@custom_id.setter |
|||
def custom_id(self, value: str) -> None: |
|||
if not isinstance(value, str): |
|||
raise TypeError('custom_id must be a str') |
|||
|
|||
self._underlying.custom_id = value |
|||
self._provided_custom_id = True |
|||
|
|||
@property |
|||
def type(self) -> Literal[ComponentType.radio_group]: |
|||
""":class:`.ComponentType`: The type of this component.""" |
|||
return ComponentType.radio_group |
|||
|
|||
@property |
|||
def options(self) -> List[RadioGroupOption]: |
|||
"""List[:class:`discord.RadioGroupOption`]: A list of options that can be selected in this radio group.""" |
|||
return self._underlying.options |
|||
|
|||
@options.setter |
|||
def options(self, value: List[RadioGroupOption]) -> None: |
|||
if not isinstance(value, list) or not all(isinstance(obj, RadioGroupOption) for obj in value): |
|||
raise TypeError('options must be a list of RadioGroupOption') |
|||
|
|||
self._underlying.options = value |
|||
|
|||
def add_option( |
|||
self, |
|||
*, |
|||
label: str, |
|||
value: str = MISSING, |
|||
description: Optional[str] = None, |
|||
default: bool = False, |
|||
) -> None: |
|||
"""Adds an option to the 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, |
|||
) |
|||
|
|||
self.append_option(option) |
|||
|
|||
def append_option(self, option: RadioGroupOption) -> None: |
|||
"""Appends an option to the group. |
|||
|
|||
Parameters |
|||
----------- |
|||
option: :class:`discord.RadioGroupOption` |
|||
The option to append to the group. |
|||
|
|||
Raises |
|||
------- |
|||
ValueError |
|||
The number of options exceeds 10. |
|||
""" |
|||
|
|||
if len(self._underlying.options) >= 10: |
|||
raise ValueError('maximum number of options already provided (10)') |
|||
|
|||
self._underlying.options.append(option) |
|||
|
|||
@property |
|||
def required(self) -> bool: |
|||
""":class:`bool`: Whether the component is required or not.""" |
|||
return self._underlying.required |
|||
|
|||
@required.setter |
|||
def required(self, value: bool) -> None: |
|||
self._underlying.required = bool(value) |
|||
|
|||
@property |
|||
def width(self) -> int: |
|||
return 5 |
|||
|
|||
def to_component_dict(self) -> RadioGroupComponentPayload: |
|||
return self._underlying.to_dict() |
|||
|
|||
def _refresh_component(self, component: RadioGroupComponent) -> None: |
|||
self._underlying = component |
|||
|
|||
def _handle_submit( |
|||
self, interaction: Interaction, data: ModalSubmitRadioGroupInteractionDataPayload, resolved: Dict[ResolveKey, Any] |
|||
) -> None: |
|||
self._value = data.get('value') |
|||
|
|||
@classmethod |
|||
def from_component(cls, component: RadioGroupComponent) -> Self: |
|||
self = cls( |
|||
id=component.id, |
|||
custom_id=component.custom_id, |
|||
options=component.options, |
|||
required=component.required, |
|||
) |
|||
return self |
|||
|
|||
def is_dispatchable(self) -> bool: |
|||
return False |
|||
@ -0,0 +1,143 @@ |
|||
import discord |
|||
from discord import app_commands |
|||
|
|||
import traceback |
|||
|
|||
# The guild in which this slash command will be registered. |
|||
# It is recommended to have a test guild to separate from your "production" bot |
|||
TEST_GUILD = discord.Object(0) |
|||
# The ID of the channel where reports will be sent to |
|||
REPORTS_CHANNEL_ID = 0 |
|||
|
|||
|
|||
class MyClient(discord.Client): |
|||
# Suppress error on the User attribute being None since it fills up later |
|||
user: discord.ClientUser |
|||
|
|||
def __init__(self) -> None: |
|||
# Just default intents and a `discord.Client` instance |
|||
# We don't need a `commands.Bot` instance because we are not |
|||
# creating text-based commands. |
|||
intents = discord.Intents.default() |
|||
super().__init__(intents=intents) |
|||
|
|||
# We need an `discord.app_commands.CommandTree` instance |
|||
# to register application commands (slash commands in this case) |
|||
self.tree = app_commands.CommandTree(self) |
|||
|
|||
async def on_ready(self): |
|||
print(f'Logged in as {self.user} (ID: {self.user.id})') |
|||
print('------') |
|||
|
|||
async def setup_hook(self) -> None: |
|||
await self.tree.sync(guild=TEST_GUILD) |
|||
|
|||
|
|||
# Define a modal dialog for reporting issues or feedback |
|||
class ReportModal(discord.ui.Modal, title='Your Report'): |
|||
topic = discord.ui.Label( |
|||
text='Topic', |
|||
description='Select the topic of the report.', |
|||
component=discord.ui.Select( |
|||
placeholder='Choose a topic...', |
|||
options=[ |
|||
discord.SelectOption(label='Bug', description='Report a bug in the bot'), |
|||
discord.SelectOption(label='Feedback', description='Provide feedback or suggestions'), |
|||
discord.SelectOption(label='Feature Request', description='Request a new feature'), |
|||
discord.SelectOption(label='Performance', description='Report performance issues'), |
|||
discord.SelectOption(label='UI/UX', description='Report user interface or experience issues'), |
|||
discord.SelectOption(label='Security', description='Report security vulnerabilities'), |
|||
discord.SelectOption(label='Other', description='Other types of reports'), |
|||
], |
|||
), |
|||
) |
|||
report_title = discord.ui.Label( |
|||
text='Title', |
|||
description='A short title for the report.', |
|||
component=discord.ui.TextInput( |
|||
style=discord.TextStyle.short, |
|||
placeholder='The bot does not respond to commands', |
|||
max_length=120, |
|||
), |
|||
) |
|||
description = discord.ui.Label( |
|||
text='Description', |
|||
description='A detailed description of the report.', |
|||
component=discord.ui.TextInput( |
|||
style=discord.TextStyle.paragraph, |
|||
placeholder='When I use /ping, the bot does not respond at all. There are no error messages.', |
|||
max_length=2000, |
|||
), |
|||
) |
|||
images = discord.ui.Label( |
|||
text='Images', |
|||
description='Upload any relevant images for your report (optional).', |
|||
component=discord.ui.FileUpload( |
|||
max_values=10, |
|||
custom_id='report_images', |
|||
required=False, |
|||
), |
|||
) |
|||
footer = discord.ui.TextDisplay( |
|||
'Please ensure your report follows the server rules. Any kind of abuse will result in a ban.' |
|||
) |
|||
|
|||
def to_view(self, interaction: discord.Interaction) -> discord.ui.LayoutView: |
|||
# Tell the type checker what our components are... |
|||
assert isinstance(self.topic.component, discord.ui.Select) |
|||
assert isinstance(self.description.component, discord.ui.TextInput) |
|||
assert isinstance(self.report_title.component, discord.ui.TextInput) |
|||
assert isinstance(self.images.component, discord.ui.FileUpload) |
|||
|
|||
topic = self.topic.component.values[0] |
|||
title = self.report_title.component.value |
|||
description = self.description.component.value |
|||
files = self.images.component.values |
|||
|
|||
view = discord.ui.LayoutView() |
|||
container = discord.ui.Container() |
|||
view.add_item(container) |
|||
|
|||
container.add_item(discord.ui.TextDisplay(f'-# User Report\n## {topic}')) |
|||
|
|||
timestamp = discord.utils.format_dt(interaction.created_at, 'F') |
|||
footer = discord.ui.TextDisplay(f'-# Reported by {interaction.user} (ID: {interaction.user.id}) | {timestamp}') |
|||
|
|||
container.add_item(discord.ui.TextDisplay(f'### {title}')) |
|||
container.add_item(discord.ui.TextDisplay(f'>>> {description}')) |
|||
|
|||
if files: |
|||
gallery = discord.ui.MediaGallery() |
|||
gallery.items = [discord.MediaGalleryItem(media=attachment.url) for attachment in files] |
|||
container.add_item(gallery) |
|||
|
|||
container.add_item(footer) |
|||
return view |
|||
|
|||
async def on_submit(self, interaction: discord.Interaction[MyClient]): |
|||
view = self.to_view(interaction) |
|||
|
|||
# Send the report to the designated channel |
|||
reports_channel = interaction.client.get_partial_messageable(REPORTS_CHANNEL_ID) |
|||
await reports_channel.send(view=view) |
|||
await interaction.response.send_message('Thank you for your report! We will look into it shortly.', ephemeral=True) |
|||
|
|||
async def on_error(self, interaction: discord.Interaction, error: Exception) -> None: |
|||
await interaction.response.send_message('Oops! Something went wrong.', ephemeral=True) |
|||
|
|||
# Make sure we know what the error actually is |
|||
traceback.print_exception(type(error), error, error.__traceback__) |
|||
|
|||
|
|||
client = MyClient() |
|||
|
|||
|
|||
@client.tree.command(guild=TEST_GUILD, description='Report an issue or provide feedback.') |
|||
async def report(interaction: discord.Interaction): |
|||
# Send the modal with an instance of our `ReportModal` class |
|||
# Since modals require an interaction, they cannot be done as a response to a text command. |
|||
# They can only be done as a response to either an application command or a button press. |
|||
await interaction.response.send_modal(ReportModal()) |
|||
|
|||
|
|||
client.run('token') |
|||
Loading…
Reference in new issue