From b5e39348290adf61e6e262f7636906f4f6e65bdb Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sat, 2 Apr 2022 19:23:07 +0000 Subject: Deploying to docs from @ python-discord/bot-core@3732ccccbebf26da1678b24c1446019dad079745 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .buildinfo | 2 +- .doctrees/environment.pickle | Bin 2346392 -> 2346392 bytes .doctrees/output/botcore.async_stats.doctree | Bin 19339 -> 19339 bytes .doctrees/output/botcore.doctree | Bin 57463 -> 57463 bytes .doctrees/output/botcore.site_api.doctree | Bin 66675 -> 66675 bytes .doctrees/output/botcore.utils.caching.doctree | Bin 16693 -> 16693 bytes .doctrees/output/botcore.utils.channel.doctree | Bin 18252 -> 18252 bytes .doctrees/output/botcore.utils.doctree | Bin 10374 -> 10374 bytes .doctrees/output/botcore.utils.logging.doctree | Bin 18516 -> 18516 bytes .doctrees/output/botcore.utils.members.doctree | Bin 17177 -> 17177 bytes .doctrees/output/botcore.utils.regex.doctree | Bin 7664 -> 7664 bytes .doctrees/output/botcore.utils.scheduling.doctree | Bin 56366 -> 56366 bytes _static/documentation_options.js | 2 +- genindex.html | 6 ++-- index.html | 6 ++-- objects.inv | Bin 1088 -> 1088 bytes output/botcore.async_stats.html | 12 +++---- output/botcore.exts.html | 6 ++-- output/botcore.html | 38 +++++++++++----------- output/botcore.site_api.html | 32 +++++++++--------- output/botcore.utils.caching.html | 14 ++++---- output/botcore.utils.channel.html | 10 +++--- output/botcore.utils.html | 8 ++--- output/botcore.utils.logging.html | 12 +++---- output/botcore.utils.members.html | 10 +++--- output/botcore.utils.regex.html | 12 +++---- output/botcore.utils.scheduling.html | 24 +++++++------- py-modindex.html | 6 ++-- search.html | 6 ++-- 29 files changed, 103 insertions(+), 103 deletions(-) diff --git a/.buildinfo b/.buildinfo index c3be127a..744e5305 100644 --- a/.buildinfo +++ b/.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: 13e2f2d4f4839d8e72867344dd1f3798 +config: af80c138c45ee0e42dc6144015e71945 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 3fe56e9f..527cf0ef 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/.doctrees/output/botcore.async_stats.doctree b/.doctrees/output/botcore.async_stats.doctree index 1364d5d5..719eab11 100644 Binary files a/.doctrees/output/botcore.async_stats.doctree and b/.doctrees/output/botcore.async_stats.doctree differ diff --git a/.doctrees/output/botcore.doctree b/.doctrees/output/botcore.doctree index a8020c42..0a47eaa7 100644 Binary files a/.doctrees/output/botcore.doctree and b/.doctrees/output/botcore.doctree differ diff --git a/.doctrees/output/botcore.site_api.doctree b/.doctrees/output/botcore.site_api.doctree index 6794a846..e26c75a3 100644 Binary files a/.doctrees/output/botcore.site_api.doctree and b/.doctrees/output/botcore.site_api.doctree differ diff --git a/.doctrees/output/botcore.utils.caching.doctree b/.doctrees/output/botcore.utils.caching.doctree index 15f2f866..d4c5d7d4 100644 Binary files a/.doctrees/output/botcore.utils.caching.doctree and b/.doctrees/output/botcore.utils.caching.doctree differ diff --git a/.doctrees/output/botcore.utils.channel.doctree b/.doctrees/output/botcore.utils.channel.doctree index 4dfde4ab..ff5a2edb 100644 Binary files a/.doctrees/output/botcore.utils.channel.doctree and b/.doctrees/output/botcore.utils.channel.doctree differ diff --git a/.doctrees/output/botcore.utils.doctree b/.doctrees/output/botcore.utils.doctree index e20b5231..9fe4236b 100644 Binary files a/.doctrees/output/botcore.utils.doctree and b/.doctrees/output/botcore.utils.doctree differ diff --git a/.doctrees/output/botcore.utils.logging.doctree b/.doctrees/output/botcore.utils.logging.doctree index fa2cc095..9919e2d7 100644 Binary files a/.doctrees/output/botcore.utils.logging.doctree and b/.doctrees/output/botcore.utils.logging.doctree differ diff --git a/.doctrees/output/botcore.utils.members.doctree b/.doctrees/output/botcore.utils.members.doctree index 5ef3cab5..0833e8ca 100644 Binary files a/.doctrees/output/botcore.utils.members.doctree and b/.doctrees/output/botcore.utils.members.doctree differ diff --git a/.doctrees/output/botcore.utils.regex.doctree b/.doctrees/output/botcore.utils.regex.doctree index 351cea20..39ffe762 100644 Binary files a/.doctrees/output/botcore.utils.regex.doctree and b/.doctrees/output/botcore.utils.regex.doctree differ diff --git a/.doctrees/output/botcore.utils.scheduling.doctree b/.doctrees/output/botcore.utils.scheduling.doctree index 6110e1b0..d3662f96 100644 Binary files a/.doctrees/output/botcore.utils.scheduling.doctree and b/.doctrees/output/botcore.utils.scheduling.doctree differ diff --git a/_static/documentation_options.js b/_static/documentation_options.js index 57c0f823..9d4140ce 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '4.0.0', + VERSION: '5.0.0', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/genindex.html b/genindex.html index 8d823a06..82b85785 100644 --- a/genindex.html +++ b/genindex.html @@ -4,7 +4,7 @@ - Index - Bot Core v4.0.0 + Index - Bot Core v5.0.0 @@ -120,7 +120,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -146,7 +146,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 diff --git a/objects.inv b/objects.inv index a3d8b2f3..056d2532 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/output/botcore.async_stats.html b/output/botcore.async_stats.html index 99c54337..ea4c91ef 100644 --- a/output/botcore.async_stats.html +++ b/output/botcore.async_stats.html @@ -6,7 +6,7 @@ - async_stats - Bot Core v4.0.0 + async_stats - Bot Core v5.0.0 @@ -122,7 +122,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 @@ -214,12 +214,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
@@ -235,7 +235,7 @@
-async create_socket()[source]#
+async create_socket()[source]#

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

Return type
diff --git a/output/botcore.exts.html b/output/botcore.exts.html index 04c9917c..a36ce212 100644 --- a/output/botcore.exts.html +++ b/output/botcore.exts.html @@ -6,7 +6,7 @@ - Exts - Bot Core v4.0.0 + Exts - Bot Core v5.0.0 @@ -122,7 +122,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 diff --git a/output/botcore.html b/output/botcore.html index 5b50ce0d..a1125e44 100644 --- a/output/botcore.html +++ b/output/botcore.html @@ -6,7 +6,7 @@ - Botcore - Bot Core v4.0.0 + Botcore - Bot Core v5.0.0 @@ -122,7 +122,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 @@ -214,12 +214,12 @@

Useful utilities and tools for Discord bot development.

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

Bases: discord.ext.commands.bot.Bot

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

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

Initialise the base bot instance.

Parameters
@@ -236,7 +236,7 @@ to use for the bot.

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

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

Return type
@@ -246,7 +246,7 @@ to use for the bot.

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

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

Return type
@@ -256,7 +256,7 @@ to use for the bot.

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

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

Return type
@@ -266,7 +266,7 @@ to use for the bot.

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

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

Return type
@@ -276,7 +276,7 @@ to use for the bot.

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

Return type
@@ -286,7 +286,7 @@ to use for the bot.

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

Log the given message to #dev-log.

Return type
@@ -296,7 +296,7 @@ to use for the bot.

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

@@ -308,7 +308,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
@@ -318,7 +318,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
@@ -328,7 +328,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.

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

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

Bases: Exception

Exception class for startup errors.

-__init__(base)[source]#
+__init__(base)[source]#
diff --git a/output/botcore.site_api.html b/output/botcore.site_api.html index c972c941..8be3a9e3 100644 --- a/output/botcore.site_api.html +++ b/output/botcore.site_api.html @@ -6,7 +6,7 @@ - site_api - Bot Core v4.0.0 + site_api - Bot Core v5.0.0 @@ -122,7 +122,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 @@ -214,12 +214,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
@@ -233,7 +233,7 @@
-async close()[source]#
+async close()[source]#

Close the aiohttp session.

Return type
@@ -243,7 +243,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
@@ -263,7 +263,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
@@ -273,7 +273,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
@@ -292,7 +292,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
@@ -302,7 +302,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
@@ -312,7 +312,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
@@ -322,7 +322,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
@@ -347,12 +347,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
@@ -366,7 +366,7 @@
-__str__()[source]#
+__str__()[source]#

Return a string representation of the error.

diff --git a/output/botcore.utils.caching.html b/output/botcore.utils.caching.html index 45263628..e45111b9 100644 --- a/output/botcore.utils.caching.html +++ b/output/botcore.utils.caching.html @@ -6,7 +6,7 @@ - caching - Bot Core v4.0.0 + caching - Bot Core v5.0.0 @@ -122,7 +122,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 @@ -214,14 +214,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
@@ -237,7 +237,7 @@
-__init__(max_size=128)[source]#
+__init__(max_size=128)[source]#

Initialise a new AsyncCache instance.

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

Clear cache instance.

Return type
diff --git a/output/botcore.utils.channel.html b/output/botcore.utils.channel.html index f5491b87..76f4f410 100644 --- a/output/botcore.utils.channel.html +++ b/output/botcore.utils.channel.html @@ -6,7 +6,7 @@ - channel - Bot Core v4.0.0 + channel - Bot Core v5.0.0 @@ -122,7 +122,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 @@ -214,7 +214,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
@@ -241,7 +241,7 @@
-is_in_category(channel, category_id)[source]#
+is_in_category(channel, category_id)[source]#

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

Parameters
diff --git a/output/botcore.utils.html b/output/botcore.utils.html index e0161ec8..48b129ee 100644 --- a/output/botcore.utils.html +++ b/output/botcore.utils.html @@ -6,7 +6,7 @@ - Utils - Bot Core v4.0.0 + Utils - Bot Core v5.0.0 @@ -122,7 +122,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 @@ -214,7 +214,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 diff --git a/output/botcore.utils.logging.html b/output/botcore.utils.logging.html index ed6d0037..18c8a0d2 100644 --- a/output/botcore.utils.logging.html +++ b/output/botcore.utils.logging.html @@ -6,7 +6,7 @@ - logging - Bot Core v4.0.0 + logging - Bot Core v5.0.0 @@ -122,7 +122,7 @@

-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 @@ -214,12 +214,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)
@@ -241,7 +241,7 @@
-get_logger(name=None)[source]#
+get_logger(name=None)[source]#

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

Parameters
diff --git a/output/botcore.utils.members.html b/output/botcore.utils.members.html index 99432c18..71f14013 100644 --- a/output/botcore.utils.members.html +++ b/output/botcore.utils.members.html @@ -6,7 +6,7 @@ - members - Bot Core v4.0.0 + members - Bot Core v5.0.0 @@ -122,7 +122,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 @@ -214,7 +214,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
@@ -227,7 +227,7 @@
-async handle_role_change(member, coro, role)[source]#
+async handle_role_change(member, coro, role)[source]#

Await the given coro with member as the sole argument.

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

diff --git a/output/botcore.utils.regex.html b/output/botcore.utils.regex.html index 6c925b04..0961edd5 100644 --- a/output/botcore.utils.regex.html +++ b/output/botcore.utils.regex.html @@ -6,7 +6,7 @@ - regex - Bot Core v4.0.0 + regex - Bot Core v5.0.0 @@ -122,7 +122,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 @@ -214,21 +214,21 @@

Common regular expressions.

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

Regex for Discord server invites.

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

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

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

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

diff --git a/output/botcore.utils.scheduling.html b/output/botcore.utils.scheduling.html index ad77877b..9233d5e2 100644 --- a/output/botcore.utils.scheduling.html +++ b/output/botcore.utils.scheduling.html @@ -6,7 +6,7 @@ - scheduling - Bot Core v4.0.0 + scheduling - Bot Core v5.0.0 @@ -122,7 +122,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -148,7 +148,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 @@ -214,7 +214,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 @@ -228,7 +228,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
@@ -244,7 +244,7 @@ the same ID used to schedule it.

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

Initialize a new Scheduler instance.

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

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

Unschedule all known tasks.

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

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

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

@@ -337,7 +337,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/py-modindex.html b/py-modindex.html index 024664d3..daead800 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -4,7 +4,7 @@ - Python Module Index - Bot Core v4.0.0 + Python Module Index - Bot Core v5.0.0 @@ -120,7 +120,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -146,7 +146,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 diff --git a/search.html b/search.html index c4ca6c5e..8355806f 100644 --- a/search.html +++ b/search.html @@ -4,7 +4,7 @@ - Search - Bot Core v4.0.0 + Search - Bot Core v5.0.0 @@ -119,7 +119,7 @@
-
Bot Core v4.0.0
 +
Bot Core v5.0.0
@@ -145,7 +145,7 @@
- Bot Core v4.0.0 + Bot Core v5.0.0 -- cgit v1.2.3