fix: enable the banning nonserver users #981
Open
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
Reviewer's GuideThe ban command has been refactored to accept discord.User instead of discord.Member, enabling the bot to ban users who are not members of the server by updating the signature, permission check, and ban execution accordingly. Sequence diagram for banning a non-server membersequenceDiagram
actor Moderator
participant Bot
participant Guild
participant User
Moderator->>Bot: Invoke ban command with User (not a member)
Bot->>Bot: check_conditions(ctx, user, ctx.author, "ban")
alt Permission granted
Bot->>Guild: ban(user, reason, delete_message_seconds)
Bot->>User: Attempt DM (may fail)
else Permission denied
Bot-->>Moderator: Abort ban
end
Class diagram for updated ban command parameterclassDiagram
class BanCommand {
+ban(ctx: commands.Context[Tux], user: discord.User, flags: BanFlags)
}
class discord.User
class discord.Member
BanCommand ..> discord.User : now accepts
BanCommand ..x discord.Member : no longer accepts
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @cherryl1k - I've reviewed your changes - here's some feedback:
- Update the method docstring and internal comments to reflect that it now accepts a discord.User instead of a member.
- Verify that check_conditions is fully compatible with discord.User inputs (not only discord.Member).
- Consider renaming the
userparameter to something more descriptive (e.g.targetoruser_to_ban) to avoid confusion.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Update the method docstring and internal comments to reflect that it now accepts a discord.User instead of a member.
- Verify that check_conditions is fully compatible with discord.User inputs (not only discord.Member).
- Consider renaming the `user` parameter to something more descriptive (e.g. `target` or `user_to_ban`) to avoid confusion.
## Individual Comments
### Comment 1
<location> `tux/cogs/moderation/ban.py:63` </location>
<code_context>
silent=flags.silent,
dm_action="banned",
actions=[
- (ctx.guild.ban(member, reason=flags.reason, delete_message_seconds=flags.purge * 86400), type(None)),
+ (ctx.guild.ban(user, reason=flags.reason, delete_message_seconds=flags.purge * 86400), type(None)),
],
)
</code_context>
<issue_to_address>
Banning by discord.User may fail if the user is not in the guild and the API expects a user ID.
If the user isn't cached or present in the guild, pass user.id to ctx.guild.ban to prevent API errors.
</issue_to_address>
<suggested_fix>
<<<<<<< SEARCH
actions=[
(ctx.guild.ban(user, reason=flags.reason, delete_message_seconds=flags.purge * 86400), type(None)),
],
=======
actions=[
(ctx.guild.ban(user.id, reason=flags.reason, delete_message_seconds=flags.purge * 86400), type(None)),
],
>>>>>>> REPLACE
</suggested_fix>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
60
to
-63
| dm_action="banned", | ||
| actions=[ | ||
| (ctx.guild.ban(member, reason=flags.reason, delete_message_seconds=flags.purge * 86400), type(None)), |
There was a problem hiding this comment.
suggestion (bug_risk): Banning by discord.User may fail if the user is not in the guild and the API expects a user ID.
If the user isn't cached or present in the guild, pass user.id to ctx.guild.ban to prevent API errors.
Suggested change
| dm_action="banned", | |
| actions=[ | |
| (ctx.guild.ban(member, reason=flags.reason, delete_message_seconds=flags.purge * 86400), type(None)), | |
| actions=[ | |
| (ctx.guild.ban(user.id, reason=flags.reason, delete_message_seconds=flags.purge * 86400), type(None)), | |
| ], |
Deploying tux with
|
| Latest commit: |
8b08331
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0d5c2f79.tux-afh.pages.dev |
| Branch Preview URL: | https://ban-fix.tux-afh.pages.dev |
cherryl1k
changed the title
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.
Description
Changed ban.py to allow non-server members to be banned previously
Guidelines
My code follows the style guidelines of this project (formatted with Ruff)
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation if needed
My changes generate no new warnings
I have tested this change
Any dependent changes have been merged and published in downstream modules
I have added all appropriate labels to this PR
I have followed all of these guidelines.
How Has This Been Tested? (if applicable)
tested with an admin account and unprivileged alt both attempting to ban a current guild member and a non-guild member
Additional Information
it does give a warning for not being able to DM a user (obviously this is because they're not apart of the guild)
i also got a warning for "No guild config found for guild_id" but i am pretty sure this is due to my server
Summary by Sourcery
Bug Fixes: