From 6209813c91f2a4b91fb6ae7b963a7022a7a702f6 Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Mon, 27 Jun 2022 14:00:54 +0000 Subject: Deploying to docs from @ python-discord/bot-core@db28fa621e7c214b5ed04a8029d2d704d35b9adf 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/.buildinfo | 2 +- main/.doctrees/changelog.doctree | Bin 68173 -> 68173 bytes main/.doctrees/environment.pickle | Bin 2619918 -> 2632329 bytes main/.doctrees/index.doctree | Bin 5471 -> 5471 bytes main/.doctrees/output/botcore.async_stats.doctree | Bin 19595 -> 19595 bytes main/.doctrees/output/botcore.doctree | Bin 64337 -> 64337 bytes main/.doctrees/output/botcore.exts.doctree | Bin 3092 -> 3092 bytes main/.doctrees/output/botcore.site_api.doctree | Bin 67547 -> 67547 bytes .../.doctrees/output/botcore.utils.caching.doctree | Bin 16971 -> 16971 bytes .../.doctrees/output/botcore.utils.channel.doctree | Bin 18442 -> 18442 bytes main/.doctrees/output/botcore.utils.doctree | Bin 14576 -> 14576 bytes .../.doctrees/output/botcore.utils.logging.doctree | Bin 18750 -> 18750 bytes .../.doctrees/output/botcore.utils.members.doctree | Bin 17389 -> 17389 bytes main/.doctrees/output/botcore.utils.regex.doctree | Bin 9322 -> 9322 bytes .../output/botcore.utils.scheduling.doctree | Bin 56864 -> 56864 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 ++++++------ 25 files changed, 58 insertions(+), 58 deletions(-) (limited to 'main') diff --git a/main/.buildinfo b/main/.buildinfo index ab641fa3..67bb488d 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: 021ce6be83e50ac080999b1de02ccbdf +config: 9d39f9a295979be1f7794d2bde8f1bf7 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/changelog.doctree b/main/.doctrees/changelog.doctree index b74e5ff3..0226b051 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 9deb1962..612deca2 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 428a35ec..968d0c62 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 0f3c928d..0476fdf1 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 763b909e..16b55bef 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 275a3d75..38d531df 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 39eb6999..8b4d72fa 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 c7437181..eae895cd 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 22ac234a..49790d5e 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 5ca47a8d..bb9f4725 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 c9a16ea4..f859d0bf 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 cf3d33bf..bd9c9601 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 33a0adca..fa46d2a4 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 9cab0876..acabb309 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 5db65e39..f16b12b5 100644 --- a/main/output/botcore.async_stats.html +++ b/main/output/botcore.async_stats.html @@ -274,12 +274,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
@@ -295,7 +295,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 a453fa20..faf5bf0f 100644 --- a/main/output/botcore.html +++ b/main/output/botcore.html @@ -274,12 +274,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: 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, 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
@@ -297,7 +297,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
@@ -307,7 +307,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
@@ -317,7 +317,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
@@ -327,7 +327,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
@@ -337,7 +337,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.

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

@@ -370,7 +370,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
@@ -380,7 +380,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
@@ -390,7 +390,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.

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

@@ -428,12 +428,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 49514d7f..560a3ed4 100644 --- a/main/output/botcore.site_api.html +++ b/main/output/botcore.site_api.html @@ -274,12 +274,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
@@ -293,7 +293,7 @@
-async close()[source]#
+async close()[source]#

Close the aiohttp session.

Return type
@@ -303,7 +303,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
@@ -323,7 +323,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
@@ -333,7 +333,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
@@ -352,7 +352,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
@@ -362,7 +362,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
@@ -372,7 +372,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
@@ -382,7 +382,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
@@ -407,12 +407,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
@@ -426,7 +426,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 99829697..5cafab04 100644 --- a/main/output/botcore.utils.caching.html +++ b/main/output/botcore.utils.caching.html @@ -274,14 +274,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
@@ -297,7 +297,7 @@
-__init__(max_size=128)[source]#
+__init__(max_size=128)[source]#

Initialise a new AsyncCache instance.

Parameters
@@ -307,7 +307,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 13c5c015..0fe9a972 100644 --- a/main/output/botcore.utils.channel.html +++ b/main/output/botcore.utils.channel.html @@ -274,7 +274,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
@@ -301,7 +301,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 a4a2c933..39df2a96 100644 --- a/main/output/botcore.utils.html +++ b/main/output/botcore.utils.html @@ -274,7 +274,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 @@ -292,7 +292,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 51cb52f7..c0281aec 100644 --- a/main/output/botcore.utils.logging.html +++ b/main/output/botcore.utils.logging.html @@ -274,12 +274,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)
@@ -301,7 +301,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 a0d96b42..aa829d57 100644 --- a/main/output/botcore.utils.members.html +++ b/main/output/botcore.utils.members.html @@ -274,7 +274,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
@@ -287,7 +287,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 ea5f1a91..b3761b16 100644 --- a/main/output/botcore.utils.regex.html +++ b/main/output/botcore.utils.regex.html @@ -274,7 +274,7 @@

Common regular expressions.

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

Regex for Discord server invites.

Warning

@@ -287,14 +287,14 @@ such as
-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/main/output/botcore.utils.scheduling.html b/main/output/botcore.utils.scheduling.html index d51c2896..24c79dc5 100644 --- a/main/output/botcore.utils.scheduling.html +++ b/main/output/botcore.utils.scheduling.html @@ -274,7 +274,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 @@ -288,7 +288,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
@@ -304,7 +304,7 @@ the same ID used to schedule it.

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

Initialize a new Scheduler instance.

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

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

Unschedule all known tasks.

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

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

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

@@ -397,7 +397,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