Merge branch 'main' into donor-icons

Author: basil-squared

tux/cogs/admin/dev.py

@@ -4,16 +4,22 @@
 
 from tux.bot import Tux
 from tux.utils import checks
+from tux.utils.flags import generate_usage
 
 
 class Dev(commands.Cog):
     def __init__(self, bot: Tux) -> None:
         self.bot = bot
+        self.sync_tree.usage = generate_usage(self.sync_tree)
+        self.clear_tree.usage = generate_usage(self.clear_tree)
+        self.load_cog.usage = generate_usage(self.load_cog)
+        self.unload_cog.usage = generate_usage(self.unload_cog)
+        self.reload_cog.usage = generate_usage(self.reload_cog)
+        self.stop.usage = generate_usage(self.stop)
 
     @commands.hybrid_group(
         name="dev",
         aliases=["d"],
-        usage="dev <subcommand>",
     )
     @commands.guild_only()
     @checks.has_pl(8)
@@ -39,7 +45,6 @@ async def dev(self, ctx: commands.Context[Tux]) -> None:
     @dev.command(
         name="sync_tree",
         aliases=["st", "sync", "s"],
-        usage="dev sync_tree [guild]",
     )
     @commands.guild_only()
     @checks.has_pl(8)
@@ -71,7 +76,6 @@ async def sync_tree(self, ctx: commands.Context[Tux], guild: discord.Guild) -> N
     @dev.command(
         name="clear_tree",
         aliases=["ct", "clear", "c"],
-        usage="dev clear_tree",
     )
     @commands.guild_only()
     @checks.has_pl(8)
@@ -104,7 +108,6 @@ async def clear_tree(self, ctx: commands.Context[Tux]) -> None:
     @dev.command(
         name="load_cog",
         aliases=["lc", "load", "l"],
-        usage="dev load_cog [cog]",
     )
     @commands.guild_only()
     @checks.has_pl(8)
@@ -145,7 +148,6 @@ async def load_cog(self, ctx: commands.Context[Tux], *, cog: str) -> None:
     @dev.command(
         name="unload_cog",
         aliases=["uc", "unload", "u"],
-        usage="dev unload_cog [cog]",
     )
     @commands.guild_only()
     @checks.has_pl(8)
@@ -180,7 +182,6 @@ async def unload_cog(self, ctx: commands.Context[Tux], *, cog: str) -> None:
     @dev.command(
         name="reload_cog",
         aliases=["rc", "reload", "r"],
-        usage="dev reload_cog [cog]",
     )
     @commands.guild_only()
     @checks.has_pl(8)
@@ -215,7 +216,6 @@ async def reload_cog(self, ctx: commands.Context[Tux], *, cog: str) -> None:
 
     @dev.command(
         name="stop",
-        usage="dev stop",
     )
     @commands.guild_only()
     @checks.has_pl(8)

tux/cogs/admin/eval.py

@@ -7,6 +7,7 @@
 from tux.bot import Tux
 from tux.ui.embeds import EmbedCreator
 from tux.utils import checks
+from tux.utils.flags import generate_usage
 
 
 def insert_returns(body: list[ast.stmt]) -> None:
@@ -41,25 +42,26 @@ def insert_returns(body: list[ast.stmt]) -> None:
 class Eval(commands.Cog):
     def __init__(self, bot: Tux) -> None:
         self.bot = bot
+        self.eval.usage = generate_usage(self.eval)
 
     @commands.command(
         name="eval",
         aliases=["e"],
-        usage="eval [expression]",
     )
     @commands.guild_only()
     @checks.has_pl(8)  # sysadmin or higher
-    async def eval(self, ctx: commands.Context[Tux], *, cmd: str) -> None:
+    async def eval(self, ctx: commands.Context[Tux], *, expression: str) -> None:
         """
         Evaluate a Python expression. (Owner only)
 
         Parameters
         ----------
         ctx : commands.Context[Tux]
             The context in which the command is being invoked.
-        cmd : str
+        expression : str
             The Python expression to evaluate.
         """
+        cmd = expression
 
         # Check if the user is in the discord.py owner_ids list in the bot instance
         if self.bot.owner_ids is None:

tux/cogs/admin/git.py

@@ -6,6 +6,7 @@
 from tux.ui.embeds import EmbedCreator
 from tux.utils import checks
 from tux.utils.constants import Constants as CONST
+from tux.utils.flags import generate_usage
 from tux.wrappers.github import GithubService
 
 # TODO: Rewrite this cog to use the new hybrid command system.
@@ -16,11 +17,14 @@ def __init__(self, bot: Tux) -> None:
         self.bot = bot
         self.github = GithubService()
         self.repo_url = CONST.GITHUB_REPO_URL
+        self.git.usage = generate_usage(self.git)
+        self.get_repo.usage = generate_usage(self.get_repo)
+        self.create_issue.usage = generate_usage(self.create_issue)
+        self.get_issue.usage = generate_usage(self.get_issue)
 
     @commands.hybrid_group(
         name="git",
         aliases=["g"],
-        usage="git <subcommand>",
     )
     @commands.guild_only()
     @checks.has_pl(8)
@@ -40,7 +44,6 @@ async def git(self, ctx: commands.Context[Tux]) -> None:
     @git.command(
         name="get_repo",
         aliases=["r"],
-        usage="git get_repo",
     )
     @commands.guild_only()
     @checks.has_pl(8)
@@ -81,7 +84,6 @@ async def get_repo(self, ctx: commands.Context[Tux]) -> None:
     @git.command(
         name="create_issue",
         aliases=["ci"],
-        usage="git create_issue [title] [body]",
     )
     @commands.guild_only()
     # @checks.has_pl(8)
@@ -127,7 +129,6 @@ async def create_issue(self, ctx: commands.Context[Tux], title: str, body: str)
     @git.command(
         name="get_issue",
         aliases=["gi", "issue", "i"],
-        usage="git get_issue [issue_number]",
     )
     @commands.guild_only()
     @checks.has_pl(8)

tux/cogs/fun/random.py

@@ -4,16 +4,21 @@
 
 from tux.bot import Tux
 from tux.ui.embeds import EmbedCreator
+from tux.utils.flags import generate_usage
 
 
 class Random(commands.Cog):
     def __init__(self, bot: Tux) -> None:
         self.bot = bot
+        self.random.usage = generate_usage(self.random)
+        self.coinflip.usage = generate_usage(self.coinflip)
+        self.eight_ball.usage = generate_usage(self.eight_ball)
+        self.dice.usage = generate_usage(self.dice)
+        self.random_number.usage = generate_usage(self.random_number)
 
     @commands.hybrid_group(
         name="random",
         aliases=["rand"],
-        usage="random <subcommand>",
     )
     @commands.guild_only()
     async def random(self, ctx: commands.Context[Tux]) -> None:
@@ -31,7 +36,6 @@ async def random(self, ctx: commands.Context[Tux]) -> None:
     @random.command(
         name="coinflip",
         aliases=["cf"],
-        usage="random coinflip",
     )
     @commands.guild_only()
     async def coinflip(self, ctx: commands.Context[Tux]) -> None:
@@ -51,7 +55,6 @@ async def coinflip(self, ctx: commands.Context[Tux]) -> None:
     @random.command(
         name="8ball",
         aliases=["eightball", "8b"],
-        usage="random 8ball [question]",
     )
     @commands.guild_only()
     async def eight_ball(self, ctx: commands.Context[Tux], *, question: str, cow: bool = False) -> None:
@@ -155,7 +158,6 @@ async def eight_ball(self, ctx: commands.Context[Tux], *, question: str, cow: bo
     @random.command(
         name="dice",
         aliases=["d"],
-        usage="random dice <sides>",
     )
     @commands.guild_only()
     async def dice(self, ctx: commands.Context[Tux], sides: int = 6) -> None:
@@ -188,7 +190,6 @@ async def dice(self, ctx: commands.Context[Tux], sides: int = 6) -> None:
     @random.command(
         name="number",
         aliases=["n"],
-        usage="random number <min> <max>",
     )
     @commands.guild_only()
     async def random_number(

tux/cogs/fun/xkcd.py

@@ -5,18 +5,22 @@
 from tux.bot import Tux
 from tux.ui.buttons import XkcdButtons
 from tux.ui.embeds import EmbedCreator
+from tux.utils.flags import generate_usage
 from tux.wrappers import xkcd
 
 
 class Xkcd(commands.Cog):
     def __init__(self, bot: Tux) -> None:
         self.bot = bot
         self.client = xkcd.Client()
+        self.xkcd.usage = generate_usage(self.xkcd)
+        self.latest.usage = generate_usage(self.latest)
+        self.random.usage = generate_usage(self.random)
+        self.specific.usage = generate_usage(self.specific)
 
     @commands.hybrid_group(
         name="xkcd",
         aliases=["xk"],
-        usage="xkcd <subcommand>",
     )
     @commands.guild_only()
     async def xkcd(self, ctx: commands.Context[Tux], comic_id: int | None = None) -> None:
@@ -39,7 +43,6 @@ async def xkcd(self, ctx: commands.Context[Tux], comic_id: int | None = None) ->
     @xkcd.command(
         name="latest",
         aliases=["l", "new", "n"],
-        usage="xkcd latest",
     )
     @commands.guild_only()
     async def latest(self, ctx: commands.Context[Tux]) -> None:
@@ -62,7 +65,6 @@ async def latest(self, ctx: commands.Context[Tux]) -> None:
     @xkcd.command(
         name="random",
         aliases=["rand", "r"],
-        usage="xkcd random",
     )
     @commands.guild_only()
     async def random(self, ctx: commands.Context[Tux]) -> None:
@@ -85,7 +87,6 @@ async def random(self, ctx: commands.Context[Tux]) -> None:
     @xkcd.command(
         name="specific",
         aliases=["s", "id", "num"],
-        usage="xkcd specific [comic_id]",
     )
     @commands.guild_only()
     async def specific(self, ctx: commands.Context[Tux], comic_id: int) -> None:

tux/cogs/info/avatar.py

@@ -7,13 +7,15 @@
 from discord.ext import commands
 
 from tux.bot import Tux
+from tux.utils.flags import generate_usage
 
 client = httpx.AsyncClient()
 
 
 class Avatar(commands.Cog):
     def __init__(self, bot: Tux) -> None:
         self.bot = bot
+        self.prefix_avatar.usage = generate_usage(self.prefix_avatar)
 
     @app_commands.command(name="avatar")
     @app_commands.guild_only()
@@ -38,7 +40,6 @@ async def slash_avatar(
     @commands.command(
         name="avatar",
         aliases=["av"],
-        usage="avatar <member>",
     )
     @commands.guild_only()
     async def prefix_avatar(

tux/cogs/info/info.py

@@ -6,15 +6,27 @@
 
 from tux.bot import Tux
 from tux.ui.embeds import EmbedCreator, EmbedType
+from tux.utils.flags import generate_usage
 
 
 class Info(commands.Cog):
     def __init__(self, bot: Tux) -> None:
         self.bot = bot
-
+        self.info.usage = generate_usage(self.info)
+        self.server.usage = generate_usage(self.server)
+        self.member.usage = generate_usage(self.member)
+        self.roles.usage = generate_usage(self.roles)
+        self.emotes.usage = generate_usage(self.emotes)
+
+    @commands.hybrid_group(
+        name="info",
+        aliases=["i"],
+    )
     @commands.guild_only()
-    @commands.hybrid_group(name="info", aliases=["i"], usage="info <subcommand>")
-    async def info(self, ctx: commands.Context[Tux]) -> None:
+    async def info(
+        self,
+        ctx: commands.Context[Tux],
+    ) -> None:
         """
         Information commands.
 
@@ -27,8 +39,11 @@ async def info(self, ctx: commands.Context[Tux]) -> None:
         if ctx.invoked_subcommand is None:
             await ctx.send_help("info")
 
+    @info.command(
+        name="server",
+        aliases=["s"],
+    )
     @commands.guild_only()
-    @info.command(name="server", aliases=["s"], usage="info server")
     async def server(self, ctx: commands.Context[Tux]) -> None:
         """
         Show information about the server.
@@ -68,8 +83,11 @@ async def server(self, ctx: commands.Context[Tux]) -> None:
 
         await ctx.send(embed=embed)
 
+    @info.command(
+        name="member",
+        aliases=["m", "user", "u"],
+    )
     @commands.guild_only()
-    @info.command(name="member", aliases=["m", "user", "u"], usage="info member [member]")
     async def member(self, ctx: commands.Context[Tux], member: discord.Member) -> None:
         """
         Show information about a member.
@@ -113,8 +131,11 @@ async def member(self, ctx: commands.Context[Tux], member: discord.Member) -> No
 
         await ctx.send(embed=embed)
 
+    @info.command(
+        name="roles",
+        aliases=["r"],
+    )
     @commands.guild_only()
-    @info.command(name="roles", aliases=["r"], usage="info roles")
     async def roles(self, ctx: commands.Context[Tux]) -> None:
         """
         List all roles in the server.
@@ -131,7 +152,10 @@ async def roles(self, ctx: commands.Context[Tux]) -> None:
 
         await self.paginated_embed(ctx, "Server Roles", "roles", guild.name, roles, 32)
 
-    @info.command(name="emotes", aliases=["e"], usage="info emotes")
+    @info.command(
+        name="emotes",
+        aliases=["e"],
+    )
     async def emotes(self, ctx: commands.Context[Tux]) -> None:
         """
         List all emotes in the server.