Beginning of help system

rocketbot/bot.py

@@ -5,7 +5,6 @@ from discord import Intents
 from discord.ext import commands
 
 from config import CONFIG
-from rocketbot.cogs.basecog import BaseCog
 from rocketbot.cogsetting import CogSetting
 from rocketbot.utils import bot_log, dump_stacktrace
 
@@ -54,6 +53,7 @@ class Rocketbot(commands.Bot):
 			return
 		self.__commands_set_up = True
 		for cog in self.cogs.values():
+			from rocketbot.cogs.basecog import BaseCog
 			if isinstance(cog, BaseCog):
 				bcog: BaseCog = cog
 				if len(bcog.settings) > 0:

rocketbot/cogs/basecog.py

@@ -12,14 +12,13 @@ from discord.app_commands.errors import CommandInvokeError
 from discord.ext.commands import Cog
 
 from config import CONFIG
+from rocketbot.bot import Rocketbot
 from rocketbot.botmessage import BotMessage, BotMessageReaction
 from rocketbot.cogsetting import CogSetting
 from rocketbot.collections import AgeBoundDict
 from rocketbot.storage import Storage
 from rocketbot.utils import bot_log, dump_stacktrace
 
-Rocketbot = 'rocketbot.bot.Rocketbot'
-
 class WarningContext:
 	def __init__(self, member: Member, warn_time: datetime):
 		self.member = member

rocketbot/cogs/generalcog.py

@@ -2,24 +2,74 @@
 Cog for handling most ungrouped commands and basic behaviors.
 """
 from datetime import datetime, timedelta, timezone
-from typing import Optional
+from typing import Optional, Union
 
-from discord import Interaction, Message, User
-from discord.app_commands import command, default_permissions, guild_only, Transform
+from discord import Interaction, Message, User, Permissions
+from discord.app_commands import Command, Group, command, default_permissions, guild_only, Transform, rename, Choice, \
+	autocomplete
 from discord.errors import DiscordException
 from discord.ext.commands import Cog
 
 from config import CONFIG
 from rocketbot.bot import Rocketbot
 from rocketbot.cogs.basecog import BaseCog, BotMessage
-from rocketbot.utils import describe_timedelta, TimeDeltaTransformer
+from rocketbot.utils import describe_timedelta, TimeDeltaTransformer, dump_stacktrace
 from rocketbot.storage import ConfigKey, Storage
 
+async def command_autocomplete(interaction: Interaction, current: str) -> list[Choice[str]]:
+	choices: list[Choice] = []
+	try:
+		if current.startswith('/'):
+			current = current[1:]
+		current = current.lower().strip()
+		user_permissions = interaction.permissions
+		cmds = GeneralCog.shared.get_command_list(user_permissions)
+		return [
+			Choice(name=f'/{cmdname}', value=f'/{cmdname}')
+			for cmdname in sorted(cmds.keys())
+			if len(current) == 0 or cmdname.startswith(current)
+		]
+	except BaseException as e:
+		dump_stacktrace(e)
+	return choices
+
+async def subcommand_autocomplete(interaction: Interaction, current: str) -> list[Choice[str]]:
+	try:
+		current = current.lower().strip()
+		cmd_name = interaction.namespace['command']
+		if cmd_name.startswith('/'):
+			cmd_name = cmd_name[1:]
+		user_permissions = interaction.permissions
+		cmd = GeneralCog.shared.get_command_list(user_permissions).get(cmd_name)
+		if cmd is None or not isinstance(cmd, Group):
+			print(f'No command found named {cmd_name}')
+			return []
+		grp = cmd
+		subcmds = GeneralCog.shared.get_subcommand_list(grp, user_permissions)
+		if subcmds is None:
+			print(f'Subcommands for {cmd_name} was None')
+			return []
+		return [
+			Choice(name=subcmd_name, value=subcmd_name)
+			for subcmd_name in sorted(subcmds.keys())
+			if len(current) == 0 or subcmd_name.startswith(current)
+		]
+	except BaseException as e:
+		dump_stacktrace(e)
+	return []
+
+def can_use_command(cmd: Union[Group, Command], user_permissions: Optional[Permissions]) -> bool:
+	return user_permissions is not None and \
+		(cmd.default_permissions is None or cmd.default_permissions.is_subset(user_permissions))
+
 class GeneralCog(BaseCog, name='General'):
 	"""
 	Cog for handling high-level bot functionality and commands. Should be the
 	first cog added to the bot.
 	"""
+
+	shared: Optional['GeneralCog'] = None
+
 	def __init__(self, bot: Rocketbot):
 		super().__init__(
 			bot,
@@ -31,6 +81,7 @@ class GeneralCog(BaseCog, name='General'):
 		self.is_first_connect = True
 		self.last_disconnect_time: Optional[datetime] = None
 		self.noteworthy_disconnect_duration = timedelta(seconds=5)
+		GeneralCog.shared = self
 
 	@Cog.listener()
 	async def on_connect(self):
@@ -144,3 +195,101 @@ class GeneralCog(BaseCog, name='General'):
 			f'messages by {user.mention}> from the past {describe_timedelta(age)}.',
 			ephemeral=True,
 		)
+
+	@command(name='help')
+	@guild_only()
+	@rename(command_name='command', subcommand_name='subcommand')
+	@autocomplete(command_name=command_autocomplete, subcommand_name=subcommand_autocomplete)
+	async def help_command(self, interaction: Interaction, command_name: Optional[str] = None, subcommand_name: Optional[str] = None) -> None:
+		"""
+		Shows help for using commands and subcommands.
+
+		`/help` will show a list of top-level commands.
+
+		`/help /<command_name>` will show help about a specific command or
+		list a command's subcommands.
+
+		`/help /<command_name> <subcommand_name>` will show help about a
+		specific subcommand.
+
+		Parameters
+		----------
+		interaction: Interaction
+		command_name: Optional[str]
+			Optional name of a command to get specific help for. With or without the leading slash.
+		subcommand_name: Optional[str]
+			Optional name of a subcommand to get specific help for.
+		"""
+		print(f'help_command(interaction, {command_name}, {subcommand_name})')
+		cmds: list[Command] = self.bot.tree.get_commands()
+		if command_name is None:
+			await self.__send_general_help(interaction)
+			return
+
+		if command_name.startswith('/'):
+			command_name = command_name[1:]
+		cmd = next((c for c in cmds if c.name == command_name), None)
+		if cmd is None:
+			interaction.response.send_message(
+				f'Command `{command_name}` not found!',
+				ephemeral=True,
+			)
+			return
+		if subcommand_name is None:
+			await self.__send_command_help(interaction, cmd)
+			return
+
+		if not isinstance(cmd, Group):
+			await self.__send_command_help(interaction, cmd, addendum=f'{CONFIG["warning_emoji"]} Command does not have subcommands. Showing help for base command.')
+			return
+		grp: Group = cmd
+		subcmd: Command = next((c for c in grp.commands if c.name == subcommand_name), None)
+		if subcmd is None:
+			await self.__send_command_help(interaction, cmd, addendum=f'{CONFIG["warning_emoji"]} Command `/{command_name}` does not have a subcommand "{subcommand_name}". Showing help for base command.')
+			return
+		await self.__send_subcommand_help(interaction, grp, subcmd)
+		return
+
+	def get_command_list(self, permissions: Optional[Permissions] = None) -> dict[str, Union[Command, Group]]:
+		return { cmd.name: cmd for cmd in self.bot.tree.get_commands() if can_use_command(cmd, permissions) }
+
+	def get_subcommand_list(self, cmd: Group, permissions: Optional[Permissions] = None) -> dict[str, Command]:
+		return { subcmd.name: subcmd for subcmd in cmd.commands if can_use_command(subcmd, permissions) }
+
+	async def __send_general_help(self, interaction: Interaction) -> None:
+		user_permissions: Permissions = interaction.permissions
+		text = f'## :information_source: Commands'
+		for cmd_name, cmd in sorted(self.get_command_list(user_permissions).items()):
+			text += f'\n- `/{cmd_name}`: {cmd.description}'
+		await interaction.response.send_message(
+			text,
+			ephemeral=True,
+		)
+
+	async def __send_command_help(self, interaction: Interaction, command_or_group: Union[Command, Group], addendum: Optional[str] = None) -> None:
+		text = ''
+		if addendum is not None:
+			text += addendum + '\n\n'
+		text += f'## :information_source: Command Help\n`/{command_or_group.name}`\n\n{command_or_group.description}'
+		if isinstance(command_or_group, Group):
+			subcmds: dict[str, Command] = self.get_subcommand_list(command_or_group, permissions=interaction.permissions)
+			if len(subcmds) > 0:
+				text += '\n\n### Subcommands:'
+				for subcmd_name, subcmd in sorted(subcmds.items()):
+					text += f'\n- `{subcmd_name}`: {subcmd.description}'
+		else:
+			params = command_or_group.parameters
+			if len(params) > 0:
+				text += '\n\n### Parameters:'
+				for param in params:
+					text += f'\n- `{param.name}`: {param.description}'
+		await interaction.response.send_message(text, ephemeral=True)
+
+	async def __send_subcommand_help(self, interaction: Interaction, group: Group, subcommand: Command) -> None:
+		text = f'## :information_source: Subcommand Help\n`/{group.name} {subcommand.name}`\n\n{subcommand.description}\n\n{subcommand.description}'
+		params = subcommand.parameters
+		if len(params) > 0:
+			text += '\n\n### Parameters:'
+			for param in params:
+				text += f'\n- `{param.name}`: {param.description}'
+		await interaction.response.send_message(text, ephemeral=True)

rocketbot/cogsetting.py

@@ -240,7 +240,7 @@ class CogSetting:
 
 		command = Command(
 			name=cog.config_prefix,
-			description=f'Enables {cog.config_prefix} functionality',
+			description=f'Enables {cog.name} functionality',
 			callback=enabler,
 			parent=CogSetting.__enable_group,
 		)