Downloader Cog Reference¶
-
class
redbot.cogs.downloader.downloader.
Downloader
(bot: redbot.core.bot.Red)[source]¶ -
coroutine
cog_install_path
()[source]¶ Get the current cog install path.
Returns: The default cog install path. Return type: pathlib.Path
-
cog_name_from_instance
(instance: object) → str[source]¶ Determines the cog name that Downloader knows from the cog instance.
Probably.
Parameters: instance (object) – The cog instance. Returns: The name of the cog according to Downloader.. Return type: str
-
format_findcog_info
(command_name: str, cog_installable: object = None) → str[source]¶ Format a cog’s info for output to discord.
Parameters: - command_name (str) – Name of the command which belongs to the cog.
- cog_installable (
Installable
orobject
) – Can be anInstallable
instance or a Cog instance.
Returns: A formatted message for the user.
Return type:
-
coroutine
installed_cogs
() → typing.Tuple[redbot.cogs.downloader.installable.Installable][source]¶ Get info on installed cogs.
Returns: All installed cogs / shared lib directories. Return type: tuple
ofInstallable
-
coroutine
is_installed
(cog_name: str) -> (<class 'bool'>, typing.Union[redbot.cogs.downloader.installable.Installable, NoneType])[source]¶ Check to see if a cog has been installed through Downloader.
Parameters: cog_name (str) – The name of the cog to check for. Returns: (True, Installable)
if the cog is installed, else(False, None)
.Return type: tuple
of (bool
,Installable
)
-
coroutine