Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add defaults for auto-populated selects #1804

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add defaults for auto-populated selects #1804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17ea0e5
Add defaults for auto-populated selects
hypergonial Jan 5, 2024
affb6f9
Add fragments
hypergonial Jan 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/1804.feature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add `default_values` to autopopulating select menus
1 change: 1 addition & 0 deletions changes/1804.removal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Deprecate `hikari.api.MessageActionRowBuilder.add_select_menu()`
258 changes: 257 additions & 1 deletion hikari/api/special_endpoints.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@
"InteractionModalBuilder",
"MessageActionRowBuilder",
"ModalActionRowBuilder",
"SelectDefaultBuilder",
"AutoPopulatedSelectMenuBuilder",
"UserSelectMenuBuilder",
"RoleSelectMenuBuilder",
"MentionableSelectMenuBuilder",
)

import abc
Expand Down Expand Up @@ -1586,6 +1591,62 @@ def build(self) -> typing.MutableMapping[str, typing.Any]:
"""


class SelectDefaultBuilder(abc.ABC, typing.Generic[components_.DefaultT]):
"""Represents a default value for an auto-populated select."""

__slots__: typing.Sequence[str] = ()

@property
@abc.abstractmethod
def id(self) -> snowflakes.Snowflake:
"""The Snowflake ID of the default."""

@property
@abc.abstractmethod
def type(self) -> components_.DefaultT:
"""The type of the default."""

@abc.abstractmethod
def set_id(self, id_: snowflakes.Snowflakeish, /) -> Self:
"""Set the ID of the default.

Parameters
----------
id_ : hikari.snowflakes.Snowflakeish
The ID to set.

Returns
-------
SelectDefaultBuilder
The builder object to enable chained calls.
"""

@abc.abstractmethod
def set_type(self, type_: components_.DefaultT, /) -> Self:
"""Set the type of the default.

Parameters
----------
type_ : hikari.interactions.commands.SelectDefaultType
The type to set.

Returns
-------
SelectDefaultBuilder
The builder object to enable chained calls.
"""

@abc.abstractmethod
def build(self) -> typing.MutableMapping[str, typing.Any]:
"""Build a JSON object from this builder.

Returns
-------
typing.MutableMapping[str, typing.Any]
The built json object representation of this builder.
"""


class SelectMenuBuilder(ComponentBuilder, abc.ABC):
"""Builder class for a select menu."""

Expand Down Expand Up @@ -1763,7 +1824,37 @@ def add_option(
"""


class ChannelSelectMenuBuilder(SelectMenuBuilder, abc.ABC):
class AutoPopulatedSelectMenuBuilder(SelectMenuBuilder, abc.ABC, typing.Generic[components_.DefaultT]):
"""Builder class for an auto-populated select menu."""

__slots__: typing.Sequence[str] = ()

@property
@abc.abstractmethod
def default_values(self) -> undefined.UndefinedOr[typing.Sequence[SelectDefaultBuilder[components_.DefaultT]]]:
"""Sequence of the default values set for this select menu."""

@abc.abstractmethod
def add_default_value(self, id: snowflakes.Snowflakeish, *, type: components_.DefaultT) -> Self:
"""Add a default value to this menu.

Parameters
----------
value : _OptionT
The ID of the option to add as a default value.
type : components_.DefaultT
The type of default value to add.

Returns
-------
AutoPopulatedSelectMenuBuilder
The select menu builder to enable call chaining.
"""


class ChannelSelectMenuBuilder(
AutoPopulatedSelectMenuBuilder[typing.Literal[components_.SelectDefaultType.CHANNEL]], abc.ABC
):
"""Builder class for a channel select menu."""

__slots__: typing.Sequence[str] = ()
Expand All @@ -1789,6 +1880,35 @@ def set_channel_types(self, value: typing.Sequence[channels.ChannelType], /) ->
"""


class RoleSelectMenuBuilder(
AutoPopulatedSelectMenuBuilder[typing.Literal[components_.SelectDefaultType.ROLE]], abc.ABC
):
"""Builder class for a role select menu."""

__slots__: typing.Sequence[str] = ()


class UserSelectMenuBuilder(
AutoPopulatedSelectMenuBuilder[typing.Literal[components_.SelectDefaultType.USER]], abc.ABC
):
"""Builder class for a user select menu."""

__slots__: typing.Sequence[str] = ()


class MentionableSelectMenuBuilder(
AutoPopulatedSelectMenuBuilder[
typing.Union[
typing.Literal[components_.SelectDefaultType.ROLE], typing.Literal[components_.SelectDefaultType.USER]
]
],
abc.ABC,
):
"""Builder class for a mentionable select menu."""

__slots__: typing.Sequence[str] = ()


class TextInputBuilder(ComponentBuilder, abc.ABC):
"""Builder class for text inputs components."""

Expand Down Expand Up @@ -2068,6 +2188,7 @@ def add_link_button(
The action row builder to enable chained calls.
"""

# TODO: Remove in 2.0.0.dev126
@abc.abstractmethod
def add_select_menu(
self,
Expand All @@ -2086,6 +2207,10 @@ def add_select_menu(
`MessageActionRowBuilder.add_channel_menu` and
`MessageActionRowBuilder.add_text_menu`.

.. deprecated:: 2.0.0.dev123
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just leaving this here as a note that these versions have to be bumped before this is merged

Use the `add_*_menu()` method specific to the given select type instead.
This method will be removed in 2.0.0.dev126.

Parameters
----------
type_ : typing.Union[hikari.components.ComponentType, int]
Expand Down Expand Up @@ -2113,6 +2238,131 @@ def add_select_menu(
If an invalid select menu type is passed.
"""

@abc.abstractmethod
def add_role_menu(
self,
custom_id: str,
/,
*,
placeholder: undefined.UndefinedOr[str] = undefined.UNDEFINED,
min_values: int = 0,
max_values: int = 1,
is_disabled: bool = False,
default_values: undefined.UndefinedOr[
typing.Sequence[SelectDefaultBuilder[typing.Literal[components_.SelectDefaultType.ROLE]]]
] = undefined.UNDEFINED,
) -> Self:
"""Add a role select menu component to this action row builder.

Parameters
----------
custom_id : str
A developer-defined custom identifier used to identify which menu
triggered component interactions.
placeholder : hikari.undefined.UndefinedOr[str]
Placeholder text to show when no entries have been selected.
min_values : int
The minimum amount of entries which need to be selected.
max_values : int
The maximum amount of entries which can be selected.
is_disabled : bool
Whether this select menu should be marked as disabled.
default_values :
hikari.undefined.UndefinedOr[hikari.api.SelectDefaultBuilder[typing.Literal[hikari.components.SelectDefaultType.ROLE]]]
The default values for this menu.

Returns
-------
Self
The action row builder to enable chained calls.
"""

@abc.abstractmethod
def add_user_menu(
self,
custom_id: str,
/,
*,
placeholder: undefined.UndefinedOr[str] = undefined.UNDEFINED,
min_values: int = 0,
max_values: int = 1,
is_disabled: bool = False,
default_values: undefined.UndefinedOr[
typing.Sequence[SelectDefaultBuilder[typing.Literal[components_.SelectDefaultType.USER]]]
] = undefined.UNDEFINED,
) -> Self:
"""Add a user select menu component to this action row builder.

Parameters
----------
custom_id : str
A developer-defined custom identifier used to identify which menu
triggered component interactions.
placeholder : hikari.undefined.UndefinedOr[str]
Placeholder text to show when no entries have been selected.
min_values : int
The minimum amount of entries which need to be selected.
max_values : int
The maximum amount of entries which can be selected.
is_disabled : bool
Whether this select menu should be marked as disabled.
default_values :
hikari.undefined.UndefinedOr[hikari.api.SelectDefaultBuilder[typing.Literal[hikari.components.SelectDefaultType.USER]]]
The default values for this menu.

Returns
-------
Self
The action row builder to enable chained calls.
"""

@abc.abstractmethod
def add_mentionable_menu(
self,
custom_id: str,
/,
*,
placeholder: undefined.UndefinedOr[str] = undefined.UNDEFINED,
min_values: int = 0,
max_values: int = 1,
is_disabled: bool = False,
default_values: undefined.UndefinedOr[
typing.Sequence[
SelectDefaultBuilder[
typing.Literal[components_.SelectDefaultType.USER, components_.SelectDefaultType.ROLE],
]
]
] = undefined.UNDEFINED,
) -> Self:
"""Add a mentionable select menu component to this action row builder.

Parameters
----------
custom_id : str
A developer-defined custom identifier used to identify which menu
triggered component interactions.
placeholder : hikari.undefined.UndefinedOr[str]
Placeholder text to show when no entries have been selected.
min_values : int
The minimum amount of entries which need to be selected.
max_values : int
The maximum amount of entries which can be selected.
is_disabled : bool
Whether this select menu should be marked as disabled.
default_values :
hikari.undefined.UndefinedOr[
hikari.api.SelectDefaultBuilder[
typing.Literal[hikari.components.SelectDefaultType.USER, hikari.components.SelectDefaultType.ROLE]
]
]
The default values for this menu.

Returns
-------
Self
The action row builder to enable chained calls.
"""

@abc.abstractmethod
def add_channel_menu(
self,
Expand All @@ -2124,6 +2374,9 @@ def add_channel_menu(
min_values: int = 0,
max_values: int = 1,
is_disabled: bool = False,
default_values: undefined.UndefinedOr[
typing.Sequence[SelectDefaultBuilder[typing.Literal[components_.SelectDefaultType.CHANNEL],]]
] = undefined.UNDEFINED,
) -> Self:
"""Add a channel select menu component to this action row builder.

Expand All @@ -2145,6 +2398,9 @@ def add_channel_menu(
The maximum amount of entries which can be selected.
is_disabled : bool
Whether this select menu should be marked as disabled.
default_values :
hikari.undefined.UndefinedOr[hikari.api.SelectDefaultBuilder[typing.Literal[hikari.components.SelectDefaultType.CHANNEL]]]
The default values for this menu.

Returns
-------
Expand Down
Loading