From 6534be809997f0b31ec7db0306ba0570c79c816c Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sat, 2 Apr 2022 19:13:10 +0000 Subject: Deploying to docs from @ python-discord/bot-core@765284a5e436f7786619a5ba4c312d75df5e9dee 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- output/botcore.async_stats.html | 306 +++++++++++++++++++++++++++++++++++ output/botcore.exts.html | 2 +- output/botcore.html | 166 ++++++++++++++++++- output/botcore.site_api.html | 34 ++-- output/botcore.utils.caching.html | 10 +- output/botcore.utils.channel.html | 12 +- output/botcore.utils.extensions.html | 306 ----------------------------------- output/botcore.utils.html | 5 +- output/botcore.utils.logging.html | 14 +- output/botcore.utils.members.html | 6 +- output/botcore.utils.regex.html | 8 +- output/botcore.utils.scheduling.html | 26 +-- 12 files changed, 528 insertions(+), 367 deletions(-) create mode 100644 output/botcore.async_stats.html delete mode 100644 output/botcore.utils.extensions.html (limited to 'output') diff --git a/output/botcore.async_stats.html b/output/botcore.async_stats.html new file mode 100644 index 00000000..99c54337 --- /dev/null +++ b/output/botcore.async_stats.html @@ -0,0 +1,306 @@ + + + + + + + + + async_stats - Bot Core v4.0.0 + + + + + + + + + + + + + + + + + + + + + + + + +

+ + +

+ + + Back to top + +

+ +

+ + + + +

async_stats#

An async transport method for statsd communication.

+class AsyncStatsClient(loop, host='localhost', port=8125, prefix=None)[source]#

Bases: statsd.client.base.StatsClientBase

An async implementation of statsd.client.base.StatsClientBase that supports async stat communication.

+__init__(loop, host='localhost', port=8125, prefix=None)[source]#

Create a new AsyncStatsClient.

Parameters

loop (asyncio.AbstractEventLoop) – The event loop to use when creating the +asyncio.loop.create_datagram_endpoint.
host (str) – The host to connect to.
port (int) – The port to connect to.
prefix (Optional[str]) – The prefix to use for all stats.

+async create_socket()[source]#

Use asyncio.loop.create_datagram_endpoint from the loop given on init to create a socket.

Return type: None
+

+ +

+ + + + + + \ No newline at end of file diff --git a/output/botcore.exts.html b/output/botcore.exts.html index cdb504a7..04c9917c 100644 --- a/output/botcore.exts.html +++ b/output/botcore.exts.html @@ -163,13 +163,13 @@

Utils

async_stats

site_api

diff --git a/output/botcore.html b/output/botcore.html index bab52adf..5b50ce0d 100644 --- a/output/botcore.html +++ b/output/botcore.html @@ -163,13 +163,13 @@

Utils

async_stats

site_api

@@ -212,6 +212,168 @@

Botcore#

Useful utilities and tools for Discord bot development.

+class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, **kwargs)[source]#

Bases: discord.ext.commands.bot.Bot

A sub-class that implements many common features that Python Discord bots use.

+__init__(*args, guild_id, allowed_roles, http_session, redis_session=None, **kwargs)[source]#

Initialise the base bot instance.

Parameters

guild_id (int) – The ID of the guild use for wait_until_guild_available().
allowed_roles (list) – A list of role IDs that the bot is allowed to mention.
http_session (aiohttp.ClientSession) – The session to use for the bot.
redis_session (Optional[RedisSession]) – The +[async_rediscache.RedisSession](https://github.com/SebastiaanZ/async-rediscache#creating-a-redissession) +to use for the bot.

+async add_cog(cog)[source]#

Add the given cog to the bot and log the operation.

Return type: None
+

+add_command(command)[source]#

Add command as normal and then add its root aliases to the bot.

Return type: None
+

+clear()[source]#

Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.

Return type: None
+

+async close()[source]#

Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.

Return type: None
+

+async load_extensions(module)[source]#

Load all the extensions within the given module and save them to self.all_extensions.

Return type: None
+

+async log_to_dev_log(message)[source]#

Log the given message to #dev-log.

Return type: None
+

+async on_guild_available(guild)[source]#

Set the internal guild available event when self.guild_id becomes available.

If the cache appears to still be empty (no members, no channels, or no roles), the event +will not be set and guild_available_but_cache_empty event will be emitted.

Return type: None
+

+async on_guild_unavailable(guild)[source]#

Clear the internal guild available event when self.guild_id becomes unavailable.

Return type: None
+

+async ping_services()[source]#

Ping all required services on setup to ensure they are up before starting.

Return type: None
+

+remove_command(name)[source]#

Remove a command/alias as normal and then remove its root aliases from the bot.

Individual root aliases cannot be removed by this function. +To remove them, either remove the entire command or manually edit bot.all_commands.

Return type: Optional[Command]
+

+async setup_hook()[source]#

An async init to startup generic services.

Connects to statsd, and calls +AsyncStatsClient.create_socket +and ping_services().

Return type: None
+

+async wait_until_guild_available()[source]#

Wait until the guild that matches the guild_id given at init is available (and the cache is ready).

The on_ready event is inadequate because it only waits 2 seconds for a GUILD_CREATE +gateway event before giving up and thus not populating the cache for unavailable guilds.

Return type: None
+

+exception StartupError(base)[source]#

Bases: Exception

Exception class for startup errors.

+__init__(base)[source]#

async_stats#

Botcore#

Subpackages#

Submodules#

extensions#