rework cog to better align standards and provide better structure

Author: No767

bot/cogs/snippets.py

@@ -1,34 +1,47 @@
-from typing import Optional
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Optional
 
 import discord
 from discord.ext import commands
-from libs.utils import GuildContext
-from rodhaj import Rodhaj
+
+if TYPE_CHECKING:
+    from libs.utils.context import GuildContext
+
+    from rodhaj import Rodhaj
 
 
 class Snippets(commands.Cog):
-    """
-    Cog for snippet-related commands (#21)
-    """
+    """Send or display pre-written text to users"""
 
     def __init__(self, bot: Rodhaj):
-        self._bot = bot
+        self.bot = bot
+        self.pool = self.bot.pool
+
+    # Editing Utilities
+
+    async def edit_prompt_user(self, ctx: GuildContext, name: str):
+        raise NotImplementedError("TODO: Add prompt for editing snippet.")
 
     @commands.guild_only()
-    @commands.group(name="snippet")
-    async def snippet_cmd(self, ctx: GuildContext):
-        if ctx.invoked_subcommand is None:
-            await ctx.send("placeholder for base command")
+    @commands.hybrid_group(name="snippets", alias=["snippet"], fallback="get")
+    async def snippet(self, ctx: GuildContext, *, name: str):
+        """Allows for use snippets of text for later retrieval or for quicker responses
+
+        If an subcommand is not called, then this will search
+        the database for the requested snippet
+        """
+        await ctx.send("Implement getting snippets here")
 
     @commands.guild_only()
-    @snippet_cmd.command()
+    @snippet.command()
     async def remove(self, ctx: GuildContext, name: str):
         query = """
         DELETE FROM snippets
         WHERE guild_id = $1 AND name = $2
         RETURNING name
         """
-        result = await self._bot.pool.fetchrow(query, ctx.guild.id, name)
+        result = await self.pool.fetchrow(query, ctx.guild.id, name)
         if result is None:
             await ctx.reply(
                 embed=discord.Embed(
@@ -49,19 +62,27 @@ async def remove(self, ctx: GuildContext, name: str):
                 ephemeral=True,
             )
 
+    # TODO: Run all str inputs through custom converters
     @commands.guild_only()
-    @snippet_cmd.command()
-    async def new(self, ctx, *args):
+    @snippet.command()
+    async def new(self, ctx, name: str, *, content: Optional[str] = None):
         await ctx.send("placeholder for snippet new")
 
     @commands.guild_only()
-    @snippet_cmd.command()
+    @snippet.command(name="list")
+    async def snippets_list(
+        self, ctx: GuildContext, json: Optional[bool] = False
+    ) -> None:
+        await ctx.send("list snippets")
+
+    @commands.guild_only()
+    @snippet.command()
     async def show(self, ctx: GuildContext, name: str):
         query = """
         SELECT content FROM snippets
         WHERE guild_id = $1 AND name = $2
         """
-        data = await self._bot.pool.fetchrow(query, ctx.guild.id, name)
+        data = await self.pool.fetchrow(query, ctx.guild.id, name)
         if data is None:
             ret_embed = discord.Embed(
                 title="Oops...",
@@ -80,15 +101,7 @@ async def show(self, ctx: GuildContext, name: str):
             await ctx.reply(embed=ret_data, ephemeral=True)
 
     @commands.guild_only()
-    @snippet_cmd.command()
-    async def list(self, ctx, *args):
-        await ctx.send("placeholder for snippet list")
-
-    async def edit_prompt_user(self, ctx: GuildContext, name: str):
-        raise NotImplementedError("TODO: Add prompt for editing snippet.")
-
-    @commands.guild_only()
-    @snippet_cmd.command()
+    @snippet.command()
     async def edit(self, ctx: GuildContext, name: str, content: Optional[str]):
         if content is None:
             await self.edit_prompt_user(ctx, name)
@@ -100,7 +113,7 @@ async def edit(self, ctx: GuildContext, name: str, content: Optional[str]):
         RETURNING name
         """
 
-        result = await self._bot.pool.fetchrow(query, ctx.guild.id, name, content)
+        result = await self.pool.fetchrow(query, ctx.guild.id, name, content)
         if result is None:
             await ctx.reply(
                 embed=discord.Embed(