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 ++++++------ 25 files changed, 58 insertions(+), 58 deletions(-) (limited to 'main') 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.

-- 
cgit v1.2.3