Paginator change

Author: Taaku18

CHANGELOG.md

@@ -66,7 +66,8 @@ however, insignificant breaking changes does not guarantee a major version bump,
 - Use discord tasks for metadata loop.
 - More debug based logging.
 - Reduce redundancies in `?perms` sub commands.
- 
+- paginator been split into `EmbedPaginatorSession` and `MessagePaginatorSession`, both subclassing `PaginatorSession`.
+
 # v3.0.3
 
 ### Added

cogs/modmail.py

@@ -15,7 +15,7 @@
 from core import checks
 from core.decorators import trigger_typing
 from core.models import PermissionLevel
-from core.paginator import PaginatorSession
+from core.paginator import EmbedPaginatorSession
 from core.time import UserFriendlyTime, human_timedelta
 from core.utils import format_preview, User, create_not_found_embed, format_description
 
@@ -154,7 +154,7 @@ async def snippet(self, ctx, *, name: str.lower = None):
             embed.set_author(name="Snippets", icon_url=ctx.guild.icon_url)
             embeds.append(embed)
 
-        session = PaginatorSession(ctx, *embeds)
+        session = EmbedPaginatorSession(ctx, *embeds)
         await session.run()
 
     @snippet.command(name="raw")
@@ -631,7 +631,7 @@ async def logs(self, ctx, *, user: User = None):
 
         embeds = self.format_log_embeds(logs, avatar_url=icon_url)
 
-        session = PaginatorSession(ctx, *embeds)
+        session = EmbedPaginatorSession(ctx, *embeds)
         await session.run()
 
     @logs.command(name="closed-by", aliases=["closeby"])
@@ -664,7 +664,7 @@ async def logs_closed_by(self, ctx, *, user: User = None):
             )
             return await ctx.send(embed=embed)
 
-        session = PaginatorSession(ctx, *embeds)
+        session = EmbedPaginatorSession(ctx, *embeds)
         await session.run()
 
     @logs.command(name="search", aliases=["find"])
@@ -697,7 +697,7 @@ async def logs_search(self, ctx, limit: Optional[int] = None, *, query):
             )
             return await ctx.send(embed=embed)
 
-        session = PaginatorSession(ctx, *embeds)
+        session = EmbedPaginatorSession(ctx, *embeds)
         await session.run()
 
     @commands.command()
@@ -893,7 +893,8 @@ async def blocked(self, ctx):
         else:
             embeds[-1].description = "Currently there are no blocked users."
 
-        await PaginatorSession(ctx, *embeds).run()
+        session = EmbedPaginatorSession(ctx, *embeds)
+        await session.run()
 
     @blocked.command(name="whitelist")
     @checks.has_permissions(PermissionLevel.MODERATOR)

cogs/plugins.py

@@ -17,7 +17,7 @@
 
 from core import checks
 from core.models import PermissionLevel
-from core.paginator import PaginatorSession
+from core.paginator import EmbedPaginatorSession
 
 logger = logging.getLogger("Modmail")
 
@@ -465,7 +465,7 @@ async def plugin_registry(self, ctx, *, plugin_name: typing.Union[int, str] = No
 
             embeds.append(embed)
 
-        paginator = PaginatorSession(ctx, *embeds)
+        paginator = EmbedPaginatorSession(ctx, *embeds)
         paginator.current = index
         await paginator.run()
 
@@ -499,7 +499,7 @@ async def plugin_registry_compact(self, ctx):
             embed.set_author(name="Plugin Registry", icon_url=self.bot.user.avatar_url)
             embeds.append(embed)
 
-        paginator = PaginatorSession(ctx, *embeds)
+        paginator = EmbedPaginatorSession(ctx, *embeds)
         await paginator.run()
 
 

cogs/utility.py

@@ -26,7 +26,7 @@
 from core.changelog import Changelog
 from core.decorators import trigger_typing
 from core.models import InvalidConfigError, PermissionLevel
-from core.paginator import PaginatorSession, MessagePaginatorSession
+from core.paginator import EmbedPaginatorSession, MessagePaginatorSession
 from core.utils import (
     cleanup_code,
     User,
@@ -112,17 +112,17 @@ async def send_bot_help(self, mapping):
         if no_cog_commands:
             embeds.extend(await self.format_cog_help(no_cog_commands, no_cog=True))
 
-        p_session = PaginatorSession(
+        session = EmbedPaginatorSession(
             self.context, *embeds, destination=self.get_destination()
         )
-        return await p_session.run()
+        return await session.run()
 
     async def send_cog_help(self, cog):
         embeds = await self.format_cog_help(cog)
-        p_session = PaginatorSession(
+        session = EmbedPaginatorSession(
             self.context, *embeds, destination=self.get_destination()
         )
-        return await p_session.run()
+        return await session.run()
 
     async def send_command_help(self, command):
         if not await self.filter_commands([command]):
@@ -285,7 +285,7 @@ async def changelog(self, ctx, version: str.lower = ""):
             )
 
         try:
-            paginator = PaginatorSession(ctx, *changelog.embeds)
+            paginator = EmbedPaginatorSession(ctx, *changelog.embeds)
             paginator.current = index
             await paginator.run()
         except asyncio.CancelledError:
@@ -358,7 +358,7 @@ async def sponsors(self, ctx):
 
         random.shuffle(embeds)
 
-        session = PaginatorSession(ctx, *embeds)
+        session = EmbedPaginatorSession(ctx, *embeds)
         await session.run()
 
     @commands.group(invoke_without_command=True)
@@ -762,7 +762,7 @@ async def config_options(self, ctx):
             )
             embeds.append(embed)
 
-        session = PaginatorSession(ctx, *embeds)
+        session = EmbedPaginatorSession(ctx, *embeds)
         await session.run()
 
     @config.command(name="set", aliases=["add"])
@@ -926,7 +926,7 @@ def fmt(val):
                 embed.set_thumbnail(url=fmt(info["thumbnail"]))
             embeds += [embed]
 
-        paginator = PaginatorSession(ctx, *embeds)
+        paginator = EmbedPaginatorSession(ctx, *embeds)
         paginator.current = index
         await paginator.run()
 
@@ -1003,7 +1003,7 @@ async def alias(self, ctx, *, name: str.lower = None):
             embed.set_author(name="Command Aliases", icon_url=ctx.guild.icon_url)
             embeds.append(embed)
 
-        session = PaginatorSession(ctx, *embeds)
+        session = EmbedPaginatorSession(ctx, *embeds)
         await session.run()
 
     @alias.command(name="raw")
@@ -1500,8 +1500,8 @@ async def permissions_get(
                     for perm_level in PermissionLevel:
                         embeds.append(self._get_perm(ctx, perm_level.name, "level"))
 
-        p_session = PaginatorSession(ctx, *embeds)
-        return await p_session.run()
+        session = EmbedPaginatorSession(ctx, *embeds)
+        return await session.run()
 
     @commands.group(invoke_without_command=True)
     @checks.has_permissions(PermissionLevel.OWNER)