mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
0870403299
API changes: - Cogs must now inherit from `commands.Cog` (see #2151 for discussion and more details) - All functions which are not decorators in the `redbot.core.checks` module are now deprecated in favour of their counterparts in `redbot.core.utils.mod`. This is to make this module more consistent and end the confusing naming convention. - `redbot.core.checks.check_overrides` function is now gone, overrideable checks can now be created with the `@commands.permissions_check` decorator - Command, Group, Cog and Context have some new attributes and methods, but they are for internal use so shouldn't concern cog creators (unless they're making a permissions cog!). - `__permissions_check_before` and `__permissions_check_after` have been replaced: A cog method named `__permissions_hook` will be evaluated as permissions hooks in the same way `__permissions_check_before` previously was. Permissions hooks can also be added/removed/verified through the new `*_permissions_hook()` methods on the bot object, and they will be verified even when permissions is unloaded. - New utility method `redbot.core.utils.chat_formatting.humanize_list` - New dependency [`schema`](https://github.com/keleshev/schema) User-facing changes: - When a `@bot_has_permissions` check fails, the bot will respond saying what permissions were actually missing. - All YAML-related `[p]permissions` subcommands now reside under the `[p]permissions acl` sub-group (tbh I still think the whole cog has too many top-level commands) - The YAML schema for these commands has been changed - A rule cannot be set as allow and deny at the same time (previously this would just default to allow) Documentation: - New documentation for `redbot.core.commands.requires` and `redbot.core.checks` modules - Renewed documentation for the permissions cog - `sphinx.ext.doctest` is now enabled Note: standard discord.py checks will still behave exactly the same way, in fact they are checked before `Requires` is looked at, so they are not overrideable. Signed-off-by: Toby Harradine <tobyharradine@gmail.com>
57 lines
1.7 KiB
Python
57 lines
1.7 KiB
Python
from typing import NamedTuple, Union, Optional
|
|
from redbot.core import commands
|
|
|
|
|
|
class CogOrCommand(NamedTuple):
|
|
type: str
|
|
name: str
|
|
obj: Union[commands.Command, commands.Cog]
|
|
|
|
# noinspection PyArgumentList
|
|
@classmethod
|
|
async def convert(cls, ctx: commands.Context, arg: str) -> "CogOrCommand":
|
|
cog = ctx.bot.get_cog(arg)
|
|
if cog:
|
|
return cls(type="COG", name=cog.__class__.__name__, obj=cog)
|
|
cmd = ctx.bot.get_command(arg)
|
|
if cmd:
|
|
return cls(type="COMMAND", name=cmd.qualified_name, obj=cmd)
|
|
|
|
raise commands.BadArgument(
|
|
'Cog or command "{arg}" not found. Please note that this is case sensitive.'
|
|
"".format(arg=arg)
|
|
)
|
|
|
|
|
|
class RuleType:
|
|
|
|
# noinspection PyUnusedLocal
|
|
@classmethod
|
|
async def convert(cls, ctx: commands.Context, arg: str) -> bool:
|
|
if arg.lower() in ("allow", "whitelist", "allowed"):
|
|
return True
|
|
if arg.lower() in ("deny", "blacklist", "denied"):
|
|
return False
|
|
|
|
raise commands.BadArgument(
|
|
'"{arg}" is not a valid rule. Valid rules are "allow" or "deny"'.format(arg=arg)
|
|
)
|
|
|
|
|
|
class ClearableRuleType:
|
|
|
|
# noinspection PyUnusedLocal
|
|
@classmethod
|
|
async def convert(cls, ctx: commands.Context, arg: str) -> Optional[bool]:
|
|
if arg.lower() in ("allow", "whitelist", "allowed"):
|
|
return True
|
|
if arg.lower() in ("deny", "blacklist", "denied"):
|
|
return False
|
|
if arg.lower() in ("clear", "reset"):
|
|
return None
|
|
|
|
raise commands.BadArgument(
|
|
'"{arg}" is not a valid rule. Valid rules are "allow" or "deny", or "clear" to '
|
|
"remove the rule".format(arg=arg)
|
|
)
|