CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Improve unreleased Command.is_enabled() and document related methods (#6209)

Browse Source 
Co-authored-by: Michael Oliveira <34169552+Flame442@users.noreply.github.com>
This commit is contained in:
Jakub Kuczys 2023-07-24 03:12:33 +02:00 committed by GitHub
parent df7bbe5b55
commit 6f920daeed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
redbot/core/commands/commands.py
View File

@ -461,11 +461,32 @@ class Command(CogCommandMixin, DPYCommand):
if not change_permission_state:
ctx.permission_state = original_state
def is_enabled(self, ctx) -> bool:
def is_enabled(self, guild: Optional[discord.abc.Snowflake] = None) -> bool:
"""
Check if the command is enabled globally or in a guild.
When guild is provided, this method checks whether
the command is enabled both globally and in the guild.
This is generally set by the settings managed with
the ``[p]command enable/disable global/server`` commands.
Parameters
----------
guild : discord.abc.Snowflake, optional
The guild to check that the command is enabled in.
If this is ``None``, this will check whether
the command is enabled globally.
Returns
-------
bool
``True`` if the command is enabled.
"""
if not self.enabled:
return False
if ctx.guild:
if self._disabled_in.has(ctx.guild.id):
if guild is not None:
if self._disabled_in.has(guild.id):
return False
return True
@ -473,7 +494,7 @@ class Command(CogCommandMixin, DPYCommand):
async def prepare(self, ctx, /):
ctx.command = self
cmd_enabled = self.is_enabled(ctx)
cmd_enabled = self.is_enabled(ctx.guild)
if not cmd_enabled:
raise DisabledCommand(f"{self.name} command is disabled")
@ -530,7 +551,15 @@ class Command(CogCommandMixin, DPYCommand):
return True
def disable_in(self, guild: discord.Guild) -> bool:
"""Disable this command in the given guild.
"""
Disable this command in the given guild.
This is generally called by the settings managed with
the ``[p]command disable global/server`` commands.
Any changes made outside of that will not persist after cog
reload and may also be affected when either of those commands
is called on this command. It is not recommended to rely on
this method, if you want a consistent behavior.
Parameters
----------
@ -541,7 +570,6 @@ class Command(CogCommandMixin, DPYCommand):
-------
bool
``True`` if the command wasn't already disabled.
"""
if self._disabled_in.has(guild.id):
return False
@ -552,6 +580,13 @@ class Command(CogCommandMixin, DPYCommand):
def enable_in(self, guild: discord.Guild) -> bool:
"""Enable this command in the given guild.
This is generally called by the settings managed with
the ``[p]command disable global/server`` commands.
Any changes made outside of that will not persist after cog
reload and may also be affected when either of those commands
is called on this command. It is not recommended to rely on
this method, if you want a consistent behavior.
Parameters
----------
guild : discord.Guild
@ -561,7 +596,6 @@ class Command(CogCommandMixin, DPYCommand):
-------
bool
``True`` if the command wasn't already enabled.
"""
try:
self._disabled_in.remove(guild.id)