feat: Viewless components

[Paillat-dev]

ok now that this is starting to become more concrete, here is some info:

This pull request refactors rewrites py-cord's Components and Modals interface from the ground up. discord.ui has been removed entirely and replaced by top-level classes available in discord directly.

Since View has been removed, purposefully, py-cord becomes entirely stateless, which essentially means that all "views" are now persistent.

Caution

This removes ext.pages entirely since it cannot fundamentally be updated to work with the new design.

The API works as follows:

Components Example (click to open)

def build_container(secret_message: str) -> Container:
    return Container(
        ActionRow(
            Button(
                style=ButtonStyle.primary,
                label="Click me! I'll tell you a secret",
                custom_id=f"v1:hello_button_{secret_message}",
                emoji=PartialEmoji(name="🤫"),
            )
        ),
        id=3,
    )


@bot.command()
async def secret(ctx: ApplicationContext, secret_message: str) -> None:
    await ctx.respond(
        components=[build_container(secret_message)],
    )

def hello_button_predicate(custom_id: str) -> bool:
   return custom_id.startswith("v1:hello_button_") 

@bot.component_listener(hello_button_predicate)
async def hello_button(interaction: ComponentInteraction[Button]) -> None:
    secret_message = interaction.custom_id.split("hello_button_")[1]
    await interaction.respond(
        f"Hello {interaction.user.name}! The secret message is: ||{secret_message}||", ephemeral=True
    )

If you want to understand the api in more detail, you can open the latest readthedocs build and take a look at:

• discord.Component
• discord.ComponentsSequence
• discord.Bot.component_listener
• discord.Bot.add_component_listener
• discord.Bot.remove_component_listener

You can also take a look at the diff of the CHANGELOG-V3.md file

Additionally, this implements stuff of the new discord Modals API like shown below:

Modals Example (click to open)

from discord import components
SECRET_MODAL = components.Modal(
    components.Label(
        label="Secret Message",
        component=components.TextInput(
            style=discord.TextInputStyle.long,
            custom_id="v1:secret_input",
            placeholder="Enter your secret message here...",
            required=True,
        ),
    ),
    Label(
        label="Favourite Color",
        component=components.StringSelectMenu(
            options=[
                components.SelectOption(label="Red", value="red"),
                components.SelectOption(label="Green", value="green"),
                components.SelectOption(label="Blue", value="blue"),
            ],
            required=False,
            custom_id="v1:color_select",
            min_values=1,
            max_values=1
        )
    ),
    components.Label(
        label="Your favourite user",
        description="Please select your favourite user in this server",
        component=components.UserSelectMenu(
            custom_id="v1:user_select",
            min_values=1,
            max_values=4,
            required=True,
            default_values=[components.DefaultSelectOption(856780995629154305, "user"), components.DefaultSelectOption(707196665668436019, "user")]
        )
    ),
    components.TextDisplay(
        content="By submitting this form, you acknowledge that the information provided is accurate and truthful to the best of your knowledge."
    ),
    title="Secret Message Input",
    custom_id=f"v1:secret_modal",
)


@bot.command(integration_types={components.IntegrationType.guild_install, components.IntegrationType.user_install}, context={components.InteractionContextType.guild, components.InteractionContextType.bot_dm, components.InteractionContextType.private_channel})
async def secret(ctx: discord.ApplicationContext) -> None:
    await ctx.send_modal(SECRET_MODAL)

@bot.modal_listener("v1:secret_modal")
async def hello_button(
        interaction: discord.ModalInteraction[
            components.PartialLabel[components.PartialTextInput], components.PartialLabel[components.PartialStringSelect], components.PartialLabel[components.PartialUserSelect], components.PartialTextDisplay
        ],
) -> None:
    _ = await interaction.respond(
        components=[
            components.Container(
                components.TextDisplay("## Your secret message has been received!"),
                components.TextDisplay(f"**Secret Message:** {interaction.components[0].component.value}"),
                components.TextDisplay(
                    f"**Favourite Color:** {interaction.components[1].component.values[0]}"
                ),
                components.TextDisplay(
                    f"**Favourite Users:** {', '.join([f'<@{option}>' for option in interaction.components[2].component.values])}"
                ),
            )
        ],
        allowed_mentions=AllowedMentions.none(),
    )

This also removes multiple long deprecated methods / properties from interactions.py

depends on #44
depends on #62

fixes: #11

[Copilot]

Pull Request Overview

Copilot reviewed 92 out of 93 changed files in this pull request and generated 7 comments.

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Lumabots]

comment + type strict that i'll do once those are solved

[Lumabots]

_emoji is never set, pretty sure there is some issue inside the init with self.emoji = emoji (since emoji is a property)

[Paillat-dev]

It is set when in the init it sets self.emoji, that calls the @emoji.setter which itself sets _emoji

[Lumabots]

didnt know about this behavior then its good !

[Lumabots]

id is typed as int | None however FileUploadPayload id cant be none as its a literal 19, maybe there is some thing to look for here (same for from payload etc)

[Paillat-dev]

THose are all to be ignored, id None can be sent to discord and will be handled as 0, it just will always be an int when recieved

[Lumabots]

i dont get the point of the id as from the payload it can only be 19 since its the file upload one
So why are we letting the user change it ?
(mb just realize that type is the 19, id is something else...)
And so why are we not putting it into the payload as notrequired ?

Could not access item in TypedDict
  "id" is not a required key in "FileUpload", so access may result in runtime

[Paillat-dev]

Because it is always there when we get the payload

[Lumabots]

then why not add it to the payload ?

Because it is always there when we get the payload

[Paillat-dev]

It is on BaseComponent

[Lumabots]

but shouldnt it be override since it will always be and so required?

Im thinking about something like this

class FileUpload(BaseComponent):
    id: int # Will be 0 if not provided (and not required)
    type: Literal[19]
    custom_id: str
    min_values: NotRequired[int]
    max_values: NotRequired[int]
    required: NotRequired[bool]