feat: Support default_values for Select of type ComponentType.mentionable_select and ComponentType.channel_select #2793

doluk · 2025-05-27T16:42:21Z

Summary

Looking at https://discord.com/developers/docs/components/reference#user-select I noticed that there is support for preselecting users, channels, roles, mentionables for the non string selects. This pr adds support for this.

Information

This PR fixes an issue.
This PR adds something new (e.g. new method or parameters).
This PR is a breaking change (e.g. methods or parameters removed/renamed).
This PR is not a code change (e.g. documentation, README, typehinting,
examples, ...).

Checklist

I have searched the open pull requests for duplicates.
If code changes were made then they have been tested.
- I have updated the documentation to reflect the changes.
If type: ignore comments were used, a comment is also left explaining why.
I have updated the changelog to include these changes.

This commit expands handling of "default_values" to include objects like users, roles, channels, and threads in select menus other than string selects. It introduces type checks and conversions for these objects and ensures proper serialization to payloads.

Add support for creating SelectDefaultValue from dictionaries and improve serialization by converting default_values elements to dictionaries. Ensure consistency by using the enum value for type in payload generation.

discord/ui/select.py

Paillat-dev · 2025-05-29T07:50:18Z

discord/ui/select.py

+            raise InvalidArgument(
+                "default_values can only be set on non string selects"
+            )
+        if not isinstance(value, list):


I'm not sure about the necessity of these checks. value is already typed. Wait for other feedback.

Most of those checks are again similar to how the options work/are checked.
My argument for stricter type checking and not just relying on the typing would be the similarities to the options could lead to confusion between both and with those checks we can avoid some reports and provide a better exception

The specific checks I'm talking about are the list and all(isinstance) ones. While I feel like the other might be justified, it feels redundant to have type checks with also typed parameters. Yes, to some extent it is good to have better exceptions, but python isn't strictly typed anyways, as of itself, and it feels a little arbitrary to add them here.

@Lumabots maybe you have thoughts on this ?

discord/ui/select.py

Paillat-dev · 2025-05-29T08:13:19Z

discord/ui/select.py

+            raise InvalidArgument(
+                "default values have to be of type GuildChannel or Thread"
+            )
+        elif self.type is ComponentType.channel_select:


Maybe a dict mapping could be used for setting default_value_type

@doluk Anything about this ?

discord/ui/select.py

discord/types/components.py

discord/ui/select.py

Paillat-dev · 2025-05-29T10:48:39Z

@NeloBlivion Would this interfere with #2707 ?

JustaSqu1d

Minor changes and docs suggestions

Add this feature to the pre-existing select example.

CHANGELOG.md

discord/components.py

discord/enums.py

discord/ui/select.py

Signed-off-by: Lukas Dobler <[email protected]>

doluk · 2025-06-06T10:45:28Z

I addressed most of the review comments, the two left open are something which need a final decision on what to do. @Paillat-dev @JustaSqu1d
Hope the example I added is suitable

Paillat-dev · 2025-08-05T19:17:28Z

@doluk can you take a look at the merge conflicts ?

doluk · 2025-08-05T19:20:00Z

the component v2 merge created that, I am not sure there is an easy way out of it. I was thinking about opening another pr from the current main instead of trying to resolve the conflicts somehow

Paillat-dev · 2025-08-05T19:37:26Z

@doluk I am going to try the merge and we'll see..

Paillat-dev · 2025-08-05T19:57:00Z

@doluk I merged it but I am not sure it is all good, would you mind taking a look ?

Paillat-dev · 2025-08-05T19:57:49Z

discord/ui/select.py

        channel_types: list[ChannelType] | None = None,
        disabled: bool = False,
        row: int | None = None,
+        default_values: (


Needs to be added to the docstring

plun1331 · 2025-08-23T01:52:08Z

@doluk updates?

Lulalaby · 2025-08-23T01:53:35Z

Would be nice if either

it's being worked on by you @doluk
or taken over by one of the contributors / core team

Another upcoming feature (in a few~ish weeks) depends on that as well

DA-344

default_values should still be added to the required docstrings

DA-344 · 2025-09-01T13:55:32Z

discord/enums.py

+    Channel = "channel"
+    Role = "role"
+    User = "user"


This should follow the library style:

Suggested change

Channel = "channel"

Role = "role"

User = "user"

channel = "channel"

role = "role"

user = "user"

DA-344 · 2025-09-01T13:56:20Z

discord/components.py

+        self.id = id
+        self.type = type


type annotations

Suggested change

self.id = id

self.type = type

self.id: int = id

self.type: SelectMenuDefaultValueType = type

DA-344 · 2025-09-01T13:57:47Z

discord/ui/select.py

    max_values: int = 1,
    disabled: bool = False,
    row: int | None = None,
+    default_values: list[Member | User | Role] | None = None,


DA-344 · 2025-09-01T13:58:56Z

discord/ui/select.py

    max_values: int = 1,
    disabled: bool = False,
    row: int | None = None,
+    default_values: list[Role] | None = None,


Suggested change

default_values: list[Role] | None = None,

default_values: list[Role | SelectDefaultValue] | None = None,

DA-344 · 2025-09-01T13:59:05Z

discord/ui/select.py

    custom_id: str | None = None,
    min_values: int = 1,
    max_values: int = 1,
+    default_values: list[Member | User] | None = None,


DA-344 · 2025-09-01T14:08:56Z

discord/ui/select.py

+            elif select_type is ComponentType.role_select:
+                for r in default_values:
+                    if not isinstance(r, Role):
+                        raise ValueError(
+                            f"default_values must be a list of Role  objects, not {r.__class__.__name__}"
+                        )
+                    _default_values.append(
+                        SelectDefaultValue(
+                            id=r.id, type=SelectMenuDefaultValueType.Role
+                        )
+                    )
+            elif select_type is ComponentType.user_select:
+                for u in default_values:
+                    if not isinstance(u, (User, Member)):
+                        raise ValueError(
+                            f"default_values must be a list of User/Member objects, "
+                            f"not {u.__class__.__name__}"
+                        )
+                    _default_values.append(
+                        SelectDefaultValue(
+                            id=u.id, type=SelectMenuDefaultValueType.User
+                        )
+                    )
+            elif select_type is ComponentType.channel_select:
+                for c in default_values:
+                    if not isinstance(c, GuildChannel):
+                        raise ValueError(
+                            f"default_values must be a list of GuildChannel objects, "
+                            f"not {c.__class__.__name__}"
+                        )
+                    if channel_types and c.type not in channel_types:
+                        raise ValueError(
+                            f"default_values must be a list of channels of type {channel_types}, "
+                            f"not {c.__class__.__name__}"
+                        )
+                    _default_values.append(
+                        SelectDefaultValue(
+                            id=c.id, type=SelectMenuDefaultValueType.Channel
+                        )
+                    )
+            elif select_type is ComponentType.mentionable_select:
+                for m in default_values:
+                    if not isinstance(m, (User, Member, Role)):
+                        raise ValueError(
+                            f"default_values must be a list of User/Member/Role objects, "
+                            f"not {m.__class__.__name__}"
+                        )
+                    _default_values.append(
+                        SelectDefaultValue(
+                            id=m.id,
+                            type=(
+                                SelectMenuDefaultValueType.Role
+                                if isinstance(m, Role)
+                                else SelectMenuDefaultValueType.User
+                            ),
+                        )
+                    )


this should still allow for SelectMenuDefaultValueType instances

Suggested change

elif select_type is ComponentType.role_select:

for r in default_values:

if not isinstance(r, Role):

raise ValueError(

f"default_values must be a list of Role objects, not {r.__class__.__name__}"

)

_default_values.append(

SelectDefaultValue(

id=r.id, type=SelectMenuDefaultValueType.Role

)

)

elif select_type is ComponentType.user_select:

for u in default_values:

if not isinstance(u, (User, Member)):

raise ValueError(

f"default_values must be a list of User/Member objects, "

f"not {u.__class__.__name__}"

)

_default_values.append(

SelectDefaultValue(

id=u.id, type=SelectMenuDefaultValueType.User

)

)

elif select_type is ComponentType.channel_select:

for c in default_values:

if not isinstance(c, GuildChannel):

raise ValueError(

f"default_values must be a list of GuildChannel objects, "

f"not {c.__class__.__name__}"

)

if channel_types and c.type not in channel_types:

raise ValueError(

f"default_values must be a list of channels of type {channel_types}, "

f"not {c.__class__.__name__}"

)

_default_values.append(

SelectDefaultValue(

id=c.id, type=SelectMenuDefaultValueType.Channel

)

)

elif select_type is ComponentType.mentionable_select:

for m in default_values:

if not isinstance(m, (User, Member, Role)):

raise ValueError(

f"default_values must be a list of User/Member/Role objects, "

f"not {m.__class__.__name__}"

)

_default_values.append(

SelectDefaultValue(

id=m.id,

type=(

SelectMenuDefaultValueType.Role

if isinstance(m, Role)

else SelectMenuDefaultValueType.User

),

)

)

elif select_type is ComponentType.role_select:

for r in default_values:

if isinstance(r, Role):

_default_values.append(SelectDefaultValue(id=r.id, type=SelectMenuDefaultValueType.role))

elif isinstance(r, SelectDefaultValue) and r.type is SelectMenuDefaultValueType.role:

_default_values.append(r)

else:

raise ValueError('default_values must be a list of Role or SelectDefaultValue objects of type SelectMenuDefaultValueType.role')

elif select_type is ComponentType.user_select:

for u in default_values:

if isinstance(u, (User, Member)):

_default_values.append(SelectDefaultValue(id=u.id, type=SelectMenuDefaultValueType.user))

elif isinstance(u, SelectDefaultValue) and u.type is SelectMenuDefaultValueType.user:

_default_values.append(u)

else:

raise ValueError('default_values must be a list of User, Member, or SelectDefaultValue objects of type SelectMenuDefaultValueType.user')

elif select_type is ComponentType.channel_select:

for c in default_values:

if isinstance(c, GuildChannel):

if channel_types and c.type not in channel_types:

raise TypeError(f'default_values channel types must be any of {channel_types}')

_default_values.append(SelectDefaultValue(id=c.id, type=SelectMenuDefaultValueType.channel))

elif isinstance(c, SelectDefaultValue) and c.type is SelectMenuDefaultValueType.channel:

_default_values.append(r)

else:

raise ValueError('default_values must be a list of GuildChannel or SelectDefaultValue objects of type SelectMenuDefaultValueType.channel')

elif select_type is ComponentType.mentionable_select:

for m in default_values:

if isinstance(m, (User, Member, Role)):

_default_values.append(SelectDefaultValue(id=m.id, type=SelectMenuDefaultValueType.role if isinstance(m, Role) else SelectMenuDefaultValueType.user))

elif isinstance(m, SelectDefaultValue) and m.type in (SelectMenuDefaultValueType.role, SelectMenuDefaultValueType.user):

_default_values.append(m)

else:

raise ValueError('default_values must be a list of Role, User, Member, or SelectDefaultValue objects of type SelectMenuDefaultValueType.role or SelectMenuDefaultValueType.user')

DA-344 · 2025-09-01T14:10:45Z

discord/ui/select.py

+    def add_default_value(
+        self,
+        *,
+        default_value: User | Member | Role | GuildChannel | Thread,
+    ):


DA-344 · 2025-09-01T14:11:46Z

discord/ui/select.py

+        default_value: Union[:class:`discord.User`, :class:`discord.Member`, :class:`discord.Role`,
+        :class:`discord.abc.GuildChannel`, :class:`discord.Thread`]
+            The to be added default value


Suggested change

default_value: Union[:class:`discord.User`, :class:`discord.Member`, :class:`discord.Role`,

:class:`discord.abc.GuildChannel`, :class:`discord.Thread`]

The to be added default value

default_value: Union[:class:`discord.User`, :class:`discord.Member`, :class:`discord.Role`,

:class:`discord.abc.GuildChannel`, :class:`discord.Thread`, :class:`discord.Object`]

The to be added default value. If this is an ``Object`` instance, you must pass ``type`` if the select type is ``mentionable``.

type: :class:`discord.SelectMenuDefaultvalueType`

The default value type, required if ``default_value`` is an ``Object`` and the select type is ``mentionable``.

DA-344 · 2025-09-01T14:19:24Z

discord/ui/select.py

+        default_value_type = None
+        if self.type is ComponentType.channel_select and not isinstance(
+            default_value, (GuildChannel, Thread)
+        ):
+            raise InvalidArgument(
+                "Default values have to be of type GuildChannel or Thread with type ComponentType.channel_select"
+            )
+        elif self.type is ComponentType.channel_select:
+            default_value_type = SelectMenuDefaultValueType.Channel
+        if self.type is ComponentType.user_select and not isinstance(
+            default_value, (User, Member)
+        ):
+            raise InvalidArgument(
+                "Default values have to be of type User or Member with type ComponentType.user_select"
+            )
+        elif self.type is ComponentType.user_select:
+            default_value_type = SelectMenuDefaultValueType.User
+        if self.type is ComponentType.role_select and not isinstance(
+            default_value, Role
+        ):
+            raise InvalidArgument(
+                "Default values have to be of type Role with type ComponentType.role_select"
+            )
+        elif self.type is ComponentType.role_select:
+            default_value_type = SelectMenuDefaultValueType.Role
+        if self.type is ComponentType.mentionable_select and not isinstance(
+            default_value, (User, Member, Role)
+        ):
+            raise InvalidArgument(
+                "Default values have to be of type User, Member or Role with type ComponentType.mentionable_select"
+            )
+        elif self.type is ComponentType.mentionable_select and isinstance(
+            default_value, (User, Member)
+        ):
+            default_value_type = SelectMenuDefaultValueType.User
+        elif self.type is ComponentType.mentionable_select and isinstance(
+            default_value, Role
+        ):
+            default_value_type = SelectMenuDefaultValueType.Role
+        if default_value_type is None:
+            raise InvalidArgument(
+                "Default values have to be of type User, Member, Role or GuildChannel"
+            )
+        default_value = SelectDefaultValue(
+            id=default_value.id,
+            type=default_value_type,
+        )


a mix of what paillat said and support for passing Object instances.

Suggested change

default_value_type = None

if self.type is ComponentType.channel_select and not isinstance(

default_value, (GuildChannel, Thread)

):

raise InvalidArgument(

"Default values have to be of type GuildChannel or Thread with type ComponentType.channel_select"

)

elif self.type is ComponentType.channel_select:

default_value_type = SelectMenuDefaultValueType.Channel

if self.type is ComponentType.user_select and not isinstance(

default_value, (User, Member)

):

raise InvalidArgument(

"Default values have to be of type User or Member with type ComponentType.user_select"

)

elif self.type is ComponentType.user_select:

default_value_type = SelectMenuDefaultValueType.User

if self.type is ComponentType.role_select and not isinstance(

default_value, Role

):

raise InvalidArgument(

"Default values have to be of type Role with type ComponentType.role_select"

)

elif self.type is ComponentType.role_select:

default_value_type = SelectMenuDefaultValueType.Role

if self.type is ComponentType.mentionable_select and not isinstance(

default_value, (User, Member, Role)

):

raise InvalidArgument(

"Default values have to be of type User, Member or Role with type ComponentType.mentionable_select"

)

elif self.type is ComponentType.mentionable_select and isinstance(

default_value, (User, Member)

):

default_value_type = SelectMenuDefaultValueType.User

elif self.type is ComponentType.mentionable_select and isinstance(

default_value, Role

):

default_value_type = SelectMenuDefaultValueType.Role

if default_value_type is None:

raise InvalidArgument(

"Default values have to be of type User, Member, Role or GuildChannel"

)

default_value = SelectDefaultValue(

id=default_value.id,

type=default_value_type,

)

if self.type is ComponentType.mentionable_select and isinstance(default_value, Object) and type is MISSING:

raise ValueError('type is required when the default_value is an Object and select type is mentionable')

elif self.type is ComponentType.mentionable_select and isinstance(default_value, (Member, User)):

default_value_type = SelectMenuDefaultValueType.user

elif self.type is ComponentType.mentionable_select and isinstance(default_value, Role):

default_value_type = SelectMenuDefaultValueType.role

elif self.type is ComponentType.mentionable_select:

default_value_type = type

else:

value_mapping = {

ComponentType.role_select: SelectMenuDefaultValueType.role,

ComponentType.channel_select: SelectMenuDefaultValueType.channel,

ComponentType.user_select: SelectMenuDefaultValueType.user,

}

try:

default_value_type = value_mapping[self.type]

except KeyError:

raise ValueError(f'invalid select type: {self.type}')

default_value = SelectDefaultValue(

id=default_value.id,

type=default_value_type,

)

DA-344 · 2025-09-01T14:21:27Z

discord/ui/select.py

+from ..components import SelectDefaultValue, SelectMenu, SelectOption
 from ..emoji import AppEmoji, GuildEmoji
-from ..enums import ChannelType, ComponentType
+from ..enums import ChannelType, ComponentType, SelectMenuDefaultValueType
 from ..errors import InvalidArgument
 from ..interactions import Interaction
 from ..member import Member


The changes i've suggested require importing Object

Suggested change

from ..components import SelectDefaultValue, SelectMenu, SelectOption

from ..emoji import AppEmoji, GuildEmoji

from ..enums import ChannelType, ComponentType

from ..enums import ChannelType, ComponentType, SelectMenuDefaultValueType

from ..errors import InvalidArgument

from ..interactions import Interaction

from ..member import Member

from ..components import SelectDefaultValue, SelectMenu, SelectOption

from ..emoji import AppEmoji, GuildEmoji

from ..enums import ChannelType, ComponentType, SelectMenuDefaultValueType

from ..errors import InvalidArgument

from ..interactions import Interaction

from ..member import Member

from ..object import Object

Lulalaby · 2025-09-01T15:18:57Z

Let's do a clean new pr

doluk added 5 commits May 27, 2025 17:18

Add support for default values in non string selects

7d5f073

fix imports

b7084d1

Enhance SelectDefaultValue handling and serialization.

febb64f

Add support for creating SelectDefaultValue from dictionaries and improve serialization by converting default_values elements to dictionaries. Ensure consistency by using the enum value for type in payload generation.

Update CHANGELOG.md

edd2e70

doluk requested a review from a team as a code owner May 27, 2025 16:42

pullapprove4 bot requested a review from Middledot May 27, 2025 16:42

pullapprove4 bot added PA: All Contributors pending PA: Maintainers pending labels May 27, 2025

pre-commit-ci bot and others added 3 commits May 27, 2025 16:42

style(pre-commit): auto fixes from pre-commit.com hooks

3554673

Fix Imports type checking

2a2818f

style(pre-commit): auto fixes from pre-commit.com hooks

ca4da60

Paillat-dev requested changes May 27, 2025

View reviewed changes

discord/ui/select.py Outdated Show resolved Hide resolved

doluk and others added 2 commits May 28, 2025 09:39

Refactor if checks for default values

33cc690

style(pre-commit): auto fixes from pre-commit.com hooks

8524967

Paillat-dev requested changes May 29, 2025

View reviewed changes

discord/ui/select.py Outdated Show resolved Hide resolved

JustaSqu1d requested changes May 29, 2025

View reviewed changes

pullapprove4 bot removed the PA: All Contributors pending label May 29, 2025

doluk and others added 5 commits June 6, 2025 12:23

Merge branch 'master' into role_select_default

5894eca

Signed-off-by: Lukas Dobler <[email protected]>

Add an example usage of default values to the examples

aa7a309

Update the docs and CHANGELOG.md

2317367

Minor reformating and code cleanup

e7b8707

style(pre-commit): auto fixes from pre-commit.com hooks

cd3b261

pullapprove4 bot requested a review from plun1331 August 5, 2025 19:15

Paillat-dev self-assigned this Aug 5, 2025

Merge branch 'master' into role_select_default

4afc071

Paillat-dev requested changes Aug 5, 2025

View reviewed changes

Paillat-dev requested a review from NeloBlivion August 6, 2025 08:32

Merge branch 'master' into role_select_default

81e54b5

plun1331 requested a review from a team as a code owner August 23, 2025 04:48

Lulalaby added the on hold label Aug 30, 2025

Lulalaby force-pushed the master branch 2 times, most recently from b55c125 to 82659b2 Compare August 30, 2025 21:10

Lulalaby removed the on hold label Aug 30, 2025

Lulalaby requested a review from a team as a code owner September 1, 2025 12:31

DA-344 reviewed Sep 1, 2025

View reviewed changes

Paillat-dev assigned DA-344 and unassigned Paillat-dev Sep 1, 2025

Paillat-dev added the on hold label Sep 1, 2025

Lulalaby closed this Sep 1, 2025

DA-344 mentioned this pull request Sep 1, 2025

feat: Add support for default_values in Selects #2899

Merged

9 tasks

	default_values: list[Member \| User \| Role] \| None = None,
	default_values: list[Member \| User \| Role \| SelectDefaultValue] \| None = None,

	default_values: list[Role] \| None = None,
	default_values: list[Role \| SelectDefaultValue] \| None = None,

	default_values: list[Member \| User] \| None = None,
	default_values: list[Member \| User \| SelectDefaultValue] \| None = None,

Uh oh!

feat: Support default_values for Select of type ComponentType.mentionable_select and ComponentType.channel_select #2793

feat: Support default_values for Select of type ComponentType.mentionable_select and ComponentType.channel_select #2793

Uh oh!

Conversation

doluk commented May 27, 2025

Summary

Information

Checklist

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Paillat-dev commented May 29, 2025

Uh oh!

JustaSqu1d left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

doluk commented Jun 6, 2025

Uh oh!

Paillat-dev commented Aug 5, 2025

Uh oh!

doluk commented Aug 5, 2025

Uh oh!

Paillat-dev commented Aug 5, 2025

Uh oh!

Paillat-dev commented Aug 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

plun1331 commented Aug 23, 2025

Uh oh!

Lulalaby commented Aug 23, 2025

Uh oh!

DA-344 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment