Refactor help command

Author: caffeine-addictt

src/cogs/help_command.py

@@ -2,7 +2,8 @@
 from discord import app_commands
 from discord.ext import commands
 
-from src.utils import Embeds, Error
+from src.utils import Embeds, Error, ViewPageScroller
+from typing import Optional, List
 
 
 class Help(commands.Cog):
@@ -32,75 +33,124 @@ async def on_ready(self):
   @app_commands.describe(
     query = 'Module\'s or Command\'s name'
   )
-  @commands.cooldown(1, 15)
-  async def help(self, ctx: commands.Context, query: str = None):
-    """Shows all modules of that bot"""
-
-    embed = Embeds(
-      title = 'Commands',
-      description = f'Use `/help <module>` or `/help <command>` for more information about that module or command\n\u200d'
-    )
-    embed.color = discord.Color.blurple()
-
+  @commands.cooldown(1, 15, commands.BucketType.user)
+  async def help(self, ctx: commands.Context, *, query: Optional[str] = None):
+    """
+    **Help command of the bot**
+
+    > **Arguments**
+    ```
+    query | string | default=None
+    ```
+
+    > **Example**
+    ```
+    /help
+    /help ping
+    ```
+    """
+    embed_data: dict[str, list[list]] = {}
+    page_limit = 1
+
+    async def load_cog_commands(cog, cmds):
+      if str(self.client.cogs[cog].__doc__).startswith('hidden'): return
+      if not cog in embed_data:
+        embed_data[cog] = [[]]
+
+      for i in cmds:
+        if i.hidden or str(i.help).startswith('hidden') or not await i.can_run(ctx): continue
+        if len(embed_data[cog][-1]) >= page_limit:
+          embed_data[cog].append([i])
+        else:
+          embed_data[cog][-1].append(i)
+
+    
     if not query:
-      available_cogs = []
-      for cog in self.client.cogs:
-        available_commands = []
-        for cmd in self.client.get_cog(cog).walk_commands():
-          if not cmd.hidden and not str(cmd.help).startswith('hidden') and await cmd.can_run(ctx):
-            available_commands.append(cmd)
-
-        if len(available_commands) > 0:
-          available_cogs.append(cog)
-
-      embed.add_field(
-        name = 'Modules',
-        value = '\n\u200d\n'.join(
-          f'**{cog}**\n```{str(self.client.cogs[cog].__doc__).lstrip().rstrip()}```' for cog in available_cogs if (
-            not str(self.client.cogs[cog].__doc__).startswith('hidden')
-          )
-        ),
-        inline = False
-      )
+      for cogname in self.client.cogs:
+        if str(self.client.cogs[cogname].__doc__).startswith('hidden'): continue # Skip hidden cogs
+
+        cog = self.client.get_cog(cogname)
+        if cog:
+          await load_cog_commands(cogname, cog.walk_commands())
 
     else:
-      found = False
-      async def add_to_embed(cmd):
-        if await cmd.can_run(ctx):
-          embed.add_field(
-            name = f'/{cmd.qualified_name}',
-            value = f'{str(cmd.help).lstrip().rstrip()}\n‍',
-            inline = False
-          )
-
-      for cog in self.client.cogs:
-        if query.lower() == cog.lower() and not str(self.client.cogs[cog].__doc__).startswith('hidden'):
-          embed.description += f'\n**{cog}\'s commands**\n\u200d'
-          available_commands_cog = []
-
-          for cmd in self.client.get_cog(cog).walk_commands():
-            if (not cmd.hidden and not str(cmd.help).startswith('hidden')) and await cmd.can_run(ctx):
-              available_commands_cog.append(cmd)
-
-          if len(available_commands_cog) > 0:
-            for i in available_commands_cog: await add_to_embed(i)
-            found = True
+      query = ''.join(query)
+      for cogname in self.client.cogs:
+        if query.lower() == cogname.lower() and not str(self.client.cogs[cogname].__doc__).startswith('hidden'):
+          cog = self.client.get_cog(cogname)
+          if not cog: continue
+
+          await load_cog_commands(cogname, cog.walk_commands())
           break
 
-        elif not str(self.client.cogs[cog].__doc__).startswith('hidden'):
-          for cmd in self.client.get_cog(cog).walk_commands():
-            if (not cmd.hidden and not str(cmd.help).startswith('hidden')):
-              if query.lower().strip() in cmd.qualified_name.lower().strip():
-                found = True
-                await add_to_embed(cmd)
+        elif not str(self.client.cogs[cogname].__doc__).startswith('hidden'):
+          cog = self.client.get_cog(cogname)
+          if not cog: continue
+
+          for cmd in cog.walk_commands():
+            if query.lower().strip() in cmd.qualified_name.lower().strip():
+              await load_cog_commands(cogname, [cmd])
+
+
+    if not embed_data:
+      raise Error(
+        description = f'Unable to locate module or command' + ((query and f'[{query}]') or '')
+      )
+    
+    else: #clean up
+      cleaned = []
+      for cogName, pages in embed_data.items():
+        for page in pages:
+          cleaned.append([cogName, list(page)])
+      
+
+    #Setup embed screen navigation
+    def load_page(data: tuple):
+      if not self.client.user:
+        raise Error('Client not logged in!')
+
+      embed = Embeds(
+        title = 'Commands',
+        description = f'Use `/help <module>` or `/help <command>` for more information about that module or command\n\n**{data[0]}\'s commands**\n\u200d'
+      )
+      embed.color = discord.Color.blurple()
+      embed.set_author(name = self.client.user.name, icon_url = self.client.user.display_avatar)
+
+      for i in data[1]:
+        embed.add_field(
+          name = f'/{i.qualified_name}',
+          value = f'{str(i.help).lstrip().rstrip()}\n‍',
+          inline = False
+        )
+
+      return embed
+      
+    scroll_embed = ViewPageScroller(
+      ownerid = ctx.author.id,
+      load_page = load_page,
+      pages = cleaned,
+      timeout = 180
+    )
+
+    await scroll_embed.send_message(ctx)
+
 
-          if found: break
-      if not found:
-        raise Error(description = f'Unable to locate module or command [{query}]')
+  @help.autocomplete('query')
+  async def help_autocomplete(self, ctx, current: str) -> List[app_commands.Choice[str]]:
+    data = []
+    command_names = []
+    for i in self.client.commands:
+      if i.hidden or str(i.help).startswith('hidden'): continue
+      command_names += list(i.aliases) + [i.name]
 
-    await ctx.reply(embed = embed)
+    for name in [cog for cog in self.client.cogs if not str(self.client.cogs[cog].__doc__).startswith('hidden')] + command_names:
+      if current.lower() in name.lower():
+        data.append(app_commands.Choice(
+          name = name,
+          value = name
+        ))
+    return data[0:24]
 
 
-async def setup(client: commands.Bot):
+async def setup(client):
   await client.add_cog(Help(client))
-