Bot

RedBase

class redbot.core.bot.RedBase(*args, cli_flags=None, bot_dir: pathlib.Path = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/red-discordbot/checkouts/3.0.2/docs'), **kwargs)[source]

Mixin for the main bot class.

This exists because Red inherits from discord.AutoShardedClient, which is something other bot classes (namely selfbots) may not want to have as a parent class.

Selfbots should inherit from this mixin along with discord.Client.

register_rpc_handler(method)

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”.

Important

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.
unregister_rpc_handler(method)

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.
add_cog(cog: redbot.core.commands.commands.Cog)[source]

Adds a “cog” to the bot.

A cog is a class that has its own event listeners and commands.

They are meant as a way to organize multiple relevant commands into a singular class that shares some state or no state at all.

The cog can also have a __global_check member function that allows you to define a global check. See check() for more info. If the name is __global_check_once then it’s equivalent to the check_once() decorator.

More information will be documented soon.

Parameters:cog – The cog to register to the bot.
add_command(command: redbot.core.commands.commands.Command)[source]

Adds a Command or its superclasses into the internal list of commands.

This is usually not called, instead the command() or group() shortcut decorators are used instead.

Parameters:

command – The command to add.

Raises:
  • ClientException – If the command is already registered.
  • TypeError – If the command passed is not a subclass of Command.
add_permissions_hook(hook: Callable[Context, Union[bool, None, Awaitable[Optional[bool]]]]) → None[source]

Add a permissions hook.

Permissions hooks are check predicates which are called before calling Requires.verify, and they can optionally return an override: True to allow, False to deny, and None to default to normal behaviour.

Parameters:hook – A command check predicate which returns True, False or None.
clear_permission_rules(guild_id: Optional[int]) → None[source]

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.
disable_sentry()[source]

Disable Sentry logging for Red.

coroutine embed_requested(channel, user, command=None) → bool[source]

Determine if an embed is requested for a response.

Parameters:
Returns:

True if an embed is requested

Return type:

bool

enable_sentry()[source]

Enable Sentry logging for Red.

coroutine is_admin(member: discord.member.Member)[source]

Checks if a member is an admin of their guild.

coroutine is_automod_immune(to_check: Union[discord.message.Message, redbot.core.commands.context.Context, discord.abc.User, discord.role.Role]) → bool[source]

Checks if the user, message, context, or role should be considered immune from automated moderation actions.

This will return False in direct messages.

Parameters:to_check (discord.Message or commands.Context or discord.abc.User or discord.Role) – Something to check if it would be immune
Returns:True if immune
Return type:bool
coroutine is_mod(member: discord.member.Member)[source]

Checks if a member is a mod or admin of their guild.

coroutine is_owner(user)[source]

Checks if a User or Member is the owner of this bot.

If an owner_id is not set, it is fetched automatically through the use of application_info().

Parameters:user (abc.User) – The user to check for.
static list_packages()[source]

Lists packages present in the cogs the folder

coroutine load_extension(spec: _frozen_importlib.ModuleSpec)[source]

Loads an extension.

An extension is a python module that contains commands, cogs, or listeners.

An extension must have a global function, setup defined as the entry point on what to do when the extension is loaded. This entry point must have a single argument, the bot.

Parameters:

name (str) – The extension name to load. It must be dot separated like regular Python imports if accessing a sub-module. e.g. foo.test if you want to import foo/test.py.

Raises:
  • ClientException – The extension does not have a setup function.
  • ImportError – The extension could not be imported.
remove_cog(cogname: str)[source]

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.

If the cog defines a special member function named __unload then it is called when removal has completed. This function cannot be a coroutine. It must be a regular function.

Parameters:name (str) – The name of the cog to remove.
remove_permissions_hook(hook: Callable[Context, Union[bool, None, Awaitable[Optional[bool]]]]) → None[source]

Remove a permissions hook.

Parameters are the same as those in add_permissions_hook.

Raises:ValueError – If the permissions hook has not been added.
coroutine send_filtered(destination: discord.abc.Messageable, filter_mass_mentions=True, filter_invite_links=True, filter_all_links=False, **kwargs)[source]

This is a convienience wrapper around

discord.abc.Messageable.send

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

unload_extension(name)[source]

Unloads an extension.

When the extension is unloaded, all commands, listeners, and cogs are removed from the bot and the module is un-imported.

The extension can provide an optional global function, teardown, to do miscellaneous clean-up if necessary. This function takes a single parameter, the bot, similar to setup from load_extension().

Parameters:name (str) – The extension name to unload. It must be dot separated like regular Python imports if accessing a sub-module. e.g. foo.test if you want to import foo/test.py.
coroutine verify_permissions_hooks(ctx: redbot.core.commands.context.Context) → Optional[bool][source]

Run permissions hooks.

Parameters:ctx (commands.Context) – The context for the command being invoked.
Returns:False if any hooks returned False, True if any hooks return True and none returned False, None otherwise.
Return type:Optional[bool]

Red

class redbot.core.bot.Red(*args, cli_flags=None, bot_dir: pathlib.Path = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/red-discordbot/checkouts/3.0.2/docs'), **kwargs)[source]

You’re welcome Caleb.

coroutine logout()[source]

Logs out of Discord and closes all connections.

coroutine shutdown(*, restart: bool = False)[source]

Gracefully quit Red.

The program will exit with code 0 by default.

Parameters:restart (bool) – If True, the program will exit with code 26. If the launcher sees this, it will attempt to restart the bot.