Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixed typo #191

Merged
merged 2 commits into from
Oct 20, 2024
Merged

fixed typo #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79ab584
fixed typo
oodvg May 28, 2024
eb0aff5
fix prefix help
oodvg Oct 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 10 additions & 39 deletions src/cogs/help.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@


async def send_embed(ctx, embed):

"""
Function that handles the sending of embeds
-> Takes context and embed to send
Expand All @@ -25,22 +26,19 @@ async def send_embed(ctx, embed):
- tries to send embed private with information abot missing permissions
If this all fails: https://youtu.be/dQw4w9WgXcQ
"""


try:
await ctx.respond(embed=embed)
except Forbidden:
try:
await ctx.respond("Hey, seems like I can't send embeds. Please check my permissions :)")
except Forbidden:
await ctx.author.respond(
await ctx.author.send(
f"Hey, seems like I can't send any message in {ctx.channel.name} on {ctx.guild.name}\n"
f"May you inform the server team about this issue? :slight_smile: ", embed=embed)


class Help(commands.Cog):
"""
Sends this help message
"""

def __init__(self, bot):
self.bot = bot

Expand All @@ -53,25 +51,18 @@ def __init__(self, bot):
)
async def help(self, ctx, module=None):
"""Shows all modules of the Miscellaneous bot"""

prefix = config['prefix'] if not ctx.is_app else '/'

async def predicate(cmd):
try:
return await cmd.can_run(ctx)
except commands.CommandError:
return False
# Check if the command is enabled and not hidden
return cmd.enabled if hasattr(cmd, 'enabled') else True

# checks if cog parameter was given
# if not: sending all modules and commands not associated with a cog
if not module:

# starting to build embed
emb = discord.Embed(title='Commands and modules', color=discord.Color.blue(),
description=f'Use `{prefix}help <module/command>` to gain more information about that module '
f':smiley:\n')

# iterating trough cogs, gathering descriptions
cogs_desc = ''
for cog in self.bot.cogs:
valid = False
Expand All @@ -82,24 +73,16 @@ async def predicate(cmd):
if valid:
cogs_desc += f'`{cog.capitalize()}` {self.bot.cogs[cog].__doc__}\n'

# adding 'list' of cogs to embed
emb.add_field(name='Modules', value=cogs_desc, inline=False)

# integrating trough uncategorized commands
commands_desc = ''
for command in self.bot.walk_commands():
# if cog not in a cog
# listing command if cog name is None
if not command.cog_name:
commands_desc += f'{command.name} - {command.help}\n'

# adding those commands to embed
if commands_desc:
emb.add_field(name='Not belonging to a module', value=commands_desc, inline=False)


# block called when one cog-name is given
# trying to find matching cog and it's commands
elif len(module.split()) == 1:
if module not in self.bot.cogs:
command = self.bot.get_command(module)
Expand All @@ -118,34 +101,25 @@ async def predicate(cmd):
await ctx.respond(embed=embed)
return

# iterating trough cogs
for cog in self.bot.cogs:
# check if cog is the matching one
if cog.lower() == module.lower():
# making title - getting description from doc-string below class
emb = discord.Embed(title=f'{cog.capitalize()} - Commands', description=self.bot.cogs[cog].__doc__,
color=discord.Color.green())

# getting commands from cog
for command in self.bot.get_cog(cog).get_commands()[0::3]: # Ignores all the duplicate commands returned by bridge slash commands
syntax = f"{prefix}{command.name}"
if not isinstance(command, discord.commands.SlashCommand):
for command in self.bot.get_cog(cog).get_commands():
if await predicate(command): # Check if the command can be run
syntax = f"{prefix}{command.name}"
for key, value in command.clean_params.items():
if not value.default:
syntax += " [" + key + "]"
else:
syntax += " <" + key + ">"
emb.add_field(name=f"`{syntax}`", value=command.help, inline=False)
else:
emb.add_field(name=f"`{syntax}`", value=command.description, inline=False)

emb.set_footer(
text="\n\n[] represent compulsory fields\n<> represent optional fields\nDo not type the brackets!")
# found cog - breaking loop
break

# if input not found
# yes, for-loops have an else statement, it's called when no 'break' was issued
else:
cogs_desc = ''
for cog in self.bot.cogs:
Expand All @@ -157,15 +131,12 @@ async def predicate(cmd):
emb.add_field(name="Here is a list of all the fields and their descriptions", value=cogs_desc)
emb.set_footer(text="Use ,help <module/command> to gain more information about that module/command")

# too many cogs requested - only one at a time allowed
elif len(module.split()) > 1:
emb = discord.Embed(title="That's too much.",
description="Please request only one module or one command at once :sweat_smile:",
color=discord.Color.orange())

# sending reply embed using our own function defined above
await send_embed(ctx, emb)


def setup(bot):
bot.add_cog(Help(bot))
2 changes: 1 addition & 1 deletion src/utils/consts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
The bot will ask you to choose the reason behind the creation of your ticket from a given list. Choose the appropriate reason and then proceed!\n
Once you have created your ticket, staff will respond within 24 hours.""",
color=neutral_color).add_field(name="Do-not-kick-list Application",
value="You must have a valid reason for applying and also meet the DNKL requiremnets.\n"
value="You must have a valid reason for applying and also meet the DNKL requirements.\n"
"Accepted Reasons:\n"
"> Exams\n"
"> Medical Reasons\n"
Expand Down