Add a delete button for paginators

Author: kyb3r

core/paginator.py

@@ -43,27 +43,26 @@ class PaginatorSession:
 
     def __init__(self, ctx: commands.Context, *embeds, **options):
         self.ctx = ctx
-        self.timeout: int = options.get('timeout', 210)
+        self.timeout: int = options.get("timeout", 210)
         self.embeds: typing.List[Embed] = list(embeds)
         self.running = False
         self.base: Message = None
         self.current = 0
-        self.destination = options.get('destination', ctx)
+        self.destination = options.get("destination", ctx)
         self.reaction_map = {
-            '⏮': self.first_page,
-            '◀': self.previous_page,
-            '▶': self.next_page,
-            '⏭': self.last_page,
-            # '⏹': self.close
+            "⏮": self.first_page,
+            "◀": self.previous_page,
+            "▶": self.next_page,
+            "⏭": self.last_page,
+            "🛑": self.close,
         }
 
-        if options.get('edit_footer', True) and len(self.embeds) > 1:
+        if options.get("edit_footer", True) and len(self.embeds) > 1:
             for i, embed in enumerate(self.embeds):
-                footer_text = f'Page {i + 1} of {len(self.embeds)}'
+                footer_text = f"Page {i + 1} of {len(self.embeds)}"
                 if embed.footer.text:
-                    footer_text = footer_text + ' • ' + embed.footer.text
-                embed.set_footer(text=footer_text,
-                                 icon_url=embed.footer.icon_url)
+                    footer_text = footer_text + " • " + embed.footer.text
+                embed.set_footer(text=footer_text, icon_url=embed.footer.icon_url)
 
     def add_page(self, embed: Embed) -> None:
         """
@@ -77,7 +76,7 @@ def add_page(self, embed: Embed) -> None:
         if isinstance(embed, Embed):
             self.embeds.append(embed)
         else:
-            raise TypeError('Page must be an Embed object.')
+            raise TypeError("Page must be an Embed object.")
 
     async def create_base(self, embed: Embed) -> None:
         """
@@ -96,7 +95,7 @@ async def create_base(self, embed: Embed) -> None:
 
         self.running = True
         for reaction in self.reaction_map:
-            if len(self.embeds) == 2 and reaction in '⏮⏭':
+            if len(self.embeds) == 2 and reaction in "⏮⏭":
                 continue
             await self.base.add_reaction(reaction)
 
@@ -134,9 +133,11 @@ def react_check(self, reaction: Reaction, user: User) -> bool:
         -------
         bool
         """
-        return (reaction.message.id == self.base.id and
-                user.id == self.ctx.author.id and
-                reaction.emoji in self.reaction_map.keys())
+        return (
+            reaction.message.id == self.base.id
+            and user.id == self.ctx.author.id
+            and reaction.emoji in self.reaction_map.keys()
+        )
 
     async def run(self) -> typing.Optional[Message]:
         """
@@ -152,9 +153,7 @@ async def run(self) -> typing.Optional[Message]:
         while self.running:
             try:
                 reaction, user = await self.ctx.bot.wait_for(
-                    'reaction_add',
-                    check=self.react_check,
-                    timeout=self.timeout
+                    "reaction_add", check=self.react_check, timeout=self.timeout
                 )
             except TimeoutError:
                 return await self.close(delete=False)
@@ -195,10 +194,7 @@ async def close(self, delete: bool = True) -> typing.Optional[Message]:
         """
         self.running = False
 
-        try:
-            await self.ctx.message.add_reaction('✅')
-        except (HTTPException, InvalidArgument):
-            pass
+        self.bot.loop.create
 
         if delete:
             return await self.base.delete()
@@ -222,10 +218,11 @@ async def last_page(self) -> None:
 
 
 class MessagePaginatorSession:
-    def __init__(self, ctx: commands.Context, *messages,
-                 embed: Embed = None, **options):
+    def __init__(
+        self, ctx: commands.Context, *messages, embed: Embed = None, **options
+    ):
         self.ctx = ctx
-        self.timeout: int = options.get('timeout', 180)
+        self.timeout: int = options.get("timeout", 180)
         self.messages: typing.List[str] = list(messages)
 
         self.running = False
@@ -238,11 +235,11 @@ def __init__(self, ctx: commands.Context, *messages,
 
         self.current = 0
         self.reaction_map = {
-            '⏮': self.first_page,
-            '◀': self.previous_page,
-            '▶': self.next_page,
-            '⏭': self.last_page,
-            # '⏹': self.close
+            "⏮": self.first_page,
+            "◀": self.previous_page,
+            "▶": self.next_page,
+            "⏭": self.last_page,
+            "🛑": self.close,
         }
 
     def add_page(self, msg: str) -> None:
@@ -257,7 +254,7 @@ def add_page(self, msg: str) -> None:
         if isinstance(msg, str):
             self.messages.append(msg)
         else:
-            raise TypeError('Page must be a str object.')
+            raise TypeError("Page must be a str object.")
 
     async def create_base(self, msg: str) -> None:
         """
@@ -269,11 +266,10 @@ async def create_base(self, msg: str) -> None:
             The message content to fill the base `Message`.
         """
         if self.embed is not None:
-            footer_text = f'Page {self.current+1} of {len(self.messages)}'
+            footer_text = f"Page {self.current+1} of {len(self.messages)}"
             if self.footer_text:
-                footer_text = footer_text + ' • ' + self.footer_text
-            self.embed.set_footer(text=footer_text,
-                                  icon_url=self.embed.footer.icon_url)
+                footer_text = footer_text + " • " + self.footer_text
+            self.embed.set_footer(text=footer_text, icon_url=self.embed.footer.icon_url)
 
         self.base = await self.ctx.send(content=msg, embed=self.embed)
 
@@ -283,7 +279,7 @@ async def create_base(self, msg: str) -> None:
 
         self.running = True
         for reaction in self.reaction_map:
-            if len(self.messages) == 2 and reaction in '⏮⏭':
+            if len(self.messages) == 2 and reaction in "⏮⏭":
                 continue
             await self.base.add_reaction(reaction)
 
@@ -303,11 +299,10 @@ async def show_page(self, index: int) -> None:
         page = self.messages[index]
 
         if self.embed is not None:
-            footer_text = f'Page {self.current + 1} of {len(self.messages)}'
+            footer_text = f"Page {self.current + 1} of {len(self.messages)}"
             if self.footer_text:
-                footer_text = footer_text + ' • ' + self.footer_text
-            self.embed.set_footer(text=footer_text,
-                                  icon_url=self.embed.footer.icon_url)
+                footer_text = footer_text + " • " + self.footer_text
+            self.embed.set_footer(text=footer_text, icon_url=self.embed.footer.icon_url)
 
         if self.running:
             await self.base.edit(content=page, embed=self.embed)
@@ -328,9 +323,11 @@ def react_check(self, reaction: Reaction, user: User) -> bool:
         -------
         bool
         """
-        return (reaction.message.id == self.base.id and
-                user.id == self.ctx.author.id and
-                reaction.emoji in self.reaction_map.keys())
+        return (
+            reaction.message.id == self.base.id
+            and user.id == self.ctx.author.id
+            and reaction.emoji in self.reaction_map.keys()
+        )
 
     async def run(self) -> typing.Optional[Message]:
         """
@@ -346,9 +343,7 @@ async def run(self) -> typing.Optional[Message]:
         while self.running:
             try:
                 reaction, user = await self.ctx.bot.wait_for(
-                    'reaction_add',
-                    check=self.react_check,
-                    timeout=self.timeout
+                    "reaction_add", check=self.react_check, timeout=self.timeout
                 )
             except TimeoutError:
                 return await self.close(delete=False)
@@ -389,10 +384,7 @@ async def close(self, delete: bool = True) -> typing.Optional[Message]:
         """
         self.running = False
 
-        try:
-            await self.ctx.message.add_reaction('✅')
-        except (HTTPException, InvalidArgument):
-            pass
+        self.ctx.bot.loop.create_task(self.ctx.message.add_reaction("✅"))
 
         if delete:
             return await self.base.delete()