refactor: nextcord.Interaction subclassing #970

Gangsta-Muffin · 2023-01-09T22:13:25Z

Summary

PR for #952

Create Subclasses for nextcord.Interaction

Subclasses will include:

ApplicationCommandInteraction
Interaction object for application commands

ApplicationAutocompleteInteraction
Interaction object for slash command autocomplete

ViewInteraction
Interaction object for message components

ModalSubmitInteraction
Interaction object for Modal submits

Following object names will/may still change:

ApplicationAutocompleteInteraction
ViewInteraction to MessageComponentInteraction

Checklist (currently incomplete)

SlashApplicationInteraction (Interaction subclass)
ApplicationAutocompleteInteraction (Interaction subclass)
ViewInteraction (Interaction subclass)
ModalSubmitInteraction (Interaction subclass)
InteractionResponse subclasses
Interaction subclasses in nextcord.types.interactions

Update external Modules to use/identify correct Object
Add new subclasses to __all__ Set in interactions.py
Update docs
Update additional stuff (for example: __slots__, type hints, bugs, ...)

Final test (for bugs) - fix if necessary

Creat first classes + Create PR

class creation

* Check and Use Interaction type in Client.py * Import Interaction subclasses in Client.py * Transfer SlashApplicationInteraction specific data from Base to subclass * Copy SlashApplicationInteraction contents to ApplicationAutocompleteInteraction (use same data)

* Check and use correct Interaction type in Client.py * Add imports for Interaction subclasses in Client.py * Transfer SlashApplicationInteraction specific data from Interaction (parent class) * Transfer ApplicationAutocompleteInteraction specific data from Interaction (parent class) * Add subclass refined properties to SlashApplicationInteraction * Add subclass refined properties to ApplicationAutocompleteInteraction * Create PartialInteractionOption (will contain options data for SlashApplicationInteraction and ApplicationAutocompleteInteraction)

* Check and use correct Interaction type in Client.py * Add imports for new Interaction subclasses * Transfer SlashApplicationInteraction specific data from Interaction (parent class) * Transfer ApplicationAutocompleteInteraction specific data from Interaction (parent class) * Add properties for SlashApplicationInteraction refined data * Add properties for ApplicationAutocompleteInteraction refined data

…_subclasses

…ubclasses * Add parameters to get_interaction to support custom Interaction subclasses in Client.py * Create SlashOptionData to hold recieved SlashOptionData - to be used in Interaction classes (Interactions.py) * Rename SlashApplicationCommand subinteraction class to SlashApplicationInteraction * Add option data handling in SlashApplicationInteraction (using SlashOptionData) (new .options attribute) * Add option data handlin in ApplicationAutocompleteInteraction (using SlashOptionData) (new .options attribute) * Add ocused_option attribute to ApplicationAutocompleteInteraction (fast way to get Slashoption invoking Autocomplete)

Stop double Initialization for focused slash options - instead append the first initialization to collection list

…ubclasses * Add parameters to get_interaction to support custom Interaction subclasses in Client.py * Create SlashOptionData to hold recieved SlashOptionData - to be used in Interaction classes (Interactions.py) * Rename SlashApplicationCommand subinteraction class to SlashApplicationInteraction * Add option data handling in SlashApplicationInteraction (using SlashOptionData) (new .options attribute) * Add option data handlin in ApplicationAutocompleteInteraction (using SlashOptionData) (new .options attribute) * Add ocused_option attribute to ApplicationAutocompleteInteraction (fast way to get Slashoption invoking Autocomplete)

…subclasses * Copy Interaction.edit() method to ViewInteraction * Copy Intenteraction.edit() to ModalSubmitInteraction * Remove Interaction.edit() from Interaction * Remove .message attribute from Interaction * Add .message attribute to ViewInteraction * Add .message attribute to ModalSubmitInteraction * Add attributes for ModalSubmit refined data (ModalSubmitInteraction) * add attributes for MessageComponent refined data (ViewInteraction) * Add comments for questioning changes

* Fixed ViewInteraction.edit() method - can now also edit ephemeral messages * Fixed ModalSubmitInteraction.edit() method - can now also edit ephemeral messages Refactor: * Remove prints from testing * Add comments for future changes * Add __repr__ method to SlashOptionData class

* Add classes to __all__ (interactions.py) * removed prints from testing

…updates * Change SlashApplicationInteraction name to ApplicationCommandInteraction * Type the correct Interaction subclass in client.py * Add class Descriptions to Interaction Subclasses * Correct __slots__ in Interaction class * Ad __slots__ to Interaction subclasses * Change some attribute names to have more appropriate name

EmreTech

Two more things that I decided to leave out of individual review comments:

The rest of the library isn't typed to use these new subclasses.
It would be a lot cleaner imo if the interaction subclasses were split into multiple files under an interactions folder. This also includes the base interaction class.

FYI, some of the review comments I specifically made on ApplicationCommandInteraction apply to the rest of the subclasses, I didn't want to copy all of those review comments over and over again.

nextcord/client.py

nextcord/interactions.py

MaskDuck

also i'm unsure whether should we keep documenting Interaction -- as it doesn't have any real-world usage now.

i think it's a bit breaking but fine, acceptable

nextcord/interactions.py

* Remove parent attributes from Interaction subclass descriptions (suggestion from PR comments) * Remove 'version added' in Interaction subclasses (suggestion from PR comments) * Correct spelling and punctuation in Interaction subclass descriptions (suggestion from PR comments) * ApplicationAutocompleteInteraction now inherits from ApplicationCommandInteraction * Correct list typehinting for application options list in ApplicationCommandInteraction

MaskDuck

would need to add backward compatibilities or fix pyright error
i actually prefer add backward compatibilities bcuz it would not take much time

but you also need to re-typehint the whole lib where just use interactions, thx =))

nextcord/interactions.py

…ctions folder

teaishealthy · 2023-07-26T12:32:42Z

🦅

…_subclasses

nextcord/interactions/application.py

EmreTech · 2023-09-17T23:42:16Z

nextcord/application_command.py

+
+    __slots__: Tuple[str, ...] = ("data", "value", "type", "name", "focused")
+
+    def __init__(self, data) -> None:


Please type the data parameter with ApplicationCommandInteractionDataOption.

This type doesn't exist - Are you suggesting I should make a new type for this?

nextcord/nextcord/types/interactions.py

Lines 128 to 135 in 5d2eff1

ApplicationCommandInteractionDataOption = Union[

_ApplicationCommandInteractionDataOptionString,

_ApplicationCommandInteractionDataOptionInteger,

_ApplicationCommandInteractionDataOptionSubcommand,

_ApplicationCommandInteractionDataOptionBoolean,

_ApplicationCommandInteractionDataOptionSnowflake,

_ApplicationCommandInteractionDataOptionNumber,

]

It does exist, and it's already imported in this module.

Must have missed that somehow. Either way, as part of that list, is the class _ApplicationCommandInteractionDataOptionSubcommand, which the SlashOptionData class doesn't use. (It may possibly not use Snowflake either but I can't say this for sure). Would it be worth making a new dedicated type for this? or is there some typehinting approach I can take, to reassure pyright, that this class does, indeed, not get used (other than using something like isinstance - which would be redundant since the library simply doesn't use this class for any other purpose)?

Well, it does get used to tell Pyright what keys and types of values a specific dictionary has. You could make a new union without the subcommand one, but I'm not sure what to call it.

EmreTech · 2023-09-17T23:42:22Z

nextcord/application_command.py

+    __slots__: Tuple[str, ...] = ("data", "value", "type", "name", "focused")
+
+    def __init__(self, data) -> None:
+        self.data: dict = data


nextcord/application_command.py

nextcord/interactions/application.py

EmreTech · 2023-09-18T02:04:52Z

nextcord/client.py

+
+        Warns
+        --------
+        ~FutureWarning


I don't think it's worth documenting this warning, considering that other functions throughout the library do not either.

nextcord/client.py

EmreTech · 2023-09-18T02:11:08Z

nextcord/components.py

+            if slot == "type" and getattr(self, slot, None) is not None:
+                # nextcord/issues/1103
+                continue


Wasn't this fixed by #1104?

Possibly? I haven't been keeping track on more recent PRs. Please let me know what I should do with this code, provided changes are in order :)

All that PR did when it was merged was remove "type" from the __slots__ of the Component class. As long as your fork is up to date with the upstream and you remove this code I commented on, all should be good.

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

teaishealthy · 2023-10-08T12:33:04Z

nextcord/interactions/application.py

+        self.options: List[SlashOptionData] = (
+            self._get_application_options(options) if options else []
+        )


preview is broken for some reason, but what Emre said.

Suggested change

self.options: List[SlashOptionData] = (

self._get_application_options(options) if options else []

)

options = self.data.get("options", [])

self.options: List[SlashOptionData] = (

self._get_application_options(options)

)

teaishealthy · 2023-10-08T12:35:04Z

nextcord/interactions/application.py

+    def _get_application_options(self, data):
+        options = data
+
+        if len(options) == 0:


Forgot to apply this

teaishealthy · 2023-10-08T12:37:12Z

nextcord/interactions/application.py

+            SlashOptionData,
+        )
+
+        return [SlashOptionData(option) for option in options]


pyright is not happy with this because you are changing the type of an already assigned variable.

Not sure what variable this is referring to

teaishealthy · 2023-10-08T12:40:24Z

nextcord/interactions/application.py

+        self._parent._state.store_modal(modal, self._parent.user.id)  # type: ignore
+
+
+class ApplicationAutocompleteInteraction(Interaction):


@Gangsta-Muffin ?

ooliver1

Tested. Only issues were the warning and button type error mentioned in these comments. https://paste.nextcord.dev/?id=1702153210128711

ooliver1 · 2023-12-09T19:36:22Z

nextcord/interactions/__init__.py

+nextcord.interactions
+~~~~~~~~~~~~~~~~~~


Suggested change

nextcord.interactions

~~~~~~~~~~~~~~~~~~

nextcord.interactions

~~~~~~~~~~~~~~~~~~~~~

nextcord/interactions/application.py

ooliver1 · 2023-12-09T19:39:37Z

nextcord/interactions/application.py

+        from ..application_command import (  # Importing here due to circular import issues
+            SlashOptionData,
+        )


Suggested change

from ..application_command import ( # Importing here due to circular import issues

SlashOptionData,

)

# Importing here due to circular import issues

from ..application_command import SlashOptionData

If you put the comment above, this wouldn't wrap the line like that

ooliver1 · 2023-12-09T19:40:23Z

nextcord/interactions/application.py

+            SlashOptionData,
+        )
+
+        return [SlashOptionData(option) for option in options]


Not sure what variable this is referring to

nextcord/interactions/application.py

ooliver1 · 2023-12-09T19:49:53Z

nextcord/client.py

+                return super().get_interaction(
+                    data,
+                    application_interaction=CustomApplicationCommandInteraction,
+                    application_autocomplete_interaction=CustomApplicationAutocompleteInteraction,
+                    message_component_interaction=MessageComponentInteraction,
+                    modal_submit_interaction=CustomModalSubmitInteraction,
+
+                    # If you want a custom Interaction object to fall back to if interaction type wasn't recognized:
+                    cls=CustomInteraction
+                )


Suggested change

return super().get_interaction(

data,

application_interaction=CustomApplicationCommandInteraction,

application_autocomplete_interaction=CustomApplicationAutocompleteInteraction,

message_component_interaction=MessageComponentInteraction,

modal_submit_interaction=CustomModalSubmitInteraction,

# If you want a custom Interaction object to fall back to if interaction type wasn't recognized:

cls=CustomInteraction

)

def get_interaction(self, data):

return super().get_interaction(

data,

application_interaction=CustomApplicationCommandInteraction,

application_autocomplete_interaction=CustomApplicationAutocompleteInteraction,

message_component_interaction=MessageComponentInteraction,

modal_submit_interaction=CustomModalSubmitInteraction,

# If you want a custom Interaction object to fall back to if interaction type wasn't recognized:

cls=CustomInteraction

)

ooliver1 · 2023-12-09T19:50:15Z

nextcord/client.py

+        Warns
+        --------


Suggested change

Warns

--------

Warns

-----

ooliver1 · 2023-12-09T19:57:50Z

nextcord/client.py

@@ -2068,10 +2084,14 @@ def scheduled_events(self) -> List[ScheduledEvent]:
        """
        return [event for guild in self.guilds for event in guild.scheduled_events]

-    async def on_interaction(self, interaction: Interaction) -> None:
+    async def on_interaction(


This can be all types however, process_application_commands ignores the types it doesn't want.

ooliver1 · 2023-12-09T20:05:31Z

nextcord/client.py

+            in the event that defining this parameter was a mistake, and other parameters were to be defined instead.
+        """
+        # check if they are creating custom interaction subclasses
+        if cls is not Interaction:


This warning seems a bit weird, the signature for get_interaction seems to imply you should pass a custom interaction when passing other custom interaction classes. The better check would be to look at the other classes and if none are custom, but that just seems a bit excessive IMO.

class Client(nextcord.Client): def get_interaction(self, data: InteractionPayload): return super().get_interaction( data, application_autocomplete_interaction=CustomAutocompleteInteraction, application_interaction=CustomAppCmdInteraction, message_component_interaction=CustomComponentInteraction, modal_submit_interaction=CustomModalSubmitInteraction, cls=CustomInteraction, )

ooliver1 · 2023-12-09T20:09:50Z

nextcord/ui/item.py

-from ..interactions import ClientT, Interaction
+from ..interactions.base import ClientT, Interaction
+from ..interactions.message_component import MessageComponentInteraction
+from ..interactions.modal_submit import ModalSubmitInteraction


ItemCallbackType should probably use the component interaction class not the base one:

Argument of type "(self: Self@View, button: Button[Unknown], interaction: CustomComponentInteraction) -> Coroutine[Any, Any, None]" cannot be assigned to parameter of type "ItemCallbackType[Button[V@button], ClientT@button]" Type "(self: Self@View, button: Button[Unknown], interaction: CustomComponentInteraction) -> Coroutine[Any, Any, None]" cannot be assigned to type "ItemCallbackType[Button[V@button], ClientT@button]" Parameter 3: type "Interaction[ClientT@button]" cannot be assigned to type "CustomComponentInteraction" "Interaction[ClientT@button]" is incompatible with "CustomComponentInteraction"Pylance[reportGeneralTypeIssues](https://github.com/microsoft/pyright/blob/main/docs/configuration.md#reportGeneralTypeIssues)

Gangsta-Muffin and others added 2 commits January 9, 2023 21:39

class creation

2640aec

Creat first classes + Create PR

Merge pull request #1 from Gangsta-Muffin/interaction_subclasses

5bb1ee0

class creation

Gangsta-Muffin changed the title ~~nextcord.Interaction subclassing~~ build: nextcord.Interaction subclassing Jan 9, 2023

ooliver1 marked this pull request as draft January 9, 2023 22:21

EmreTech changed the title ~~build: nextcord.Interaction subclassing~~ refactor: nextcord.Interaction subclassing Jan 10, 2023

Gangsta-Muffin added 3 commits January 10, 2023 23:51

ooliver1 added s: in progress Status: the issue or PR is in development/progress p: low Priority: low - not important to be worked on t: refactor Type: refactor - this is a code change but does not fix a bug/add features labels Jan 11, 2023

Gangsta-Muffin and others added 13 commits January 11, 2023 16:27

Merge branch 'master' of https://github.com/Gangsta-Muffin/interacion…

eb72b37

…_subclasses

style: auto fixes from pre-commit hooks

c225a5f

perf: Stop double initialization of focused options

f2deaef

Stop double Initialization for focused slash options - instead append the first initialization to collection list

style: auto fixes from pre-commit hooks

e4a3dca

style: auto fixes from pre-commit hooks

187a789

style: auto fixes from pre-commit hooks

bfe0271

refactor: Add classes to __all__

d78bb8c

* Add classes to __all__ (interactions.py) * removed prints from testing

style: auto fixes from pre-commit hooks

16b9f22

EmreTech requested changes Jan 20, 2023

View reviewed changes

MaskDuck suggested changes Jan 21, 2023

View reviewed changes

nextcord/interactions.py Outdated Show resolved Hide resolved

nextcord/interactions.py Outdated Show resolved Hide resolved

Gangsta-Muffin and others added 2 commits January 21, 2023 19:43

style: auto fixes from pre-commit hooks

3fbbb2f

MaskDuck suggested changes Jan 22, 2023

View reviewed changes

typing: update interaction type hints; refactor: new dedicated intera…

a8903a3

…ctions folder

Gangsta-Muffin and others added 9 commits August 21, 2023 23:10

Implement changes made in comments

244393d

style: auto fixes from pre-commit hooks

9a91149

remove false copyright note in __init__

6407f6f

pyright and typehint fixes

e2e08dc

Merge branch 'master' of https://github.com/Gangsta-Muffin/interacion…

80a5f49

…_subclasses

pyright and typehint fixes

43c9a4c

style: auto fixes from pre-commit hooks

ba4d8cc

pyright fixes

dd8d4b5

style: auto fixes from pre-commit hooks

67c7606

Gangsta-Muffin requested review from teaishealthy, MaskDuck, Skelmis, ooliver1 and alentoghostflame August 25, 2023 13:08

EmreTech requested changes Sep 18, 2023

View reviewed changes

Gangsta-Muffin and others added 12 commits September 28, 2023 13:49

Update nextcord/application_command.py

c15ce41

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

Update nextcord/client.py

4f91451

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

Update nextcord/application_command.py

a03958f

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

Update nextcord/application_command.py

9429d45

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

Update nextcord/application_command.py

eaad9f8

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

Update nextcord/application_command.py

9feba04

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

Update nextcord/interactions/application.py

4a24204

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

Update nextcord/interactions/application.py

41a9c57

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

Update nextcord/interactions/application.py

b259085

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

Update nextcord/interactions/application.py

30009fa

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

Update nextcord/client.py

41e2bfc

Co-authored-by: Emre Terzioglu <50607143+EmreTech@users.noreply.github.com>

Type fix for Application Commands

24c794d

teaishealthy requested changes Oct 8, 2023

View reviewed changes

ooliver1 requested changes Dec 9, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: nextcord.Interaction subclassing #970

refactor: nextcord.Interaction subclassing #970

Gangsta-Muffin commented Jan 9, 2023 •

edited by EmreTech

EmreTech left a comment

MaskDuck left a comment

MaskDuck left a comment

teaishealthy commented Jul 26, 2023

EmreTech Sep 17, 2023

Gangsta-Muffin Sep 29, 2023

EmreTech Sep 29, 2023

Gangsta-Muffin Oct 1, 2023 •

edited

EmreTech Oct 1, 2023

EmreTech Sep 17, 2023

EmreTech Sep 18, 2023

EmreTech Sep 18, 2023

Gangsta-Muffin Sep 29, 2023

EmreTech Sep 29, 2023

teaishealthy Oct 8, 2023

teaishealthy Oct 8, 2023

teaishealthy Oct 8, 2023

ooliver1 Dec 9, 2023

teaishealthy Oct 8, 2023

ooliver1 left a comment

ooliver1 Dec 9, 2023

ooliver1 Dec 9, 2023

ooliver1 Dec 9, 2023

ooliver1 Dec 9, 2023

ooliver1 Dec 9, 2023

ooliver1 Dec 9, 2023

ooliver1 Dec 9, 2023

ooliver1 Dec 9, 2023


		__slots__: Tuple[str, ...] = ("data", "value", "type", "name", "focused")

		def __init__(self, data) -> None:

	ApplicationCommandInteractionDataOption = Union[
	_ApplicationCommandInteractionDataOptionString,
	_ApplicationCommandInteractionDataOptionInteger,
	_ApplicationCommandInteractionDataOptionSubcommand,
	_ApplicationCommandInteractionDataOptionBoolean,
	_ApplicationCommandInteractionDataOptionSnowflake,
	_ApplicationCommandInteractionDataOptionNumber,
	]

		self._parent._state.store_modal(modal, self._parent.user.id) # type: ignore


		class ApplicationAutocompleteInteraction(Interaction):

-        Warns
-        --------
+        Warns
+        -----

refactor: nextcord.Interaction subclassing #970

Are you sure you want to change the base?

refactor: nextcord.Interaction subclassing #970

Conversation

Gangsta-Muffin commented Jan 9, 2023 • edited by EmreTech

Summary

Subclasses will include:

Checklist (currently incomplete)

EmreTech left a comment

Choose a reason for hiding this comment

MaskDuck left a comment

Choose a reason for hiding this comment

MaskDuck left a comment

Choose a reason for hiding this comment

teaishealthy commented Jul 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Gangsta-Muffin Oct 1, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ooliver1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Gangsta-Muffin commented Jan 9, 2023 •

edited by EmreTech

Gangsta-Muffin Oct 1, 2023 •

edited