From d4b11263ea0ee661f88120841d27f76a92357773 Mon Sep 17 00:00:00 2001 From: HassanAbouelela Date: Tue, 15 Mar 2022 12:26:50 +0000 Subject: Deploying to docs from @ python-discord/bot-core@bc0a470dcd99007581975f23efabbda9266dac9d 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .buildinfo | 2 +- .doctrees/environment.pickle | Bin 2397395 -> 2335235 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 | 26 +++++++++--------- output/botcore.utils.extensions.html | 12 ++++---- output/botcore.utils.html | 12 ++++---- output/botcore.utils.logging.html | 12 ++++---- output/botcore.utils.members.html | 22 +++++++-------- output/botcore.utils.regex.html | 12 ++++---- output/botcore.utils.scheduling.html | 24 ++++++++-------- py-modindex.html | 6 ++-- search.html | 6 ++-- searchindex.js | 2 +- 29 files changed, 104 insertions(+), 104 deletions(-) diff --git a/.buildinfo b/.buildinfo index 18dc5a02..c3be127a 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: 3a4b0530645edb7db0a46977bbdc5756 +config: 13e2f2d4f4839d8e72867344dd1f3798 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 300ff7e0..1c5e09f7 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 3234a786..ebddffcb 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 54d8612f..0f918c18 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 26f4d647..052b9710 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 b49068d2..a51c841e 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 200693fb..aeeb664b 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 bfa812c0..02bbf350 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 fd3a6902..d636ea53 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 300a5dee..6608e6ef 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 7d6a8192..726bbb88 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 758bf8bb..57c0f823 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.1', + VERSION: '4.0.0', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/genindex.html b/genindex.html index 8523019b..6bf50724 100644 --- a/genindex.html +++ b/genindex.html @@ -4,7 +4,7 @@ - Index - Bot Core v3.0.1 + Index - Bot Core v4.0.0 @@ -120,7 +120,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -146,7 +146,7 @@
- Bot Core v3.0.1 + Bot Core v4.0.0
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.0.0 diff --git a/objects.inv b/objects.inv index d65a491e..de998950 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/output/botcore.exts.html b/output/botcore.exts.html index c62557d3..cdb504a7 100644 --- a/output/botcore.exts.html +++ b/output/botcore.exts.html @@ -6,7 +6,7 @@ - Exts - Bot Core v3.0.1 + Exts - Bot Core v4.0.0 @@ -122,7 +122,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.0.0 diff --git a/output/botcore.html b/output/botcore.html index 550fc282..bab52adf 100644 --- a/output/botcore.html +++ b/output/botcore.html @@ -6,7 +6,7 @@ - Botcore - Bot Core v3.0.1 + Botcore - Bot Core v4.0.0 @@ -122,7 +122,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.0.0 diff --git a/output/botcore.site_api.html b/output/botcore.site_api.html index c21edcde..36f452b2 100644 --- a/output/botcore.site_api.html +++ b/output/botcore.site_api.html @@ -6,7 +6,7 @@ - site_api - Bot Core v3.0.1 + site_api - Bot Core v4.0.0 @@ -122,7 +122,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.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 26ae287e..31bad895 100644 --- a/output/botcore.utils.caching.html +++ b/output/botcore.utils.caching.html @@ -6,7 +6,7 @@ - caching - Bot Core v3.0.1 + caching - Bot Core v4.0.0 @@ -122,7 +122,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.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 1d3cbc56..3ae467cc 100644 --- a/output/botcore.utils.channel.html +++ b/output/botcore.utils.channel.html @@ -6,7 +6,7 @@ - channel - Bot Core v3.0.1 + channel - Bot Core v4.0.0 @@ -122,7 +122,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.0.0 @@ -211,28 +211,28 @@

channel#

-

Useful helper functions for interacting with various disnake channel objects.

+

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
Raises
Return type
-

GuildChannel

+

GuildChannel

Returns

The channel from the ID.

@@ -241,12 +241,12 @@
-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
    -

  • channel (TextChannel) – The channel to check.

    • +

  • channel (TextChannel) – The channel to check.

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

diff --git a/output/botcore.utils.extensions.html b/output/botcore.utils.extensions.html index 5f5a034c..c585207d 100644 --- a/output/botcore.utils.extensions.html +++ b/output/botcore.utils.extensions.html @@ -6,7 +6,7 @@ - extensions - Bot Core v3.0.1 + extensions - Bot Core v4.0.0 @@ -122,7 +122,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.0.0 @@ -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
@@ -240,7 +240,7 @@

frozenset[str]

Returns
-

A set of strings that can be passed directly to disnake.ext.commands.Bot.load_extension.

+

A set of strings that can be passed directly to discord.ext.commands.Bot.load_extension.

diff --git a/output/botcore.utils.html b/output/botcore.utils.html index 7c4819ea..73efbf49 100644 --- a/output/botcore.utils.html +++ b/output/botcore.utils.html @@ -6,7 +6,7 @@ - Utils - Bot Core v3.0.1 + Utils - Bot Core v4.0.0 @@ -122,7 +122,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.0.0 @@ -214,14 +214,14 @@

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 +

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 that will act as top-level groups rather than being aliases of the command’s group.

It’s stored as an attribute also named root_aliases

-
Patches disnake’s internal send_typing method so that it ignores 403 errors from Discord.

When under heavy load Discord has added a CloudFlare worker to this route, which causes 403 errors to be thrown.

+
Patches discord’s internal send_typing method so that it ignores 403 errors from Discord.

When under heavy load Discord has added a CloudFlare worker to this route, which causes 403 errors to be thrown.

diff --git a/output/botcore.utils.logging.html b/output/botcore.utils.logging.html index 1bcc41b8..2dbc370d 100644 --- a/output/botcore.utils.logging.html +++ b/output/botcore.utils.logging.html @@ -6,7 +6,7 @@ - logging - Bot Core v3.0.1 + logging - Bot Core v4.0.0 @@ -122,7 +122,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.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 435fb207..47b0886e 100644 --- a/output/botcore.utils.members.html +++ b/output/botcore.utils.members.html @@ -6,7 +6,7 @@ - members - Bot Core v3.0.1 + members - Bot Core v4.0.0 @@ -122,7 +122,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.0.0 @@ -211,31 +211,31 @@

members#

-

Useful helper functions for interactin with disnake.Member objects.

+

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
-

Optional[Member]

+

Optional[Member]

Returns
-

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

+

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

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

+discord.Member.add_roles and discord.Member.remove_roles.

Parameters
Return type
diff --git a/output/botcore.utils.regex.html b/output/botcore.utils.regex.html index 8c6ac92a..bc2b4fde 100644 --- a/output/botcore.utils.regex.html +++ b/output/botcore.utils.regex.html @@ -6,7 +6,7 @@ - regex - Bot Core v3.0.1 + regex - Bot Core v4.0.0 @@ -122,7 +122,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.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 7689f32c..c2747347 100644 --- a/output/botcore.utils.scheduling.html +++ b/output/botcore.utils.scheduling.html @@ -6,7 +6,7 @@ - scheduling - Bot Core v3.0.1 + scheduling - Bot Core v4.0.0 @@ -122,7 +122,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -148,7 +148,7 @@
- Bot Core v3.0.1 + Bot Core v4.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 b68552da..67dc1e12 100644 --- a/py-modindex.html +++ b/py-modindex.html @@ -4,7 +4,7 @@ - Python Module Index - Bot Core v3.0.1 + Python Module Index - Bot Core v4.0.0 @@ -120,7 +120,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -146,7 +146,7 @@
- Bot Core v3.0.1 + Bot Core v4.0.0 diff --git a/search.html b/search.html index 4e54826c..f0b07f51 100644 --- a/search.html +++ b/search.html @@ -4,7 +4,7 @@ - Search - Bot Core v3.0.1 + Search - Bot Core v4.0.0 @@ -119,7 +119,7 @@
-
Bot Core v3.0.1
 +
Bot Core v4.0.0
@@ -145,7 +145,7 @@
- Bot Core v3.0.1 + Bot Core v4.0.0 diff --git a/searchindex.js b/searchindex.js index 7fd4a2b2..c96d7c72 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","output/botcore","output/botcore.exts","output/botcore.site_api","output/botcore.utils","output/botcore.utils.caching","output/botcore.utils.channel","output/botcore.utils.extensions","output/botcore.utils.logging","output/botcore.utils.members","output/botcore.utils.regex","output/botcore.utils.scheduling"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,sphinx:56},filenames:["index.rst","output/botcore.rst","output/botcore.exts.rst","output/botcore.site_api.rst","output/botcore.utils.rst","output/botcore.utils.caching.rst","output/botcore.utils.channel.rst","output/botcore.utils.extensions.rst","output/botcore.utils.logging.rst","output/botcore.utils.members.rst","output/botcore.utils.regex.rst","output/botcore.utils.scheduling.rst"],objects:{"":[[1,0,0,"-","botcore"]],"botcore.site_api":[[3,1,1,"","APIClient"],[3,3,1,"","ResponseCodeError"]],"botcore.site_api.APIClient":[[3,2,1,"","__init__"],[3,2,1,"","close"],[3,2,1,"","delete"],[3,2,1,"","get"],[3,2,1,"","maybe_raise_for_status"],[3,2,1,"","patch"],[3,2,1,"","post"],[3,2,1,"","put"],[3,2,1,"","request"]],"botcore.site_api.ResponseCodeError":[[3,2,1,"","__init__"],[3,2,1,"","__str__"]],"botcore.utils":[[4,4,1,"","apply_monkey_patches"],[5,0,0,"-","caching"],[6,0,0,"-","channel"],[7,0,0,"-","extensions"],[8,0,0,"-","logging"],[9,0,0,"-","members"],[10,0,0,"-","regex"],[11,0,0,"-","scheduling"]],"botcore.utils.caching":[[5,1,1,"","AsyncCache"]],"botcore.utils.caching.AsyncCache":[[5,2,1,"","__call__"],[5,2,1,"","__init__"],[5,2,1,"","clear"]],"botcore.utils.channel":[[6,4,1,"","get_or_fetch_channel"],[6,4,1,"","is_in_category"]],"botcore.utils.extensions":[[7,4,1,"","unqualify"],[7,4,1,"","walk_extensions"]],"botcore.utils.logging":[[8,1,1,"","CustomLogger"],[8,4,1,"","get_logger"]],"botcore.utils.logging.CustomLogger":[[8,2,1,"","trace"]],"botcore.utils.members":[[9,4,1,"","get_or_fetch_member"],[9,4,1,"","handle_role_change"]],"botcore.utils.regex":[[10,5,1,"","DISCORD_INVITE"],[10,5,1,"","FORMATTED_CODE_REGEX"],[10,5,1,"","RAW_CODE_REGEX"]],"botcore.utils.scheduling":[[11,1,1,"","Scheduler"],[11,4,1,"","create_task"]],"botcore.utils.scheduling.Scheduler":[[11,2,1,"","__contains__"],[11,2,1,"","__init__"],[11,2,1,"","cancel"],[11,2,1,"","cancel_all"],[11,2,1,"","schedule"],[11,2,1,"","schedule_at"],[11,2,1,"","schedule_later"]],botcore:[[2,0,0,"-","exts"],[3,0,0,"-","site_api"],[4,0,0,"-","utils"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","exception","Python exception"],"4":["py","function","Python function"],"5":["py","data","Python data"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:exception","4":"py:function","5":"py:data"},terms:{"0":[5,8],"1":8,"128":5,"204":3,"403":4,"class":[3,5,8,11],"do":6,"float":11,"function":[5,6,8,9,11],"int":[5,6,11],"long":11,"na\u00efv":11,"new":[3,5,11],"return":[3,4,5,6,7,8,9,11],"true":[3,8,11],A:[3,4,5,6,7,11],If:[3,11],It:4,No:3,The:[3,5,6,7,8,9,11],To:8,__call__:5,__contains__:11,__init__:[3,5,11],__str__:3,abstracteventloop:11,act:4,ad:[4,8],add_rol:9,after:11,aiohttp:3,alia:4,alias:4,all:[4,11],alreadi:11,also:4,an:[3,4,5,6,7,8,11],ani:[3,11],api:[3,9],apicli:3,appli:[4,5],apply_monkey_patch:4,ar:5,arg:8,arg_offset:5,argument:[3,4,5,8,9],around:3,async:[3,5,6,9],asynccach:5,asyncio:11,attempt:[6,9],attribut:4,authent:3,await:[9,11],awar:11,base:[3,5,8,11],befor:11,being:4,block:10,bool:[3,6,11],bot:[1,4,6,7],botcor:0,cach:[1,4,6,9],calcul:11,call:11,callabl:[5,9],can:[7,11],cancel:11,cancel_al:11,categori:6,category_id:6,caus:4,changelog:0,channel:[1,4],channel_id:6,check:[3,6,11],clear:5,clientrespons:3,clientsess:3,close:[3,11],cloudflar:4,code:10,cog:2,command:[4,6,7],common:[4,8,10],constructor:3,contain:11,content:3,coro:[9,11],coroutin:[5,9,11],could:9,creat:[5,11],create_task:11,current:11,custom:[5,8],customlogg:8,datetim:11,decor:5,delai:11,delet:[3,5],depend:6,develop:[1,4],dict:3,directli:7,discord:[1,2,4,6,7,10],discord_invit:10,disnak:[4,6,7,9],distinguish:11,django:3,doesn:11,don:11,done:11,elsewher:11,endpoint:3,equival:3,error:[3,4,9],event:11,event_loop:11,exc_info:8,exce:5,except:[3,8,11],execut:11,exist:11,expect:9,express:10,ext:[0,1,4,6,7],extens:[1,4],extra:3,fail:6,failur:9,fetch:[6,9],fifo:5,forbidden:6,format:10,formatted_code_regex:10,found:[9,11],from:[3,4,6,7,9,11],frozenset:7,futur:11,gener:11,get:[3,6,9],get_logg:8,get_or_fetch_channel:6,get_or_fetch_memb:9,given:[6,7,8,9,11],group:4,guild:9,guildchannel:6,ha:4,handl:[9,11],handle_role_chang:9,hashabl:11,have:[6,8],heavi:4,helper:[6,9],houston:8,how:[5,11],http:3,httpexcept:6,id:[6,11],identifi:11,ignor:4,immedi:11,implement:[5,8],index:0,indic:9,inform:[0,8],initi:[3,11],initialis:5,instanc:[3,5,6,8,11],instanti:11,instead:11,intend:9,interact:6,interactin:9,interest:8,intern:4,invalid:6,invaliddata:6,invit:10,is_in_categori:6,item:5,json:3,keep:11,kei:5,keyword:[3,4,8],known:11,kwarg:[3,8,11],level:[4,8],ll:11,load:[4,7],load_extens:7,log:[1,4,11],logger:8,look:[7,11],loop:11,lru:5,mai:5,make:8,mani:5,max_siz:5,maximum:5,maybe_raise_for_statu:3,member:[1,4],member_id:9,messag:[8,11],method:[3,4,8],modul:[7,11],moduletyp:7,monkei:4,msg:8,must:11,mypi:8,name:[4,7,8,11],namespac:11,non:3,none:[3,4,5,8,9,11],notfound:6,now:11,object:[3,4,5,6,9,11],offset:5,ok:3,onc:5,oper:11,option:[3,5,8,9],order:[5,11],other:11,otherwis:11,our:4,packag:7,page:0,paramet:[3,5,6,7,8,9,11],pass:[3,7,8,9,11],past:11,patch:[3,4],permiss:6,posit:5,post:3,prematur:11,prevent:11,problem:8,provid:[5,11],put:3,python:11,qualifi:7,rais:[3,6,9,11],raise_for_statu:3,rather:4,raw:10,raw_code_regex:10,re:11,receiv:[3,6],recognis:8,regex:[1,4],regular:10,relat:[5,8],remove_rol:9,represent:3,request:3,request_text:3,requir:11,respons:3,response_json:3,response_text:3,responsecodeerror:3,result:11,retriev:6,reusabl:2,role:9,root:4,root_alias:4,rout:4,run:11,s:[4,5,8,10,11],same:11,schedul:[1,4],schedule_at:11,schedule_lat:11,search:0,second:11,send:3,send_typ:4,sequenc:4,server:10,session:3,session_kwarg:3,set:7,sever:8,should:3,should_rais:3,site:3,site_api:[0,1],site_api_token:3,site_api_url:3,size:5,so:4,sole:9,sourc:[3,4,5,6,7,8,9,10,11],start:11,store:[4,5],str:[3,7,8,11],string:[3,7],submodul:0,subpackag:0,subtract:11,suggest:11,support:[4,11],suppressed_except:11,t:11,target:5,task:11,task_id:11,text:3,textchannel:6,than:4,them:11,thi:[4,6,9,11],thrown:4,time:11,timezon:11,token:3,tool:[1,4],top:4,trace:8,track:11,tupl:11,two:4,type:[3,4,5,6,7,8,9,11],unawait:11,under:4,union:11,uniqu:11,unknown:6,unqualifi:7,unschedul:11,url:3,us:[1,3,4,6,8,9,10,11],utc:11,util:[0,1,5,7,8],valu:8,valueerror:3,variou:6,wa:[6,11],wait:11,walk_extens:7,warn:11,we:[8,9],when:[3,4,5,11],whether:[3,6],which:[4,11],worker:4,wrap:[5,11],wrapper:[3,11],yield:7,you:6},titles:["Bot Core Project Documentation","Botcore","Exts","site_api","Utils","caching","channel","extensions","logging","members","regex","scheduling"],titleterms:{bot:0,botcor:1,cach:5,channel:6,core:0,document:0,ext:2,extens:7,extra:0,log:8,member:9,modul:0,other:0,project:0,refer:0,regex:10,schedul:11,site_api:3,submodul:[1,4],subpackag:1,util:4}}) \ No newline at end of file +Search.setIndex({docnames:["index","output/botcore","output/botcore.exts","output/botcore.site_api","output/botcore.utils","output/botcore.utils.caching","output/botcore.utils.channel","output/botcore.utils.extensions","output/botcore.utils.logging","output/botcore.utils.members","output/botcore.utils.regex","output/botcore.utils.scheduling"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,sphinx:56},filenames:["index.rst","output/botcore.rst","output/botcore.exts.rst","output/botcore.site_api.rst","output/botcore.utils.rst","output/botcore.utils.caching.rst","output/botcore.utils.channel.rst","output/botcore.utils.extensions.rst","output/botcore.utils.logging.rst","output/botcore.utils.members.rst","output/botcore.utils.regex.rst","output/botcore.utils.scheduling.rst"],objects:{"":[[1,0,0,"-","botcore"]],"botcore.site_api":[[3,1,1,"","APIClient"],[3,3,1,"","ResponseCodeError"]],"botcore.site_api.APIClient":[[3,2,1,"","__init__"],[3,2,1,"","close"],[3,2,1,"","delete"],[3,2,1,"","get"],[3,2,1,"","maybe_raise_for_status"],[3,2,1,"","patch"],[3,2,1,"","post"],[3,2,1,"","put"],[3,2,1,"","request"]],"botcore.site_api.ResponseCodeError":[[3,2,1,"","__init__"],[3,2,1,"","__str__"]],"botcore.utils":[[4,4,1,"","apply_monkey_patches"],[5,0,0,"-","caching"],[6,0,0,"-","channel"],[7,0,0,"-","extensions"],[8,0,0,"-","logging"],[9,0,0,"-","members"],[10,0,0,"-","regex"],[11,0,0,"-","scheduling"]],"botcore.utils.caching":[[5,1,1,"","AsyncCache"]],"botcore.utils.caching.AsyncCache":[[5,2,1,"","__call__"],[5,2,1,"","__init__"],[5,2,1,"","clear"]],"botcore.utils.channel":[[6,4,1,"","get_or_fetch_channel"],[6,4,1,"","is_in_category"]],"botcore.utils.extensions":[[7,4,1,"","unqualify"],[7,4,1,"","walk_extensions"]],"botcore.utils.logging":[[8,1,1,"","CustomLogger"],[8,4,1,"","get_logger"]],"botcore.utils.logging.CustomLogger":[[8,2,1,"","trace"]],"botcore.utils.members":[[9,4,1,"","get_or_fetch_member"],[9,4,1,"","handle_role_change"]],"botcore.utils.regex":[[10,5,1,"","DISCORD_INVITE"],[10,5,1,"","FORMATTED_CODE_REGEX"],[10,5,1,"","RAW_CODE_REGEX"]],"botcore.utils.scheduling":[[11,1,1,"","Scheduler"],[11,4,1,"","create_task"]],"botcore.utils.scheduling.Scheduler":[[11,2,1,"","__contains__"],[11,2,1,"","__init__"],[11,2,1,"","cancel"],[11,2,1,"","cancel_all"],[11,2,1,"","schedule"],[11,2,1,"","schedule_at"],[11,2,1,"","schedule_later"]],botcore:[[2,0,0,"-","exts"],[3,0,0,"-","site_api"],[4,0,0,"-","utils"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","exception","Python exception"],"4":["py","function","Python function"],"5":["py","data","Python data"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:exception","4":"py:function","5":"py:data"},terms:{"0":[5,8],"1":8,"128":5,"204":3,"403":4,"class":[3,5,8,11],"do":6,"float":11,"function":[5,6,8,9,11],"int":[5,6,11],"long":11,"na\u00efv":11,"new":[3,5,11],"return":[3,4,5,6,7,8,9,11],"true":[3,8,11],A:[3,4,5,6,7,11],If:[3,11],It:4,No:3,The:[3,5,6,7,8,9,11],To:8,__call__:5,__contains__:11,__init__:[3,5,11],__str__:3,abstracteventloop:11,act:4,ad:[4,8],add_rol:9,after:11,aiohttp:3,alia:4,alias:4,all:[4,11],alreadi:11,also:4,an:[3,4,5,6,7,8,11],ani:[3,11],api:[3,9],apicli:3,appli:[4,5],apply_monkey_patch:4,ar:5,arg:8,arg_offset:5,argument:[3,4,5,8,9],around:3,async:[3,5,6,9],asynccach:5,asyncio:11,attempt:[6,9],attribut:4,authent:3,await:[9,11],awar:11,base:[3,5,8,11],befor:11,being:4,block:10,bool:[3,6,11],bot:[1,4,6,7],botcor:0,cach:[1,4,6,9],calcul:11,call:11,callabl:[5,9],can:[7,11],cancel:11,cancel_al:11,categori:6,category_id:6,caus:4,changelog:0,channel:[1,4],channel_id:6,check:[3,6,11],clear:5,clientrespons:3,clientsess:3,close:[3,11],cloudflar:4,code:10,cog:2,command:[4,6,7],common:[4,8,10],constructor:3,contain:11,content:3,coro:[9,11],coroutin:[5,9,11],could:9,creat:[5,11],create_task:11,current:11,custom:[5,8],customlogg:8,datetim:11,decor:5,delai:11,delet:[3,5],depend:6,develop:[1,4],dict:3,directli:7,discord:[1,2,4,6,7,9,10],discord_invit:10,distinguish:11,django:3,doesn:11,don:11,done:11,elsewher:11,endpoint:3,equival:3,error:[3,4,9],event:11,event_loop:11,exc_info:8,exce:5,except:[3,8,11],execut:11,exist:11,expect:9,express:10,ext:[0,1,4,6,7],extens:[1,4],extra:3,fail:6,failur:9,fetch:[6,9],fifo:5,forbidden:6,format:10,formatted_code_regex:10,found:[9,11],from:[3,4,6,7,9,11],frozenset:7,futur:11,gener:11,get:[3,6,9],get_logg:8,get_or_fetch_channel:6,get_or_fetch_memb:9,given:[6,7,8,9,11],group:4,guild:9,guildchannel:6,ha:4,handl:[9,11],handle_role_chang:9,hashabl:11,have:[6,8],heavi:4,helper:[6,9],houston:8,how:[5,11],http:3,httpexcept:6,id:[6,11],identifi:11,ignor:4,immedi:11,implement:[5,8],index:0,indic:9,inform:[0,8],initi:[3,11],initialis:5,instanc:[3,5,6,8,11],instanti:11,instead:11,intend:9,interact:6,interactin:9,interest:8,intern:4,invalid:6,invaliddata:6,invit:10,is_in_categori:6,item:5,json:3,keep:11,kei:5,keyword:[3,4,8],known:11,kwarg:[3,8,11],level:[4,8],ll:11,load:[4,7],load_extens:7,log:[1,4,11],logger:8,look:[7,11],loop:11,lru:5,mai:5,make:8,mani:5,max_siz:5,maximum:5,maybe_raise_for_statu:3,member:[1,4],member_id:9,messag:[8,11],method:[3,4,8],modul:[7,11],moduletyp:7,monkei:4,msg:8,must:11,mypi:8,name:[4,7,8,11],namespac:11,non:3,none:[3,4,5,8,9,11],notfound:6,now:11,object:[3,4,5,6,9,11],offset:5,ok:3,onc:5,oper:11,option:[3,5,8,9],order:[5,11],other:11,otherwis:11,our:4,packag:7,page:0,paramet:[3,5,6,7,8,9,11],pass:[3,7,8,9,11],past:11,patch:[3,4],permiss:6,posit:5,post:3,prematur:11,prevent:11,problem:8,provid:[5,11],put:3,python:11,qualifi:7,rais:[3,6,9,11],raise_for_statu:3,rather:4,raw:10,raw_code_regex:10,re:11,receiv:[3,6],recognis:8,regex:[1,4],regular:10,relat:[5,8],remove_rol:9,represent:3,request:3,request_text:3,requir:11,respons:3,response_json:3,response_text:3,responsecodeerror:3,result:11,retriev:6,reusabl:2,role:9,root:4,root_alias:4,rout:4,run:11,s:[4,5,8,10,11],same:11,schedul:[1,4],schedule_at:11,schedule_lat:11,search:0,second:11,send:3,send_typ:4,sequenc:4,server:10,session:3,session_kwarg:3,set:7,sever:8,should:3,should_rais:3,site:3,site_api:[0,1],site_api_token:3,site_api_url:3,size:5,so:4,sole:9,sourc:[3,4,5,6,7,8,9,10,11],start:11,store:[4,5],str:[3,7,8,11],string:[3,7],submodul:0,subpackag:0,subtract:11,suggest:11,support:[4,11],suppressed_except:11,t:11,target:5,task:11,task_id:11,text:3,textchannel:6,than:4,them:11,thi:[4,6,9,11],thrown:4,time:11,timezon:11,token:3,tool:[1,4],top:4,trace:8,track:11,tupl:11,two:4,type:[3,4,5,6,7,8,9,11],unawait:11,under:4,union:11,uniqu:11,unknown:6,unqualifi:7,unschedul:11,url:3,us:[1,3,4,6,8,9,10,11],utc:11,util:[0,1,5,7,8],valu:8,valueerror:3,variou:6,wa:[6,11],wait:11,walk_extens:7,warn:11,we:[8,9],when:[3,4,5,11],whether:[3,6],which:[4,11],worker:4,wrap:[5,11],wrapper:[3,11],yield:7,you:6},titles:["Bot Core Project Documentation","Botcore","Exts","site_api","Utils","caching","channel","extensions","logging","members","regex","scheduling"],titleterms:{bot:0,botcor:1,cach:5,channel:6,core:0,document:0,ext:2,extens:7,extra:0,log:8,member:9,modul:0,other:0,project:0,refer:0,regex:10,schedul:11,site_api:3,submodul:[1,4],subpackag:1,util:4}}) \ No newline at end of file -- cgit v1.2.3