Add role and emote info commands #444
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's Guide by SourceryThis pull request adds two new subcommands to the existing 'info' command: 'roles' and 'emotes'. These subcommands allow users to list all roles and emotes in the server, respectively. The changes are implemented by adding two new asynchronous methods to the Info cog class. File-Level Changes
Tips
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @Atmois - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 2 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
Comment on lines
+110
to
+134
| @info.command(name="roles", description="Lists all roles in the server.") | ||
| async def roles(self, interaction: discord.Interaction) -> None: | ||
| """ | ||
| List all roles in the server. | ||
| Parameters | ||
| ---------- | ||
| interaction : discord.Interaction | ||
| The discord interaction object. | ||
| """ | ||
| if not interaction.guild: | ||
| return | ||
|
|
||
| guild = interaction.guild | ||
| roles = [role.mention for role in guild.roles] | ||
|
|
||
| embed = EmbedCreator.create_info_embed( | ||
| title="Server Roles", | ||
| description=f"Role list for {guild.name}", | ||
| interaction=interaction, | ||
| ) | ||
|
|
||
| embed.add_field(name="Roles", value=", ".join(roles), inline=False) | ||
|
|
||
| await interaction.response.send_message(embed=embed) |
Contributor
There was a problem hiding this comment.
suggestion: Refactor common code between 'roles' and 'emotes' commands
The 'roles' and 'emotes' commands have very similar structures. Consider refactoring the common parts into a separate method to reduce code duplication and improve maintainability.
async def _create_list_embed(self, interaction: discord.Interaction, title: str, items: list, item_name: str) -> None:
if not interaction.guild:
return
embed = EmbedCreator.create_info_embed(
title=title,
description=f"{item_name} list for {interaction.guild.name}",
interaction=interaction,
)
embed.add_field(name=item_name, value=", ".join(items), inline=False)
await interaction.response.send_message(embed=embed)
Comment on lines
+120
to
+121
| if not interaction.guild: | ||
| return |
Contributor
There was a problem hiding this comment.
suggestion: Improve error handling when there's no associated guild
Instead of silently returning when there's no guild associated with the interaction, consider providing feedback to the user, explaining why the command couldn't be executed.
Suggested change
| if not interaction.guild: | |
| return | |
| if not interaction.guild: | |
| await interaction.response.send_message("This command can only be used in a server.", ephemeral=True) | |
| return |
kzndotsh
approved these changes
Aug 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add two subcommands to show role list and emote list
Closes #430
Closes #431