Add shortcut property to send modals via ApplicationContext (#1062)

* add shortcut methods to send modals via ApplicationContext

* update docstring

* add in changed return value for underlying send_modal method

Author: krittick

discord/commands/context.py

@@ -215,10 +215,15 @@ def unselected_options(self) -> Optional[List[Option]]:
                 return self.command.options  # type: ignore
         return None
 
+    @property
+    def send_modal(self) -> Interaction:
+        """Sends a modal dialog to the user who invoked the interaction."""
+        return self.interaction.response.send_modal
+
     @property
     def respond(self) -> Callable[..., Awaitable[Union[Interaction, WebhookMessage]]]:
         """Callable[..., Union[:class:`~.Interaction`, :class:`~.Webhook`]]: Sends either a response
-        or a followup response depending if the interaction has been responded to yet or not."""
+        or a followup response depending on if the interaction has been responded to yet or not."""
         if not self.interaction.response.is_done():
             return self.interaction.response.send_message  # self.response
         else:

discord/interactions.py

@@ -792,7 +792,7 @@ async def send_autocomplete_result(
 
         self._responded = True
 
-    async def send_modal(self, modal: Modal):
+    async def send_modal(self, modal: Modal) -> Interaction:
         """|coro|
         Responds to this interaction by sending a modal dialog.
         This cannot be used to respond to another modal dialog submission.
@@ -823,6 +823,7 @@ async def send_modal(self, modal: Modal):
         )
         self._responded = True
         self._parent._state.store_modal(modal, self._parent.user.id)
+        return self._parent
 
 
 class _InteractionMessageState:

examples/modal_dialogs.py

@@ -35,23 +35,23 @@ async def callback(self, interaction: discord.Interaction):
 async def modal_slash(ctx):
     """Shows an example of a modal dialog being invoked from a slash command."""
     modal = MyModal(title="Slash Command Modal")
-    await ctx.interaction.response.send_modal(modal)
+    await ctx.send_modal(modal)
 
 
 @bot.message_command(name="messagemodal", guild_ids=[...])
 async def modal_message(ctx, message):
     """Shows an example of a modal dialog being invoked from a message command."""
     modal = MyModal(title="Message Command Modal")
     modal.title = f"Modal for Message ID: {message.id}"
-    await ctx.interaction.response.send_modal(modal)
+    await ctx.send_modal(modal)
 
 
 @bot.user_command(name="usermodal", guild_ids=[...])
 async def modal_user(ctx, member):
     """Shows an example of a modal dialog being invoked from a user command."""
     modal = MyModal(title="User Command Modal")
     modal.title = f"Modal for User: {member.display_name}"
-    await ctx.interaction.response.send_modal(modal)
+    await ctx.send_modal(modal)
 
 
 @bot.command()