From df932c10ba91606ca017e4d108f8d1ec6d91c34f Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Thu, 21 Apr 2022 21:05:06 +0000 Subject: Deploying to docs from @ python-discord/bot-core@21628902bb370d4bd4d83e1320c4dd4f19cfbc35 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .doctrees/environment.pickle | Bin 2368527 -> 2368527 bytes .doctrees/output/botcore.async_stats.doctree | Bin 19331 -> 19331 bytes .doctrees/output/botcore.doctree | Bin 60906 -> 60906 bytes .doctrees/output/botcore.site_api.doctree | Bin 66667 -> 66667 bytes .doctrees/output/botcore.utils.caching.doctree | Bin 16685 -> 16685 bytes .doctrees/output/botcore.utils.channel.doctree | Bin 18244 -> 18244 bytes .doctrees/output/botcore.utils.doctree | Bin 14400 -> 14400 bytes .doctrees/output/botcore.utils.logging.doctree | Bin 18508 -> 18508 bytes .doctrees/output/botcore.utils.members.doctree | Bin 17169 -> 17169 bytes .doctrees/output/botcore.utils.regex.doctree | Bin 7656 -> 7656 bytes .doctrees/output/botcore.utils.scheduling.doctree | Bin 56358 -> 56358 bytes output/botcore.async_stats.html | 6 ++-- output/botcore.html | 32 +++++++++++----------- output/botcore.site_api.html | 26 +++++++++--------- output/botcore.utils.caching.html | 8 +++--- output/botcore.utils.channel.html | 4 +-- output/botcore.utils.html | 4 +-- output/botcore.utils.logging.html | 6 ++-- output/botcore.utils.members.html | 4 +-- output/botcore.utils.regex.html | 6 ++-- output/botcore.utils.scheduling.html | 18 ++++++------ 21 files changed, 57 insertions(+), 57 deletions(-) diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index ec6bdd29..0dfbb2b5 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/.doctrees/output/botcore.async_stats.doctree b/.doctrees/output/botcore.async_stats.doctree index 926b759b..dc702b03 100644 Binary files a/.doctrees/output/botcore.async_stats.doctree and b/.doctrees/output/botcore.async_stats.doctree differ diff --git a/.doctrees/output/botcore.doctree b/.doctrees/output/botcore.doctree index 3cf599d9..2aba4c6a 100644 Binary files a/.doctrees/output/botcore.doctree and b/.doctrees/output/botcore.doctree differ diff --git a/.doctrees/output/botcore.site_api.doctree b/.doctrees/output/botcore.site_api.doctree index ab224944..d946f3f4 100644 Binary files a/.doctrees/output/botcore.site_api.doctree and b/.doctrees/output/botcore.site_api.doctree differ diff --git a/.doctrees/output/botcore.utils.caching.doctree b/.doctrees/output/botcore.utils.caching.doctree index 324d02e9..4ff35277 100644 Binary files a/.doctrees/output/botcore.utils.caching.doctree and b/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/.doctrees/output/botcore.utils.channel.doctree b/.doctrees/output/botcore.utils.channel.doctree index 03202e8e..255f320f 100644 Binary files a/.doctrees/output/botcore.utils.channel.doctree and b/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/.doctrees/output/botcore.utils.doctree b/.doctrees/output/botcore.utils.doctree index 965b1c7c..b23ea91e 100644 Binary files a/.doctrees/output/botcore.utils.doctree and b/.doctrees/output/botcore.utils.doctree differ diff --git a/.doctrees/output/botcore.utils.logging.doctree b/.doctrees/output/botcore.utils.logging.doctree index 7f6a66a3..f6b39c95 100644 Binary files a/.doctrees/output/botcore.utils.logging.doctree and b/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/.doctrees/output/botcore.utils.members.doctree b/.doctrees/output/botcore.utils.members.doctree index 70917389..e716ab1d 100644 Binary files a/.doctrees/output/botcore.utils.members.doctree and b/.doctrees/output/botcore.utils.members.doctree differ diff --git a/.doctrees/output/botcore.utils.regex.doctree b/.doctrees/output/botcore.utils.regex.doctree index c99855eb..d62501e1 100644 Binary files a/.doctrees/output/botcore.utils.regex.doctree and b/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/.doctrees/output/botcore.utils.scheduling.doctree b/.doctrees/output/botcore.utils.scheduling.doctree index c448eb90..6aade39f 100644 Binary files a/.doctrees/output/botcore.utils.scheduling.doctree and b/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/output/botcore.async_stats.html b/output/botcore.async_stats.html index 693166a8..960b8fce 100644 --- a/output/botcore.async_stats.html +++ b/output/botcore.async_stats.html @@ -218,12 +218,12 @@

An async transport method for statsd communication.

-class AsyncStatsClient(loop, host='localhost', port=8125, prefix=None)[source]#
+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]#
+__init__(loop, host='localhost', port=8125, prefix=None)[source]#

Create a new AsyncStatsClient.

Parameters
@@ -239,7 +239,7 @@
-async create_socket()[source]#
+async create_socket()[source]#

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

Return type
diff --git a/output/botcore.html b/output/botcore.html index 608a7c96..1d20039b 100644 --- a/output/botcore.html +++ b/output/botcore.html @@ -218,12 +218,12 @@

Useful utilities and tools for Discord bot development.

-class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, **kwargs)[source]#
+class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=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, api_client=None, **kwargs)[source]#
+__init__(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, **kwargs)[source]#

Initialise the base bot instance.

Parameters
@@ -239,7 +239,7 @@
-async add_cog(cog)[source]#
+async add_cog(cog)[source]#

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

Return type
@@ -249,7 +249,7 @@
-add_command(command)[source]#
+add_command(command)[source]#

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

Return type
@@ -259,7 +259,7 @@
-clear()[source]#
+clear()[source]#

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

Return type
@@ -269,7 +269,7 @@
-async close()[source]#
+async close()[source]#

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

Return type
@@ -279,7 +279,7 @@
-async load_extensions(module)[source]#
+async load_extensions(module)[source]#

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

This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

@@ -290,7 +290,7 @@
-async log_to_dev_log(message)[source]#
+async log_to_dev_log(message)[source]#

Log the given message to #dev-log.

Return type
@@ -300,7 +300,7 @@
-async on_guild_available(guild)[source]#
+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.

@@ -312,7 +312,7 @@ will not be set and guild_available_but_cache_empty event will be e
-async on_guild_unavailable(guild)[source]#
+async on_guild_unavailable(guild)[source]#

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

Return type
@@ -322,7 +322,7 @@ will not be set and guild_available_but_cache_empty event will be e
-async ping_services()[source]#
+async ping_services()[source]#

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

Return type
@@ -332,7 +332,7 @@ will not be set and guild_available_but_cache_empty event will be e
-remove_command(name)[source]#
+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.

@@ -344,7 +344,7 @@ To remove them, either remove the entire command or manually edit bot.all_
-async setup_hook()[source]#
+async setup_hook()[source]#

An async init to startup generic services.

Connects to statsd, and calls AsyncStatsClient.create_socket @@ -357,7 +357,7 @@ and

-async wait_until_guild_available()[source]#
+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.

@@ -370,12 +370,12 @@ gateway event before giving up and thus not populating the cache for unavailable
-exception StartupError(base)[source]#
+exception StartupError(base)[source]#

Bases: Exception

Exception class for startup errors.

-__init__(base)[source]#
+__init__(base)[source]#
diff --git a/output/botcore.site_api.html b/output/botcore.site_api.html index e39b63b6..ac3f78af 100644 --- a/output/botcore.site_api.html +++ b/output/botcore.site_api.html @@ -218,12 +218,12 @@

An API wrapper around the Site API.

-class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
+class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#

Bases: object

A wrapper for the Django Site API.

-__init__(site_api_url, site_api_token, **session_kwargs)[source]#
+__init__(site_api_url, site_api_token, **session_kwargs)[source]#

Initialize a new APIClient instance.

Parameters
@@ -237,7 +237,7 @@
-async close()[source]#
+async close()[source]#

Close the aiohttp session.

Return type
@@ -247,7 +247,7 @@
-async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#
+async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

Send a DELETE request to the site API and return the JSON response.

Parameters
@@ -267,7 +267,7 @@
-async get(endpoint, *, raise_for_status=True, **kwargs)[source]#
+async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

Equivalent to APIClient.request() with GET passed as the method.

Return type
@@ -277,7 +277,7 @@
-async maybe_raise_for_status(response, should_raise)[source]#
+async maybe_raise_for_status(response, should_raise)[source]#

Raise ResponseCodeError for non-OK response if an exception should be raised.

Parameters
@@ -296,7 +296,7 @@
-async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#
+async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

Equivalent to APIClient.request() with PATCH passed as the method.

Return type
@@ -306,7 +306,7 @@
-async post(endpoint, *, raise_for_status=True, **kwargs)[source]#
+async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

Equivalent to APIClient.request() with POST passed as the method.

Return type
@@ -316,7 +316,7 @@
-async put(endpoint, *, raise_for_status=True, **kwargs)[source]#
+async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

Equivalent to APIClient.request() with PUT passed as the method.

Return type
@@ -326,7 +326,7 @@
-async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#
+async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

Send an HTTP request to the site API and return the JSON response.

Parameters
@@ -351,12 +351,12 @@
-exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
+exception ResponseCodeError(response, response_json=None, response_text=None)[source]#

Bases: ValueError

Raised in APIClient.request() when a non-OK HTTP response is received.

-__init__(response, response_json=None, response_text=None)[source]#
+__init__(response, response_json=None, response_text=None)[source]#

Initialize a new ResponseCodeError instance.

Parameters
@@ -370,7 +370,7 @@
-__str__()[source]#
+__str__()[source]#

Return a string representation of the error.

diff --git a/output/botcore.utils.caching.html b/output/botcore.utils.caching.html index f2550b6e..a8d9916e 100644 --- a/output/botcore.utils.caching.html +++ b/output/botcore.utils.caching.html @@ -218,14 +218,14 @@

Utilities related to custom caches.

-class AsyncCache(max_size=128)[source]#
+class AsyncCache(max_size=128)[source]#

Bases: object

LRU cache implementation for coroutines.

Once the cache exceeds the maximum size, keys are deleted in FIFO order.

An offset may be optionally provided to be applied to the coroutine’s arguments when creating the cache key.

-__call__(arg_offset=0)[source]#
+__call__(arg_offset=0)[source]#

Decorator for async cache.

Parameters
@@ -241,7 +241,7 @@
-__init__(max_size=128)[source]#
+__init__(max_size=128)[source]#

Initialise a new AsyncCache instance.

Parameters
@@ -251,7 +251,7 @@
-clear()[source]#
+clear()[source]#

Clear cache instance.

Return type
diff --git a/output/botcore.utils.channel.html b/output/botcore.utils.channel.html index 64c05622..fcd147b3 100644 --- a/output/botcore.utils.channel.html +++ b/output/botcore.utils.channel.html @@ -218,7 +218,7 @@

Useful helper functions for interacting with various discord channel objects.

-async get_or_fetch_channel(bot, channel_id)[source]#
+async get_or_fetch_channel(bot, channel_id)[source]#

Attempt to get or fetch the given channel_id from the bots cache, and return it.

Parameters
@@ -245,7 +245,7 @@
-is_in_category(channel, category_id)[source]#
+is_in_category(channel, category_id)[source]#

Return whether the given channel in the the category with the id category_id.

Parameters
diff --git a/output/botcore.utils.html b/output/botcore.utils.html index a433e947..674202d3 100644 --- a/output/botcore.utils.html +++ b/output/botcore.utils.html @@ -218,7 +218,7 @@

Useful utilities and tools for Discord bot development.

-apply_monkey_patches()[source]#
+apply_monkey_patches()[source]#

Applies all common monkey patches for our bots.

Patches discord.ext.commands.Command and discord.ext.commands.Group to support root aliases.

A root_aliases keyword argument is added to these two objects, which is a sequence of alias names @@ -236,7 +236,7 @@ that will act as top-level groups rather than being aliases of the command’s g

-unqualify(name)[source]#
+unqualify(name)[source]#

Return an unqualified name given a qualified module/package name.

Parameters
diff --git a/output/botcore.utils.logging.html b/output/botcore.utils.logging.html index 50ed560b..bce1aa30 100644 --- a/output/botcore.utils.logging.html +++ b/output/botcore.utils.logging.html @@ -218,12 +218,12 @@

Common logging related functions.

-class CustomLogger(name, level=0)[source]#
+class CustomLogger(name, level=0)[source]#

Bases: logging.Logger

Custom implementation of the logging.Logger class with an added trace method.

-trace(msg, *args, **kwargs)[source]#
+trace(msg, *args, **kwargs)[source]#

Log the given message with the severity "TRACE".

To pass exception information, use the keyword argument exc_info with a true value:

logger.trace("Houston, we have an %s", "interesting problem", exc_info=1)
@@ -245,7 +245,7 @@
-get_logger(name=None)[source]#
+get_logger(name=None)[source]#

Utility to make mypy recognise that logger is of type CustomLogger.

Parameters
diff --git a/output/botcore.utils.members.html b/output/botcore.utils.members.html index 61a6872b..4d3ebda1 100644 --- a/output/botcore.utils.members.html +++ b/output/botcore.utils.members.html @@ -218,7 +218,7 @@

Useful helper functions for interactin with discord.Member objects.

-async get_or_fetch_member(guild, member_id)[source]#
+async get_or_fetch_member(guild, member_id)[source]#

Attempt to get a member from cache; on failure fetch from the API.

Return type
@@ -231,7 +231,7 @@
-async handle_role_change(member, coro, role)[source]#
+async handle_role_change(member, coro, role)[source]#

Await the given coro with member as the sole argument.

Handle errors that we expect to be raised from discord.Member.add_roles and discord.Member.remove_roles.

diff --git a/output/botcore.utils.regex.html b/output/botcore.utils.regex.html index bd1fe6f4..08494cbf 100644 --- a/output/botcore.utils.regex.html +++ b/output/botcore.utils.regex.html @@ -218,21 +218,21 @@

Common regular expressions.

-DISCORD_INVITE[source]#
+DISCORD_INVITE[source]#

Regex for Discord server invites.

-FORMATTED_CODE_REGEX[source]#
+FORMATTED_CODE_REGEX[source]#

Regex for formatted code, using Discord’s code blocks.

-RAW_CODE_REGEX[source]#
+RAW_CODE_REGEX[source]#

Regex for raw code, not using Discord’s code blocks.

diff --git a/output/botcore.utils.scheduling.html b/output/botcore.utils.scheduling.html index 21825f3a..cd36a8c1 100644 --- a/output/botcore.utils.scheduling.html +++ b/output/botcore.utils.scheduling.html @@ -218,7 +218,7 @@

Generic python scheduler.

-class Scheduler(name)[source]#
+class Scheduler(name)[source]#

Bases: object

Schedule the execution of coroutines and keep track of them.

When instantiating a Scheduler, a name must be provided. This name is used to distinguish the @@ -232,7 +232,7 @@ the same ID used to schedule it.

Any exception raised in a scheduled task is logged when the task is done.

-__contains__(task_id)[source]#
+__contains__(task_id)[source]#

Return True if a task with the given task_id is currently scheduled.

Parameters
@@ -248,7 +248,7 @@ the same ID used to schedule it.

-__init__(name)[source]#
+__init__(name)[source]#

Initialize a new Scheduler instance.

Parameters
@@ -258,7 +258,7 @@ the same ID used to schedule it.

-cancel(task_id)[source]#
+cancel(task_id)[source]#

Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

Parameters
@@ -271,7 +271,7 @@ the same ID used to schedule it.

-cancel_all()[source]#
+cancel_all()[source]#

Unschedule all known tasks.

Return type
@@ -281,7 +281,7 @@ the same ID used to schedule it.

-schedule(task_id, coroutine)[source]#
+schedule(task_id, coroutine)[source]#

Schedule the execution of a coroutine.

If a task with task_id already exists, close coroutine instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.

@@ -299,7 +299,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
-schedule_at(time, task_id, coroutine)[source]#
+schedule_at(time, task_id, coroutine)[source]#

Schedule coroutine to be executed at the given time.

If time is timezone aware, then use that timezone to calculate now() when subtracting. If time is naĂŻve, then use UTC.

@@ -321,7 +321,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
-schedule_later(delay, task_id, coroutine)[source]#
+schedule_later(delay, task_id, coroutine)[source]#

Schedule coroutine to be executed after delay seconds.

If a task with task_id already exists, close coroutine instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.

@@ -341,7 +341,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
-create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
+create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#

Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

If the event_loop kwarg is provided, the task is created from that event loop, otherwise the running loop is used.

-- cgit v1.2.3