From 2385eee8a521aa2a8b8fe834deba4cf7bd15be0d Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Tue, 28 Jun 2022 12:20:23 +0000 Subject: Deploying to docs from @ python-discord/bot-core@17faeb4cdd58d174382a04424b3ec2b0332c0ec7 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/.buildinfo | 2 +- main/.doctrees/changelog.doctree | Bin 67877 -> 67877 bytes main/.doctrees/environment.pickle | Bin 2634198 -> 2634198 bytes main/.doctrees/index.doctree | Bin 5445 -> 5445 bytes main/.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes main/.doctrees/output/botcore.doctree | Bin 62401 -> 62401 bytes main/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes main/.doctrees/output/botcore.site_api.doctree | Bin 65215 -> 65215 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes main/.doctrees/output/botcore.utils.doctree | Bin 13965 -> 13965 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 16844 -> 16844 bytes main/.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 53663 -> 53663 bytes main/output/botcore.async_stats.html | 6 +-- main/output/botcore.html | 32 ++++++------- main/output/botcore.site_api.html | 26 +++++------ main/output/botcore.utils.caching.html | 8 ++-- main/output/botcore.utils.channel.html | 4 +- main/output/botcore.utils.html | 4 +- main/output/botcore.utils.logging.html | 6 +-- main/output/botcore.utils.members.html | 4 +- main/output/botcore.utils.regex.html | 6 +-- main/output/botcore.utils.scheduling.html | 18 +++---- v7.1.1/.buildinfo | 2 +- v7.1.1/.doctrees/changelog.doctree | Bin 64686 -> 64686 bytes v7.1.1/.doctrees/environment.pickle | Bin 2634202 -> 2634202 bytes v7.1.1/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.1.1/.doctrees/output/botcore.doctree | Bin 62401 -> 62401 bytes v7.1.1/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.1.1/.doctrees/output/botcore.site_api.doctree | Bin 65215 -> 65215 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.1.1/.doctrees/output/botcore.utils.doctree | Bin 13965 -> 13965 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 16844 -> 16844 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 53663 -> 53663 bytes v7.1.2/.buildinfo | 2 +- v7.1.2/.doctrees/changelog.doctree | Bin 65755 -> 65755 bytes v7.1.2/.doctrees/environment.pickle | Bin 2634202 -> 2634202 bytes v7.1.2/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.1.2/.doctrees/output/botcore.doctree | Bin 62401 -> 62401 bytes v7.1.2/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.1.2/.doctrees/output/botcore.site_api.doctree | Bin 65269 -> 65269 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.1.2/.doctrees/output/botcore.utils.doctree | Bin 13965 -> 13965 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 16844 -> 16844 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 53663 -> 53663 bytes v7.1.3/.buildinfo | 2 +- v7.1.3/.doctrees/changelog.doctree | Bin 65755 -> 65755 bytes v7.1.3/.doctrees/environment.pickle | Bin 707028 -> 2634202 bytes v7.1.3/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.1.3/.doctrees/output/botcore.doctree | Bin 62401 -> 62401 bytes v7.1.3/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.1.3/.doctrees/output/botcore.site_api.doctree | Bin 65271 -> 65271 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.1.3/.doctrees/output/botcore.utils.doctree | Bin 13965 -> 13965 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 16844 -> 16844 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 53663 -> 53663 bytes v7.1.3/output/botcore.async_stats.html | 14 +++--- v7.1.3/output/botcore.html | 36 +++++++------- v7.1.3/output/botcore.site_api.html | 38 +++++++-------- v7.1.3/output/botcore.utils.caching.html | 10 ++-- v7.1.3/output/botcore.utils.channel.html | 6 +-- v7.1.3/output/botcore.utils.html | 6 +-- v7.1.3/output/botcore.utils.logging.html | 10 ++-- v7.1.3/output/botcore.utils.members.html | 8 ++-- v7.1.3/output/botcore.utils.regex.html | 2 +- v7.1.3/output/botcore.utils.scheduling.html | 52 ++++++++++----------- v7.2.0/.buildinfo | 2 +- v7.2.0/.doctrees/changelog.doctree | Bin 67877 -> 67877 bytes v7.2.0/.doctrees/environment.pickle | Bin 2634202 -> 2634202 bytes v7.2.0/.doctrees/index.doctree | Bin 5445 -> 5445 bytes .../.doctrees/output/botcore.async_stats.doctree | Bin 18992 -> 18992 bytes v7.2.0/.doctrees/output/botcore.doctree | Bin 62401 -> 62401 bytes v7.2.0/.doctrees/output/botcore.exts.doctree | Bin 3091 -> 3091 bytes v7.2.0/.doctrees/output/botcore.site_api.doctree | Bin 65215 -> 65215 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16590 -> 16590 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 17681 -> 17681 bytes v7.2.0/.doctrees/output/botcore.utils.doctree | Bin 13965 -> 13965 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18135 -> 18135 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 16844 -> 16844 bytes .../.doctrees/output/botcore.utils.regex.doctree | Bin 9013 -> 9013 bytes .../output/botcore.utils.scheduling.doctree | Bin 53663 -> 53663 bytes 95 files changed, 153 insertions(+), 153 deletions(-) diff --git a/main/.buildinfo b/main/.buildinfo index 3c01d855..224c2ede 100644 --- a/main/.buildinfo +++ b/main/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: ed7640c9afd7554cfba6ebbb13f67310 +config: 158705be48399ab3c9cac5975efc0618 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/changelog.doctree b/main/.doctrees/changelog.doctree index 1a0bb58a..d0eb6647 100644 Binary files a/main/.doctrees/changelog.doctree and b/main/.doctrees/changelog.doctree differ diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle index 6ebb611d..16987aa4 100644 Binary files a/main/.doctrees/environment.pickle and b/main/.doctrees/environment.pickle differ diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree index 248a518d..30c5a2cc 100644 Binary files a/main/.doctrees/index.doctree and b/main/.doctrees/index.doctree differ diff --git a/main/.doctrees/output/botcore.async_stats.doctree b/main/.doctrees/output/botcore.async_stats.doctree index 57a4f760..5bcd1f30 100644 Binary files a/main/.doctrees/output/botcore.async_stats.doctree and b/main/.doctrees/output/botcore.async_stats.doctree differ diff --git a/main/.doctrees/output/botcore.doctree b/main/.doctrees/output/botcore.doctree index 3d9cf18e..f2af04d3 100644 Binary files a/main/.doctrees/output/botcore.doctree and b/main/.doctrees/output/botcore.doctree differ diff --git a/main/.doctrees/output/botcore.exts.doctree b/main/.doctrees/output/botcore.exts.doctree index e833dbda..1aded6e2 100644 Binary files a/main/.doctrees/output/botcore.exts.doctree and b/main/.doctrees/output/botcore.exts.doctree differ diff --git a/main/.doctrees/output/botcore.site_api.doctree b/main/.doctrees/output/botcore.site_api.doctree index 8ad0ee0f..df5c5e87 100644 Binary files a/main/.doctrees/output/botcore.site_api.doctree and b/main/.doctrees/output/botcore.site_api.doctree differ diff --git a/main/.doctrees/output/botcore.utils.caching.doctree b/main/.doctrees/output/botcore.utils.caching.doctree index da35fbb0..b6b75615 100644 Binary files a/main/.doctrees/output/botcore.utils.caching.doctree and b/main/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/main/.doctrees/output/botcore.utils.channel.doctree b/main/.doctrees/output/botcore.utils.channel.doctree index 2f3369e1..3db242c2 100644 Binary files a/main/.doctrees/output/botcore.utils.channel.doctree and b/main/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/main/.doctrees/output/botcore.utils.doctree b/main/.doctrees/output/botcore.utils.doctree index 9be1c467..d3cb681f 100644 Binary files a/main/.doctrees/output/botcore.utils.doctree and b/main/.doctrees/output/botcore.utils.doctree differ diff --git a/main/.doctrees/output/botcore.utils.logging.doctree b/main/.doctrees/output/botcore.utils.logging.doctree index 0a5426e9..11d24ac6 100644 Binary files a/main/.doctrees/output/botcore.utils.logging.doctree and b/main/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/main/.doctrees/output/botcore.utils.members.doctree b/main/.doctrees/output/botcore.utils.members.doctree index 2c3c0c47..12fae797 100644 Binary files a/main/.doctrees/output/botcore.utils.members.doctree and b/main/.doctrees/output/botcore.utils.members.doctree differ diff --git a/main/.doctrees/output/botcore.utils.regex.doctree b/main/.doctrees/output/botcore.utils.regex.doctree index 88adb21f..fa6d7219 100644 Binary files a/main/.doctrees/output/botcore.utils.regex.doctree and b/main/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/main/.doctrees/output/botcore.utils.scheduling.doctree b/main/.doctrees/output/botcore.utils.scheduling.doctree index c2ed9b08..8ad9de85 100644 Binary files a/main/.doctrees/output/botcore.utils.scheduling.doctree and b/main/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/main/output/botcore.async_stats.html b/main/output/botcore.async_stats.html index 6fa24c76..4140bdbe 100644 --- a/main/output/botcore.async_stats.html +++ b/main/output/botcore.async_stats.html @@ -279,12 +279,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: 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:
@@ -301,7 +301,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/main/output/botcore.html b/main/output/botcore.html index 48b96def..ce9933c6 100644 --- a/main/output/botcore.html +++ b/main/output/botcore.html @@ -279,12 +279,12 @@

Useful utilities and tools for Discord bot development.

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

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

Initialise the base bot instance.

Parameters:
@@ -303,7 +303,7 @@ a dummy statsd client will be created.

-async add_cog(cog)[source]#
+async add_cog(cog)[source]#

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

Return type:
@@ -314,7 +314,7 @@ a dummy statsd client will be created.

-add_command(command)[source]#
+add_command(command)[source]#

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

Return type:
@@ -325,7 +325,7 @@ a dummy statsd client will be created.

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

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

Return type:
@@ -336,7 +336,7 @@ a dummy statsd client will be created.

-async close()[source]#
+async close()[source]#

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

Return type:
@@ -347,7 +347,7 @@ a dummy statsd client will be created.

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

@@ -359,7 +359,7 @@ a dummy statsd client will be created.

-async log_to_dev_log(message)[source]#
+async log_to_dev_log(message)[source]#

Log the given message to #dev-log.

Return type:
@@ -370,7 +370,7 @@ a dummy statsd client will be created.

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

@@ -383,7 +383,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:
@@ -394,7 +394,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:
@@ -405,7 +405,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.

@@ -418,7 +418,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 @@ -432,7 +432,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.

@@ -447,12 +447,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/main/output/botcore.site_api.html b/main/output/botcore.site_api.html index 097763be..0c0c0aff 100644 --- a/main/output/botcore.site_api.html +++ b/main/output/botcore.site_api.html @@ -279,12 +279,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:
@@ -299,7 +299,7 @@
-async close()[source]#
+async close()[source]#

Close the aiohttp session.

Return type:
@@ -310,7 +310,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:
@@ -331,7 +331,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:
@@ -342,7 +342,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:
@@ -362,7 +362,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:
@@ -373,7 +373,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:
@@ -384,7 +384,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:
@@ -395,7 +395,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:
@@ -422,12 +422,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:
@@ -442,7 +442,7 @@
-__str__()[source]#
+__str__()[source]#

Return a string representation of the error.

diff --git a/main/output/botcore.utils.caching.html b/main/output/botcore.utils.caching.html index 34996381..abc052c9 100644 --- a/main/output/botcore.utils.caching.html +++ b/main/output/botcore.utils.caching.html @@ -279,14 +279,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:
@@ -303,7 +303,7 @@
-__init__(max_size=128)[source]#
+__init__(max_size=128)[source]#

Initialise a new AsyncCache instance.

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

Clear cache instance.

Return type:
diff --git a/main/output/botcore.utils.channel.html b/main/output/botcore.utils.channel.html index 120ee4d4..13587218 100644 --- a/main/output/botcore.utils.channel.html +++ b/main/output/botcore.utils.channel.html @@ -279,7 +279,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:
@@ -307,7 +307,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/main/output/botcore.utils.html b/main/output/botcore.utils.html index 68e0d293..0061daf8 100644 --- a/main/output/botcore.utils.html +++ b/main/output/botcore.utils.html @@ -279,7 +279,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 @@ -298,7 +298,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/main/output/botcore.utils.logging.html b/main/output/botcore.utils.logging.html index 13d7bd27..4dd38980 100644 --- a/main/output/botcore.utils.logging.html +++ b/main/output/botcore.utils.logging.html @@ -279,12 +279,12 @@

Common logging related functions.

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

Bases: 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)
@@ -308,7 +308,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/main/output/botcore.utils.members.html b/main/output/botcore.utils.members.html index e398f16f..2551a2c6 100644 --- a/main/output/botcore.utils.members.html +++ b/main/output/botcore.utils.members.html @@ -279,7 +279,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:
@@ -293,7 +293,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/main/output/botcore.utils.regex.html b/main/output/botcore.utils.regex.html index 8e578376..819891a5 100644 --- a/main/output/botcore.utils.regex.html +++ b/main/output/botcore.utils.regex.html @@ -279,7 +279,7 @@

Common regular expressions.

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

Regex for Discord server invites.

Warning

@@ -293,7 +293,7 @@ such as
-FORMATTED_CODE_REGEX[source]#
+FORMATTED_CODE_REGEX[source]#

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

@@ -301,7 +301,7 @@ such as
-RAW_CODE_REGEX[source]#
+RAW_CODE_REGEX[source]#

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

diff --git a/main/output/botcore.utils.scheduling.html b/main/output/botcore.utils.scheduling.html index 8e659cc8..bc252291 100644 --- a/main/output/botcore.utils.scheduling.html +++ b/main/output/botcore.utils.scheduling.html @@ -279,7 +279,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 @@ -293,7 +293,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:
@@ -310,7 +310,7 @@ the same ID used to schedule it.

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

Initialize a new Scheduler instance.

Parameters:
@@ -321,7 +321,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:
@@ -335,7 +335,7 @@ the same ID used to schedule it.

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

Unschedule all known tasks.

Return type:
@@ -346,7 +346,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.

@@ -365,7 +365,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.

@@ -388,7 +388,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.

@@ -410,7 +410,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.

diff --git a/v7.1.1/.buildinfo b/v7.1.1/.buildinfo index 8f5f5ae8..da7a8822 100644 --- a/v7.1.1/.buildinfo +++ b/v7.1.1/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 5a8997e6714e32837dc1f88ea5711ff2 +config: cd5bfe9370eea56ba808c36b978ab711 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.1.1/.doctrees/changelog.doctree b/v7.1.1/.doctrees/changelog.doctree index effe660c..8978367a 100644 Binary files a/v7.1.1/.doctrees/changelog.doctree and b/v7.1.1/.doctrees/changelog.doctree differ diff --git a/v7.1.1/.doctrees/environment.pickle b/v7.1.1/.doctrees/environment.pickle index 04798643..fa2a9133 100644 Binary files a/v7.1.1/.doctrees/environment.pickle and b/v7.1.1/.doctrees/environment.pickle differ diff --git a/v7.1.1/.doctrees/index.doctree b/v7.1.1/.doctrees/index.doctree index 9d59edb2..073ea2f8 100644 Binary files a/v7.1.1/.doctrees/index.doctree and b/v7.1.1/.doctrees/index.doctree differ diff --git a/v7.1.1/.doctrees/output/botcore.async_stats.doctree b/v7.1.1/.doctrees/output/botcore.async_stats.doctree index ca9a57e8..184c2ef7 100644 Binary files a/v7.1.1/.doctrees/output/botcore.async_stats.doctree and b/v7.1.1/.doctrees/output/botcore.async_stats.doctree differ diff --git a/v7.1.1/.doctrees/output/botcore.doctree b/v7.1.1/.doctrees/output/botcore.doctree index d1375239..c0cc8ff4 100644 Binary files a/v7.1.1/.doctrees/output/botcore.doctree and b/v7.1.1/.doctrees/output/botcore.doctree differ diff --git a/v7.1.1/.doctrees/output/botcore.exts.doctree b/v7.1.1/.doctrees/output/botcore.exts.doctree index 03948c71..f639aad3 100644 Binary files a/v7.1.1/.doctrees/output/botcore.exts.doctree and b/v7.1.1/.doctrees/output/botcore.exts.doctree differ diff --git a/v7.1.1/.doctrees/output/botcore.site_api.doctree b/v7.1.1/.doctrees/output/botcore.site_api.doctree index 083ac15e..10286661 100644 Binary files a/v7.1.1/.doctrees/output/botcore.site_api.doctree and b/v7.1.1/.doctrees/output/botcore.site_api.doctree differ diff --git a/v7.1.1/.doctrees/output/botcore.utils.caching.doctree b/v7.1.1/.doctrees/output/botcore.utils.caching.doctree index 2f7b2f41..18622cbf 100644 Binary files a/v7.1.1/.doctrees/output/botcore.utils.caching.doctree and b/v7.1.1/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/v7.1.1/.doctrees/output/botcore.utils.channel.doctree b/v7.1.1/.doctrees/output/botcore.utils.channel.doctree index fbec7080..77540471 100644 Binary files a/v7.1.1/.doctrees/output/botcore.utils.channel.doctree and b/v7.1.1/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/v7.1.1/.doctrees/output/botcore.utils.doctree b/v7.1.1/.doctrees/output/botcore.utils.doctree index 2bc67605..e233c513 100644 Binary files a/v7.1.1/.doctrees/output/botcore.utils.doctree and b/v7.1.1/.doctrees/output/botcore.utils.doctree differ diff --git a/v7.1.1/.doctrees/output/botcore.utils.logging.doctree b/v7.1.1/.doctrees/output/botcore.utils.logging.doctree index 17f86d92..a0eee8f5 100644 Binary files a/v7.1.1/.doctrees/output/botcore.utils.logging.doctree and b/v7.1.1/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/v7.1.1/.doctrees/output/botcore.utils.members.doctree b/v7.1.1/.doctrees/output/botcore.utils.members.doctree index a5db1eb2..27ae76fe 100644 Binary files a/v7.1.1/.doctrees/output/botcore.utils.members.doctree and b/v7.1.1/.doctrees/output/botcore.utils.members.doctree differ diff --git a/v7.1.1/.doctrees/output/botcore.utils.regex.doctree b/v7.1.1/.doctrees/output/botcore.utils.regex.doctree index 22432fb5..43471eff 100644 Binary files a/v7.1.1/.doctrees/output/botcore.utils.regex.doctree and b/v7.1.1/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree b/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree index 32d38b21..e656718a 100644 Binary files a/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree and b/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/v7.1.2/.buildinfo b/v7.1.2/.buildinfo index 7bd0ad14..b86798f8 100644 --- a/v7.1.2/.buildinfo +++ b/v7.1.2/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 2eb1a37e8ca9be6480d5353d22ff4c6f +config: dee13de63bdb4fbea33c00bc06c81941 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.1.2/.doctrees/changelog.doctree b/v7.1.2/.doctrees/changelog.doctree index c6e0c3a7..c2b93f17 100644 Binary files a/v7.1.2/.doctrees/changelog.doctree and b/v7.1.2/.doctrees/changelog.doctree differ diff --git a/v7.1.2/.doctrees/environment.pickle b/v7.1.2/.doctrees/environment.pickle index 374be4a7..7a9727c1 100644 Binary files a/v7.1.2/.doctrees/environment.pickle and b/v7.1.2/.doctrees/environment.pickle differ diff --git a/v7.1.2/.doctrees/index.doctree b/v7.1.2/.doctrees/index.doctree index 20f3fb16..c41e0127 100644 Binary files a/v7.1.2/.doctrees/index.doctree and b/v7.1.2/.doctrees/index.doctree differ diff --git a/v7.1.2/.doctrees/output/botcore.async_stats.doctree b/v7.1.2/.doctrees/output/botcore.async_stats.doctree index 01d5eb7e..0ed79f69 100644 Binary files a/v7.1.2/.doctrees/output/botcore.async_stats.doctree and b/v7.1.2/.doctrees/output/botcore.async_stats.doctree differ diff --git a/v7.1.2/.doctrees/output/botcore.doctree b/v7.1.2/.doctrees/output/botcore.doctree index 8e229718..c23b9fbd 100644 Binary files a/v7.1.2/.doctrees/output/botcore.doctree and b/v7.1.2/.doctrees/output/botcore.doctree differ diff --git a/v7.1.2/.doctrees/output/botcore.exts.doctree b/v7.1.2/.doctrees/output/botcore.exts.doctree index b2ad7994..f1cbf264 100644 Binary files a/v7.1.2/.doctrees/output/botcore.exts.doctree and b/v7.1.2/.doctrees/output/botcore.exts.doctree differ diff --git a/v7.1.2/.doctrees/output/botcore.site_api.doctree b/v7.1.2/.doctrees/output/botcore.site_api.doctree index b63147dc..9d44d9dd 100644 Binary files a/v7.1.2/.doctrees/output/botcore.site_api.doctree and b/v7.1.2/.doctrees/output/botcore.site_api.doctree differ diff --git a/v7.1.2/.doctrees/output/botcore.utils.caching.doctree b/v7.1.2/.doctrees/output/botcore.utils.caching.doctree index 288fc209..201927c6 100644 Binary files a/v7.1.2/.doctrees/output/botcore.utils.caching.doctree and b/v7.1.2/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/v7.1.2/.doctrees/output/botcore.utils.channel.doctree b/v7.1.2/.doctrees/output/botcore.utils.channel.doctree index 1a86f6be..4fca9209 100644 Binary files a/v7.1.2/.doctrees/output/botcore.utils.channel.doctree and b/v7.1.2/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/v7.1.2/.doctrees/output/botcore.utils.doctree b/v7.1.2/.doctrees/output/botcore.utils.doctree index 3d6c8554..ae4d1213 100644 Binary files a/v7.1.2/.doctrees/output/botcore.utils.doctree and b/v7.1.2/.doctrees/output/botcore.utils.doctree differ diff --git a/v7.1.2/.doctrees/output/botcore.utils.logging.doctree b/v7.1.2/.doctrees/output/botcore.utils.logging.doctree index 1ba04d2c..c271426b 100644 Binary files a/v7.1.2/.doctrees/output/botcore.utils.logging.doctree and b/v7.1.2/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/v7.1.2/.doctrees/output/botcore.utils.members.doctree b/v7.1.2/.doctrees/output/botcore.utils.members.doctree index 60a02156..904de6b0 100644 Binary files a/v7.1.2/.doctrees/output/botcore.utils.members.doctree and b/v7.1.2/.doctrees/output/botcore.utils.members.doctree differ diff --git a/v7.1.2/.doctrees/output/botcore.utils.regex.doctree b/v7.1.2/.doctrees/output/botcore.utils.regex.doctree index 95f0ae60..7a98ef0b 100644 Binary files a/v7.1.2/.doctrees/output/botcore.utils.regex.doctree and b/v7.1.2/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree b/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree index 633d2b8c..a376e994 100644 Binary files a/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree and b/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/v7.1.3/.buildinfo b/v7.1.3/.buildinfo index f185ad5b..71e9021d 100644 --- a/v7.1.3/.buildinfo +++ b/v7.1.3/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 4a10d9d1b81c70c7be4cc7612cf5efd3 +config: 31baab574c8f9a24396b9e55f4899924 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.1.3/.doctrees/changelog.doctree b/v7.1.3/.doctrees/changelog.doctree index d1665e96..127a9694 100644 Binary files a/v7.1.3/.doctrees/changelog.doctree and b/v7.1.3/.doctrees/changelog.doctree differ diff --git a/v7.1.3/.doctrees/environment.pickle b/v7.1.3/.doctrees/environment.pickle index e66f8113..8a2c5126 100644 Binary files a/v7.1.3/.doctrees/environment.pickle and b/v7.1.3/.doctrees/environment.pickle differ diff --git a/v7.1.3/.doctrees/index.doctree b/v7.1.3/.doctrees/index.doctree index 5e509eb3..fde4b99b 100644 Binary files a/v7.1.3/.doctrees/index.doctree and b/v7.1.3/.doctrees/index.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.async_stats.doctree b/v7.1.3/.doctrees/output/botcore.async_stats.doctree index 2dd3d27d..6a79e30d 100644 Binary files a/v7.1.3/.doctrees/output/botcore.async_stats.doctree and b/v7.1.3/.doctrees/output/botcore.async_stats.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.doctree b/v7.1.3/.doctrees/output/botcore.doctree index 5b164d1d..804a81b4 100644 Binary files a/v7.1.3/.doctrees/output/botcore.doctree and b/v7.1.3/.doctrees/output/botcore.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.exts.doctree b/v7.1.3/.doctrees/output/botcore.exts.doctree index 0d60ec98..23c0846b 100644 Binary files a/v7.1.3/.doctrees/output/botcore.exts.doctree and b/v7.1.3/.doctrees/output/botcore.exts.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.site_api.doctree b/v7.1.3/.doctrees/output/botcore.site_api.doctree index 558f6f58..66fe1ff6 100644 Binary files a/v7.1.3/.doctrees/output/botcore.site_api.doctree and b/v7.1.3/.doctrees/output/botcore.site_api.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.caching.doctree b/v7.1.3/.doctrees/output/botcore.utils.caching.doctree index 63382ccf..d97b43db 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.caching.doctree and b/v7.1.3/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.channel.doctree b/v7.1.3/.doctrees/output/botcore.utils.channel.doctree index a9a141d2..872bd240 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.channel.doctree and b/v7.1.3/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.doctree b/v7.1.3/.doctrees/output/botcore.utils.doctree index 06bb7320..85581850 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.doctree and b/v7.1.3/.doctrees/output/botcore.utils.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.logging.doctree b/v7.1.3/.doctrees/output/botcore.utils.logging.doctree index a16789f5..3bf7e526 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.logging.doctree and b/v7.1.3/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.members.doctree b/v7.1.3/.doctrees/output/botcore.utils.members.doctree index affbf146..94c96bc9 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.members.doctree and b/v7.1.3/.doctrees/output/botcore.utils.members.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.regex.doctree b/v7.1.3/.doctrees/output/botcore.utils.regex.doctree index b4ac3154..6a6d3f1a 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.regex.doctree and b/v7.1.3/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree b/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree index 9e7d0863..60b70a74 100644 Binary files a/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree and b/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/v7.1.3/output/botcore.async_stats.html b/v7.1.3/output/botcore.async_stats.html index c3c298b9..1310ee7b 100644 --- a/v7.1.3/output/botcore.async_stats.html +++ b/v7.1.3/output/botcore.async_stats.html @@ -289,11 +289,11 @@
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.

  • +
  • 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.

@@ -302,10 +302,10 @@
async create_socket()[source]#
-

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

+

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

Return type:
-

None

+

None

diff --git a/v7.1.3/output/botcore.html b/v7.1.3/output/botcore.html index be0d9b38..a5818c5c 100644 --- a/v7.1.3/output/botcore.html +++ b/v7.1.3/output/botcore.html @@ -289,12 +289,12 @@
Parameters:
@@ -307,7 +307,7 @@ a dummy statsd client will be created.

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

Return type:
-

None

+

None

@@ -318,7 +318,7 @@ a dummy statsd client will be created.

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

Return type:
-

None

+

None

@@ -329,7 +329,7 @@ a dummy statsd client will be created.

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

Return type:
-

None

+

None

@@ -340,7 +340,7 @@ a dummy statsd client will be created.

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

Return type:
-

None

+

None

@@ -352,7 +352,7 @@ a dummy statsd client will be created.

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

Return type:
-

None

+

None

@@ -363,7 +363,7 @@ a dummy statsd client will be created.

Log the given message to #dev-log.

Return type:
-

None

+

None

@@ -376,7 +376,7 @@ a dummy statsd client will be created.

will not be set and guild_available_but_cache_empty event will be emitted.

Return type:
-

None

+

None

@@ -387,7 +387,7 @@ will not be set and guild_available_but_cache_empty event will be e

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

Return type:
-

None

+

None

@@ -398,7 +398,7 @@ will not be set and guild_available_but_cache_empty event will be e

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

Return type:
-

None

+

None

@@ -411,7 +411,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

Return type:
-

Optional[Command]

+

Optional[Command]

@@ -425,7 +425,7 @@ To remove them, either remove the entire command or manually edit bot.all_ and ping_services().

Return type:
-

None

+

None

@@ -438,7 +438,7 @@ and
Return type:
-

None

+

None

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

Bases: Exception

+

Bases: Exception

Exception class for startup errors.

diff --git a/v7.1.3/output/botcore.site_api.html b/v7.1.3/output/botcore.site_api.html index 224af374..9d98be72 100644 --- a/v7.1.3/output/botcore.site_api.html +++ b/v7.1.3/output/botcore.site_api.html @@ -280,7 +280,7 @@
class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
-

Bases: object

+

Bases: object

A wrapper for the Django Site API.

@@ -289,8 +289,8 @@
Parameters:
    -
  • site_api_url (str) – The URL of the site API.

  • -
  • site_api_token (str) – The token to use for authentication.

  • +
  • site_api_url (str) – The URL of the site API.

  • +
  • site_api_token (str) – The token to use for authentication.

  • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

@@ -303,7 +303,7 @@

Close the aiohttp session.

Return type:
-

None

+

None

@@ -315,13 +315,13 @@
Parameters:
    -
  • endpoint (str) – The endpoint to send the request to.

  • -
  • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

  • +
  • endpoint (str) – The endpoint to send the request to.

  • +
  • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

  • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

Return type:
-

Optional[dict]

+

Optional[dict]

Returns:

The JSON response the API returns, or None if the response is 204 No Content.

@@ -335,7 +335,7 @@

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

Return type:
-

dict

+

dict

@@ -348,14 +348,14 @@
Parameters:
  • response (aiohttp.ClientResponse) – The response to check.

  • -
  • should_raise (bool) – Whether or not to raise an exception.

  • +
  • should_raise (bool) – Whether or not to raise an exception.

Raises:

ResponseCodeError – If the response is not OK and should_raise is True.

Return type:
-

None

+

None

@@ -366,7 +366,7 @@

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

Return type:
-

dict

+

dict

@@ -377,7 +377,7 @@

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

Return type:
-

dict

+

dict

@@ -388,7 +388,7 @@

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

Return type:
-

dict

+

dict

@@ -400,14 +400,14 @@
Parameters:
    -
  • method (str) – The HTTP method to use.

  • -
  • endpoint (str) – The endpoint to send the request to.

  • -
  • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

  • +
  • method (str) – The HTTP method to use.

  • +
  • endpoint (str) – The endpoint to send the request to.

  • +
  • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

  • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

Return type:
-

dict

+

dict

Returns:

The JSON response the API returns.

@@ -423,7 +423,7 @@
exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
-

Bases: ValueError

+

Bases: ValueError

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

@@ -433,7 +433,7 @@
Parameters:
  • response (aiohttp.ClientResponse) – The response object from the request. And then reverted in 7.1.3.

  • -
  • response_json (Optional[dict]) – The JSON response returned from the request, if any.

  • +
  • response_json (Optional[dict]) – The JSON response returned from the request, if any.

  • request_text – The text of the request, if any.

diff --git a/v7.1.3/output/botcore.utils.caching.html b/v7.1.3/output/botcore.utils.caching.html index c647a897..86c64725 100644 --- a/v7.1.3/output/botcore.utils.caching.html +++ b/v7.1.3/output/botcore.utils.caching.html @@ -280,7 +280,7 @@
class AsyncCache(max_size=128)[source]#
-

Bases: object

+

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.

@@ -290,10 +290,10 @@

Decorator for async cache.

Parameters:
-

arg_offset (int) – The offset for the position of the key argument.

+

arg_offset (int) – The offset for the position of the key argument.

Return type:
-

Callable

+

Callable

Returns:

A decorator to wrap the target function.

@@ -307,7 +307,7 @@

Initialise a new AsyncCache instance.

Parameters:
-

max_size (int) – How many items to store in the cache.

+

max_size (int) – How many items to store in the cache.

@@ -318,7 +318,7 @@

Clear cache instance.

Return type:
-

None

+

None

diff --git a/v7.1.3/output/botcore.utils.channel.html b/v7.1.3/output/botcore.utils.channel.html index 0c4cb277..a247b49d 100644 --- a/v7.1.3/output/botcore.utils.channel.html +++ b/v7.1.3/output/botcore.utils.channel.html @@ -285,7 +285,7 @@
Parameters:
  • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

  • -
  • channel_id (int) – The channel to get/fetch.

  • +
  • channel_id (int) – The channel to get/fetch.

Raises:
@@ -313,11 +313,11 @@
Parameters:
  • channel (TextChannel) – The channel to check.

  • -
  • category_id (int) – The category to check for.

  • +
  • category_id (int) – The category to check for.

Return type:
-

bool

+

bool

Returns:

A bool depending on whether the channel is in the category.

diff --git a/v7.1.3/output/botcore.utils.html b/v7.1.3/output/botcore.utils.html index 85ecd232..55d31428 100644 --- a/v7.1.3/output/botcore.utils.html +++ b/v7.1.3/output/botcore.utils.html @@ -291,7 +291,7 @@ that will act as top-level groups rather than being aliases of the command’s g
Return type:
-

None

+

None

@@ -302,10 +302,10 @@ that will act as top-level groups rather than being aliases of the command’s g

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

Parameters:
-

name (str) – The module name to unqualify.

+

name (str) – The module name to unqualify.

Return type:
-

str

+

str

Returns:

The unqualified module name.

diff --git a/v7.1.3/output/botcore.utils.logging.html b/v7.1.3/output/botcore.utils.logging.html index a2063ec9..df80c74e 100644 --- a/v7.1.3/output/botcore.utils.logging.html +++ b/v7.1.3/output/botcore.utils.logging.html @@ -280,8 +280,8 @@
class CustomLogger(name, level=0)[source]#
-

Bases: Logger

-

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

+

Bases: Logger

+

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

trace(msg, *args, **kwargs)[source]#
@@ -293,13 +293,13 @@
Parameters:
    -
  • msg (str) – The message to be logged.

  • +
  • msg (str) – The message to be logged.

  • args – Passed to the base log function as is.

  • kwargs – Passed to the base log function as is.

Return type:
-

None

+

None

@@ -312,7 +312,7 @@

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

Parameters:
-

name (Optional[str]) – The name given to the logger.

+

name (Optional[str]) – The name given to the logger.

Return type:

CustomLogger

diff --git a/v7.1.3/output/botcore.utils.members.html b/v7.1.3/output/botcore.utils.members.html index 0d1e1504..5d50841e 100644 --- a/v7.1.3/output/botcore.utils.members.html +++ b/v7.1.3/output/botcore.utils.members.html @@ -283,10 +283,10 @@

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

Return type:
-

Optional[Member]

+

Optional[Member]

Returns:
-

The discord.Member or None to indicate the member could not be found.

+

The discord.Member or None to indicate the member could not be found.

@@ -301,11 +301,11 @@
Parameters:
Return type:
-

None

+

None

diff --git a/v7.1.3/output/botcore.utils.regex.html b/v7.1.3/output/botcore.utils.regex.html index 3c4b7b51..aa16b1a3 100644 --- a/v7.1.3/output/botcore.utils.regex.html +++ b/v7.1.3/output/botcore.utils.regex.html @@ -285,7 +285,7 @@

Warning

This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

+such as urllib.parse.quote().

diff --git a/v7.1.3/output/botcore.utils.scheduling.html b/v7.1.3/output/botcore.utils.scheduling.html index 57640d83..7823f251 100644 --- a/v7.1.3/output/botcore.utils.scheduling.html +++ b/v7.1.3/output/botcore.utils.scheduling.html @@ -280,7 +280,7 @@
class Scheduler(name)[source]#
-

Bases: object

+

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 instance’s log messages from other instances. Using the name of the class or module containing @@ -294,16 +294,16 @@ the same ID used to schedule it.

__contains__(task_id)[source]#
-

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

+

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

Parameters:
-

task_id (Hashable) – The task to look for.

+

task_id (Hashable) – The task to look for.

Return type:
-

bool

+

bool

Returns:
-

True if the task was found.

+

True if the task was found.

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

Initialize a new Scheduler instance.

Parameters:
-

name (str) – The name of the Scheduler. Used in logging, and namespacing.

+

name (str) – The name of the Scheduler. Used in logging, and namespacing.

@@ -325,10 +325,10 @@ the same ID used to schedule it.

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

Parameters:
-

task_id (Hashable) – The task’s unique ID.

+

task_id (Hashable) – The task’s unique ID.

Return type:
-

None

+

None

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

Unschedule all known tasks.

Return type:
-

None

+

None

@@ -353,12 +353,12 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
Parameters:
    -
  • task_id (Hashable) – A unique ID to create the task with.

  • -
  • coroutine (Coroutine) – The function to be called.

  • +
  • task_id (Hashable) – A unique ID to create the task with.

  • +
  • coroutine (Coroutine) – The function to be called.

Return type:
-

None

+

None

@@ -375,13 +375,13 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
Parameters:
    -
  • time (datetime) – The time to start the task.

  • -
  • task_id (Hashable) – A unique ID to create the task with.

  • -
  • coroutine (Coroutine) – The function to be called.

  • +
  • time (datetime) – The time to start the task.

  • +
  • task_id (Hashable) – A unique ID to create the task with.

  • +
  • coroutine (Coroutine) – The function to be called.

Return type:
-

None

+

None

@@ -395,13 +395,13 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
Parameters:
    -
  • delay (Union[int, float]) – How long to wait before starting the task.

  • -
  • task_id (Hashable) – A unique ID to create the task with.

  • -
  • coroutine (Coroutine) – The function to be called.

  • +
  • delay (Union[int, float]) – How long to wait before starting the task.

  • +
  • task_id (Hashable) – A unique ID to create the task with.

  • +
  • coroutine (Coroutine) – The function to be called.

Return type:
-

None

+

None

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

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

+

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.

Parameters:
    -
  • coro (Awaitable) – The function to call.

  • -
  • suppressed_exceptions (tuple[Type[Exception]]) – Exceptions to be handled by the task.

  • -
  • event_loop (asyncio.AbstractEventLoop) – The loop to create the task from.

  • -
  • kwargs – Passed to asyncio.create_task().

  • +
  • coro (Awaitable) – The function to call.

  • +
  • suppressed_exceptions (tuple[Type[Exception]]) – Exceptions to be handled by the task.

  • +
  • event_loop (asyncio.AbstractEventLoop) – The loop to create the task from.

  • +
  • kwargs – Passed to asyncio.create_task().

Returns:

The wrapped task.

Return type:
-

asyncio.Task

+

asyncio.Task

diff --git a/v7.2.0/.buildinfo b/v7.2.0/.buildinfo index d7b432c0..e49a9622 100644 --- a/v7.2.0/.buildinfo +++ b/v7.2.0/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 3be6441cf33c886b1c3ac44b840354c9 +config: bf19847b8021ff2caeabd78728c8ccb5 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.2.0/.doctrees/changelog.doctree b/v7.2.0/.doctrees/changelog.doctree index 73658d78..0ce019f0 100644 Binary files a/v7.2.0/.doctrees/changelog.doctree and b/v7.2.0/.doctrees/changelog.doctree differ diff --git a/v7.2.0/.doctrees/environment.pickle b/v7.2.0/.doctrees/environment.pickle index 4f349df8..bd4d5d90 100644 Binary files a/v7.2.0/.doctrees/environment.pickle and b/v7.2.0/.doctrees/environment.pickle differ diff --git a/v7.2.0/.doctrees/index.doctree b/v7.2.0/.doctrees/index.doctree index 92209e0b..ca68959d 100644 Binary files a/v7.2.0/.doctrees/index.doctree and b/v7.2.0/.doctrees/index.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.async_stats.doctree b/v7.2.0/.doctrees/output/botcore.async_stats.doctree index b98dfe2d..c4fddce0 100644 Binary files a/v7.2.0/.doctrees/output/botcore.async_stats.doctree and b/v7.2.0/.doctrees/output/botcore.async_stats.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.doctree b/v7.2.0/.doctrees/output/botcore.doctree index dbe53ea2..b078526d 100644 Binary files a/v7.2.0/.doctrees/output/botcore.doctree and b/v7.2.0/.doctrees/output/botcore.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.exts.doctree b/v7.2.0/.doctrees/output/botcore.exts.doctree index 43258a18..b8523f91 100644 Binary files a/v7.2.0/.doctrees/output/botcore.exts.doctree and b/v7.2.0/.doctrees/output/botcore.exts.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.site_api.doctree b/v7.2.0/.doctrees/output/botcore.site_api.doctree index 08039caa..f4a9c398 100644 Binary files a/v7.2.0/.doctrees/output/botcore.site_api.doctree and b/v7.2.0/.doctrees/output/botcore.site_api.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.caching.doctree b/v7.2.0/.doctrees/output/botcore.utils.caching.doctree index 97c3505c..e204c804 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.caching.doctree and b/v7.2.0/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.channel.doctree b/v7.2.0/.doctrees/output/botcore.utils.channel.doctree index 70950d5a..31dc5a28 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.channel.doctree and b/v7.2.0/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.doctree b/v7.2.0/.doctrees/output/botcore.utils.doctree index f3db6b24..c87da400 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.doctree and b/v7.2.0/.doctrees/output/botcore.utils.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.logging.doctree b/v7.2.0/.doctrees/output/botcore.utils.logging.doctree index aa9187eb..3be85267 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.logging.doctree and b/v7.2.0/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.members.doctree b/v7.2.0/.doctrees/output/botcore.utils.members.doctree index 7d5a3405..1b1705ea 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.members.doctree and b/v7.2.0/.doctrees/output/botcore.utils.members.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.regex.doctree b/v7.2.0/.doctrees/output/botcore.utils.regex.doctree index 9867b781..03d8d127 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.regex.doctree and b/v7.2.0/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree b/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree index 86c09686..fd584c86 100644 Binary files a/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree and b/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree differ -- cgit v1.2.3