RedBase(*args, cli_flags=None, bot_dir: pathlib.Path = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/red-discordbot/checkouts/3.1.2/docs'), **kwargs)¶
Mixin for the main bot class.
Registers a method to act as an RPC handler if the internal RPC server is active.
When calling this method through the RPC server, use the naming scheme “cogname__methodname”.
All parameters to RPC handler methods must be JSON serializable objects. The return value of handler methods must also be JSON serializable.
Parameters: method (coroutine) – The method to register with the internal RPC server.
Unregisters an RPC method handler.
This will be called automatically for you on cog unload and will pass silently if the method is not previously registered.
Parameters: method (coroutine) – The method to unregister from the internal RPC server.
Adds a “cog” to the bot.
A cog is a class that has its own event listeners and commands.
Cog) – The cog to register to the bot.
TypeError– The cog does not inherit from
CommandError– An error happened during loading.
add_permissions_hook(hook: Callable[[Context], Union[bool, None, Awaitable[Optional[bool]]]]) → None¶
Add a permissions hook.
Permissions hooks are check predicates which are called before calling
Requires.verify, and they can optionally return an override:
Falseto deny, and
Noneto default to normal behaviour.
Parameters: hook – A command check predicate which returns
clear_permission_rules(guild_id: Optional[int]) → None¶
Clear all permission overrides in a scope.
Parameters: guild_id (Optional[int]) – The guild ID to wipe permission overrides for. If
None, this will clear all global rules and leave all guild rules untouched.
embed_requested(channel, user, command=None) → bool¶
Determine if an embed is requested for a response.
Trueif an embed is requested
get_owner_notification_destinations() → List[discord.abc.Messageable]¶
Gets the users and channels to send to
Checks if a member is an admin of their guild.
is_automod_immune(to_check: Union[discord.message.Message, redbot.core.commands.context.Context, discord.abc.User, discord.role.Role]) → bool¶
Checks if the user, message, context, or role should be considered immune from automated moderation actions.
This will return
Falsein direct messages.
Parameters: to_check (
discord.Role) – Something to check if it would be immune
Return type: bool
Checks if a member is a mod or admin of their guild.
Checks if a
Memberis the owner of this bot.
owner_idis not set, it is fetched automatically through the use of
Parameters: user (
abc.User) – The user to check for.
Lists packages present in the cogs the folder
Loads an extension.
An extension is a python module that contains commands, cogs, or listeners.
An extension must have a global function,
setupdefined as the entry point on what to do when the extension is loaded. This entry point must have a single argument, the
str) – The extension name to load. It must be dot separated like regular Python imports if accessing a sub-module. e.g.
foo.testif you want to import
ExtensionNotFound– The extension could not be imported.
ExtensionAlreadyLoaded– The extension is already loaded.
NoEntryPointError– The extension does not have a setup function.
ExtensionFailed– The extension setup function had an execution error.
modification from the base to do the same thing in the command case
but dispatch an additional event for cogs which want to handle normal messages differently to command messages, without the overhead of additional get_context calls per cog
Removes a cog from the bot.
All registered commands and event listeners that the cog has registered will be removed as well.
If no cog is found then this method has no effect.
Parameters: name (
str) – The name of the cog to remove.
remove_permissions_hook(hook: Callable[[Context], Union[bool, None, Awaitable[Optional[bool]]]]) → None¶
Remove a permissions hook.
Parameters are the same as those in
ValueError– If the permissions hook has not been added.
send_filtered(destination: discord.abc.Messageable, filter_mass_mentions=True, filter_invite_links=True, filter_all_links=False, **kwargs)¶
This is a convienience wrapper around
It takes the destination you’d like to send to, which filters to apply (defaults on mass mentions, and invite links) and any other parameters normally accepted by destination.send
This should realistically only be used for responding using user provided input. (unfortunately, including usernames) Manually crafted messages which dont take any user input have no need of this
send_help_for(ctx: redbot.core.commands.context.Context, help_for: Union[redbot.core.commands.commands.Command, redbot.core.commands.commands.GroupMixin, str])¶
Invokes Red’s helpformatter for a given context and object.
This sends something to all owners and their configured extra destinations.
This takes the same arguments as discord.abc.Messageable.send
This logs failing sends
verify_permissions_hooks(ctx: redbot.core.commands.context.Context) → Optional[bool]¶
Run permissions hooks.
Parameters: ctx (commands.Context) – The context for the command being invoked. Returns:
Falseif any hooks returned
Trueif any hooks return
Trueand none returned
Return type: Optional[bool]
Red(*args, cli_flags=None, bot_dir: pathlib.Path = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/red-discordbot/checkouts/3.1.2/docs'), **kwargs)¶
You’re welcome Caleb.
Logs out of Discord and closes all connections.