From 451fbe23ff31a232ea68d2c1913153a4397ef6ce Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sat, 5 Mar 2022 16:32:01 +0000 Subject: Deploying to docs from @ python-discord/bot-core@f105af921d2e294e49388c4aff680912cf261ec6 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .buildinfo | 2 +- .doctrees/environment.pickle | Bin 2395989 -> 2397395 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 10416 -> 10416 bytes .doctrees/output/botcore.utils.extensions.doctree | Bin 12371 -> 12371 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 931 -> 931 bytes output/botcore.exts.html | 6 ++-- output/botcore.html | 6 ++-- output/botcore.site_api.html | 32 +++++++++++----------- output/botcore.utils.caching.html | 14 +++++----- output/botcore.utils.channel.html | 10 +++---- output/botcore.utils.extensions.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 ++-- 28 files changed, 86 insertions(+), 86 deletions(-) diff --git a/.buildinfo b/.buildinfo index a0099dd5..18dc5a02 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: cfc00cf39e6481fe8c80fc1e91b2c2ac +config: 3a4b0530645edb7db0a46977bbdc5756 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 907e7630..300ff7e0 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/.doctrees/output/botcore.site_api.doctree b/.doctrees/output/botcore.site_api.doctree index dfb692d2..3234a786 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 3c2a2851..54d8612f 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 c6098c7f..26f4d647 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 4d350260..b49068d2 100644 Binary files a/.doctrees/output/botcore.utils.doctree and b/.doctrees/output/botcore.utils.doctree differ diff --git a/.doctrees/output/botcore.utils.extensions.doctree b/.doctrees/output/botcore.utils.extensions.doctree index 82bbb176..200693fb 100644 Binary files a/.doctrees/output/botcore.utils.extensions.doctree and b/.doctrees/output/botcore.utils.extensions.doctree differ diff --git a/.doctrees/output/botcore.utils.logging.doctree b/.doctrees/output/botcore.utils.logging.doctree index e701c951..bfa812c0 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 ca76736a..fd3a6902 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 4c8c30b7..300a5dee 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 f5f6bf76..7d6a8192 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 8d2a4675..758bf8bb 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: '3.0.0', + VERSION: '3.0.1', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/genindex.html b/genindex.html index 81e61f9f..8523019b 100644 --- a/genindex.html +++ b/genindex.html @@ -4,7 +4,7 @@ - Index - Bot Core v3.0.0 + Index - Bot Core v3.0.1 @@ -120,7 +120,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -146,7 +146,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 diff --git a/objects.inv b/objects.inv index 40c0dd4b..d65a491e 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/output/botcore.exts.html b/output/botcore.exts.html index 8bdb0d27..c62557d3 100644 --- a/output/botcore.exts.html +++ b/output/botcore.exts.html @@ -6,7 +6,7 @@ - Exts - Bot Core v3.0.0 + Exts - Bot Core v3.0.1 @@ -122,7 +122,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 diff --git a/output/botcore.html b/output/botcore.html index bf749e6a..550fc282 100644 --- a/output/botcore.html +++ b/output/botcore.html @@ -6,7 +6,7 @@ - Botcore - Bot Core v3.0.0 + Botcore - Bot Core v3.0.1 @@ -122,7 +122,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 diff --git a/output/botcore.site_api.html b/output/botcore.site_api.html index 814b3302..c21edcde 100644 --- a/output/botcore.site_api.html +++ b/output/botcore.site_api.html @@ -6,7 +6,7 @@ - site_api - Bot Core v3.0.0 + site_api - Bot Core v3.0.1 @@ -122,7 +122,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 @@ -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 52c2cd85..26ae287e 100644 --- a/output/botcore.utils.caching.html +++ b/output/botcore.utils.caching.html @@ -6,7 +6,7 @@ - caching - Bot Core v3.0.0 + caching - Bot Core v3.0.1 @@ -122,7 +122,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 @@ -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 3c91c85c..1d3cbc56 100644 --- a/output/botcore.utils.channel.html +++ b/output/botcore.utils.channel.html @@ -6,7 +6,7 @@ - channel - Bot Core v3.0.0 + channel - Bot Core v3.0.1 @@ -122,7 +122,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 @@ -214,7 +214,7 @@

Useful helper functions for interacting with various disnake 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.extensions.html b/output/botcore.utils.extensions.html index 1130c702..5f5a034c 100644 --- a/output/botcore.utils.extensions.html +++ b/output/botcore.utils.extensions.html @@ -6,7 +6,7 @@ - extensions - Bot Core v3.0.0 + extensions - Bot Core v3.0.1 @@ -122,7 +122,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 @@ -214,7 +214,7 @@

Utilities for loading Discord extensions.

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

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

Parameters
@@ -230,7 +230,7 @@
-walk_extensions(module)[source]#
+walk_extensions(module)[source]#

Yield extension names from the given module.

Parameters
diff --git a/output/botcore.utils.html b/output/botcore.utils.html index f4dd4335..7c4819ea 100644 --- a/output/botcore.utils.html +++ b/output/botcore.utils.html @@ -6,7 +6,7 @@ - Utils - Bot Core v3.0.0 + Utils - Bot Core v3.0.1 @@ -122,7 +122,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 @@ -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 disnake.ext.commands.Command and disnake.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 2b3fecb1..1bcc41b8 100644 --- a/output/botcore.utils.logging.html +++ b/output/botcore.utils.logging.html @@ -6,7 +6,7 @@ - logging - Bot Core v3.0.0 + logging - Bot Core v3.0.1 @@ -122,7 +122,7 @@

-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 @@ -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 01f7993b..435fb207 100644 --- a/output/botcore.utils.members.html +++ b/output/botcore.utils.members.html @@ -6,7 +6,7 @@ - members - Bot Core v3.0.0 + members - Bot Core v3.0.1 @@ -122,7 +122,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 @@ -214,7 +214,7 @@

Useful helper functions for interactin with disnake.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 disnake.Member.add_roles and disnake.Member.remove_roles.

diff --git a/output/botcore.utils.regex.html b/output/botcore.utils.regex.html index 92b05fdb..8c6ac92a 100644 --- a/output/botcore.utils.regex.html +++ b/output/botcore.utils.regex.html @@ -6,7 +6,7 @@ - regex - Bot Core v3.0.0 + regex - Bot Core v3.0.1 @@ -122,7 +122,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 @@ -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 03f81fe0..7689f32c 100644 --- a/output/botcore.utils.scheduling.html +++ b/output/botcore.utils.scheduling.html @@ -6,7 +6,7 @@ - scheduling - Bot Core v3.0.0 + scheduling - Bot Core v3.0.1 @@ -122,7 +122,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -148,7 +148,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 @@ -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 31ef3e28..b68552da 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -4,7 +4,7 @@ - Python Module Index - Bot Core v3.0.0 + Python Module Index - Bot Core v3.0.1 @@ -120,7 +120,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -146,7 +146,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 diff --git a/search.html b/search.html index c1531dbd..4e54826c 100644 --- a/search.html +++ b/search.html @@ -4,7 +4,7 @@ - Search - Bot Core v3.0.0 + Search - Bot Core v3.0.1 @@ -119,7 +119,7 @@
-
Bot Core v3.0.0
 +
Bot Core v3.0.1
@@ -145,7 +145,7 @@
- Bot Core v3.0.0 + Bot Core v3.0.1 -- cgit v1.2.3