add back ext.menus

Author: krittick

discord/ext/menus/__init__.py

@@ -0,0 +1,7 @@
+"""
+discord.ext.menus
+~~~~~~~~~~~~~~~~~~~~~
+An extension module to provide useful menu options.
+"""
+
+from .pagination import *

discord/ext/menus/pagination.py

@@ -0,0 +1,151 @@
+from typing import List, Union
+
+import discord
+from discord import abc
+from discord.commands import ApplicationContext
+from discord.ext.commands import Context
+from discord.utils import MISSING
+
+
+class Paginate(discord.ui.View):
+    """Creates a paginator for a message that is navigated with buttons.
+
+    Parameters
+    ------------
+    pages: Union[List[:class:`str`], List[:class:`discord.Embed`]]
+        Your list of strings or embeds to paginate
+    show_disabled: :class:`bool`
+        Choose whether or not to show disabled buttons
+    """
+
+    def __init__(self, pages: Union[List[str], List[discord.Embed]], show_disabled=True, author_check=True):
+        super().__init__()
+        self.pages = pages
+        self.current_page = 1
+        self.page_count = len(self.pages)
+        self.show_disabled = show_disabled
+        self.forbutton = self.children[1]
+        self.prevbutton = self.children[0]
+        self.usercheck = author_check
+        self.user = None
+        if not self.show_disabled:
+            self.remove_item(self.children[0])
+            if self.page_count == 1:
+                self.remove_item(self.children[1])
+
+    async def interaction_check(self, interaction):
+        if self.usercheck:
+            return self.user == interaction.user
+        return True
+
+    @discord.ui.button(label="<", style=discord.ButtonStyle.green, disabled=True)
+    async def previous(self, button: discord.ui.Button, interaction: discord.Interaction):
+
+        self.current_page -= 1
+
+        if self.current_page == 1:
+            button.disabled = True
+
+        if not self.show_disabled:
+            if len(self.children) == 1:
+                self.add_item(self.forbutton)
+                self.forbutton.disabled = False
+            if button.disabled:
+                self.remove_item(button)
+        else:
+            self.children[1].disabled = False
+
+        page = self.pages[self.current_page - 1]
+        await interaction.response.edit_message(content=page if isinstance(page, str) else None, embed=page if isinstance(page, discord.Embed) else MISSING, view=self)
+
+    @discord.ui.button(label='>', style=discord.ButtonStyle.green)
+    async def forward(self, button: discord.ui.Button, interaction: discord.Interaction):
+
+        self.current_page += 1
+
+        if self.current_page == self.page_count:
+            button.disabled = True
+
+        if not self.show_disabled:
+            if len(self.children) == 1:
+                self.add_item(self.prevbutton)
+                self.prevbutton.disabled = False
+                self.children[0], self.children[1] = self.children[1], self.children[0]
+            if button.disabled:
+                self.remove_item(button)
+        else:
+            self.children[0].disabled = False
+
+        page = self.pages[self.current_page - 1]
+        await interaction.response.edit_message(content=page if isinstance(page, str) else None, embed=page if isinstance(page, discord.Embed) else MISSING, view=self)
+
+    async def send(self, messageable: abc.Messageable, ephemeral: bool = False):
+        """Sends a message with the paginated items.
+
+        Parameters
+        ------------
+        messageable: :class:`discord.abc.Messageable`
+            The messageable channel to send to.
+        ephemeral: :class:`bool`
+            Choose whether or not the message is ephemeral. Only works with slash commands.
+        Returns
+        --------
+        :class:`~discord.Message`
+            The message that was sent.
+        """
+
+        if not isinstance(messageable, abc.Messageable):
+            raise TypeError("messageable should be a subclass of abc.Messageable")
+
+        page = self.pages[0]
+
+        if isinstance(messageable, (ApplicationContext, Context)):
+            self.user = messageable.author
+
+        if isinstance(messageable, ApplicationContext):
+            message = await messageable.respond(content=page if isinstance(page, str) else None, embed=page if isinstance(page, discord.Embed) else MISSING, view=self, ephemeral=ephemeral)
+        else:
+            message = await messageable.send(content=page if isinstance(page, str) else None, embed=page if isinstance(page, discord.Embed) else None, view=self)
+        return message
+
+    def forward_button(self, label: str, color: str = "green"):
+        """Customize your forward button
+
+        Parameters
+        ------------
+        label: :class:`str`
+            The text you want on your button
+
+        color: :class:`str`
+            The color of the button.
+
+        Raises
+        --------
+        AttributeError
+            The color provided isn't supported
+            """
+
+        self.forbutton.label = label
+        color = getattr(discord.ButtonStyle, color.lower())
+        self.forbutton.style = color
+
+    def back_button(self, label: str, color: str = "green"):
+        """Customize your back button
+
+        Parameters
+        ------------
+        label: :class:`str`
+            The text you want on your button
+
+        color: :class:`str`
+            The color of the button.
+
+        Raises
+        --------
+        AttributeError
+            The color provided isn't supported
+            """
+
+        self.prevbutton.label = label
+        color = getattr(discord.ButtonStyle, color.lower())
+        self.prevbutton.style = color

setup.py

@@ -60,6 +60,7 @@
     'discord.commands',
     'discord.ext.commands',
     'discord.ext.tasks',
+    'discord.ext.menus',
 ]
 
 setup(name='py-cord',