From 03157db62f6bfad9862564a9d230de707254b57b Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sat, 22 Jun 2024 11:10:12 +0000 Subject: Deploying to docs from @ python-discord/bot-core@3fe3eaefc11cd8e5c2ca17fe9e99fe3ef5639933 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _static/documentation_options.js | 2 +- index.html | 4 +- main/.buildinfo | 2 +- main/_static/documentation_options.js | 2 +- main/_static/pygments.css | 12 +-- main/changelog.html | 19 +++-- main/development.html | 8 +- main/genindex.html | 8 +- main/index.html | 8 +- main/index_redirect.html | 4 +- main/objects.inv | Bin 2376 -> 2376 bytes main/output/pydis_core.async_stats.html | 14 ++-- main/output/pydis_core.exts.html | 8 +- main/output/pydis_core.html | 84 ++++++++++----------- main/output/pydis_core.site_api.html | 34 ++++----- main/output/pydis_core.utils.caching.html | 16 ++-- main/output/pydis_core.utils.channel.html | 26 +++---- main/output/pydis_core.utils.checks.html | 32 ++++---- main/output/pydis_core.utils.commands.html | 14 ++-- main/output/pydis_core.utils.cooldown.html | 22 +++--- ...dis_core.utils.error_handling.commands.abc.html | 16 ++-- .../pydis_core.utils.error_handling.commands.html | 24 +++--- ...core.utils.error_handling.commands.manager.html | 16 ++-- main/output/pydis_core.utils.error_handling.html | 14 ++-- main/output/pydis_core.utils.function.html | 20 ++--- main/output/pydis_core.utils.html | 14 ++-- main/output/pydis_core.utils.interactions.html | 36 ++++----- main/output/pydis_core.utils.lock.html | 30 ++++---- main/output/pydis_core.utils.logging.html | 16 ++-- main/output/pydis_core.utils.members.html | 26 +++---- main/output/pydis_core.utils.messages.html | 10 +-- main/output/pydis_core.utils.pagination.html | 30 ++++---- main/output/pydis_core.utils.paste_service.html | 22 +++--- main/output/pydis_core.utils.regex.html | 14 ++-- main/output/pydis_core.utils.scheduling.html | 26 +++---- main/py-modindex.html | 8 +- main/search.html | 8 +- main/searchindex.js | 2 +- main/versions.html | 8 +- v10.0.0/.buildinfo | 2 +- v10.0.0/_static/pygments.css | 12 +-- v10.0.0/changelog.html | 2 +- v10.0.0/output/pydis_core.html | 4 +- v10.0.0/output/pydis_core.utils.channel.html | 14 ++-- v10.0.0/output/pydis_core.utils.commands.html | 4 +- v10.0.0/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v10.0.0/output/pydis_core.utils.html | 2 +- v10.0.0/output/pydis_core.utils.interactions.html | 8 +- v10.0.0/output/pydis_core.utils.members.html | 14 ++-- v10.1.0/.buildinfo | 2 +- v10.1.0/_static/pygments.css | 12 +-- v10.1.0/changelog.html | 4 +- v10.1.0/output/pydis_core.html | 4 +- v10.1.0/output/pydis_core.utils.channel.html | 14 ++-- v10.1.0/output/pydis_core.utils.commands.html | 4 +- v10.1.0/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v10.1.0/output/pydis_core.utils.html | 2 +- v10.1.0/output/pydis_core.utils.interactions.html | 8 +- v10.1.0/output/pydis_core.utils.members.html | 14 ++-- v10.2.0/.buildinfo | 2 +- v10.2.0/_static/pygments.css | 12 +-- v10.2.0/changelog.html | 4 +- v10.2.0/output/pydis_core.html | 4 +- v10.2.0/output/pydis_core.utils.channel.html | 14 ++-- v10.2.0/output/pydis_core.utils.commands.html | 4 +- v10.2.0/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v10.2.0/output/pydis_core.utils.html | 2 +- v10.2.0/output/pydis_core.utils.interactions.html | 8 +- v10.2.0/output/pydis_core.utils.members.html | 14 ++-- v10.3.0/.buildinfo | 2 +- v10.3.0/_static/pygments.css | 12 +-- v10.3.0/changelog.html | 4 +- v10.3.0/output/pydis_core.html | 4 +- v10.3.0/output/pydis_core.utils.channel.html | 14 ++-- v10.3.0/output/pydis_core.utils.commands.html | 4 +- v10.3.0/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v10.3.0/output/pydis_core.utils.html | 2 +- v10.3.0/output/pydis_core.utils.interactions.html | 8 +- v10.3.0/output/pydis_core.utils.members.html | 14 ++-- v10.4.0/.buildinfo | 2 +- v10.4.0/_static/pygments.css | 12 +-- v10.4.0/changelog.html | 4 +- v10.4.0/output/pydis_core.html | 4 +- v10.4.0/output/pydis_core.utils.channel.html | 14 ++-- v10.4.0/output/pydis_core.utils.commands.html | 4 +- v10.4.0/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v10.4.0/output/pydis_core.utils.html | 2 +- v10.4.0/output/pydis_core.utils.interactions.html | 8 +- v10.4.0/output/pydis_core.utils.members.html | 14 ++-- v10.5.0/.buildinfo | 2 +- v10.5.0/_static/pygments.css | 12 +-- v10.5.0/changelog.html | 4 +- v10.5.0/output/pydis_core.html | 4 +- v10.5.0/output/pydis_core.utils.channel.html | 14 ++-- v10.5.0/output/pydis_core.utils.commands.html | 4 +- v10.5.0/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v10.5.0/output/pydis_core.utils.html | 2 +- v10.5.0/output/pydis_core.utils.interactions.html | 8 +- v10.5.0/output/pydis_core.utils.members.html | 14 ++-- v10.5.1/.buildinfo | 2 +- v10.5.1/_static/pygments.css | 12 +-- v10.5.1/changelog.html | 4 +- v10.5.1/output/pydis_core.html | 4 +- v10.5.1/output/pydis_core.utils.channel.html | 14 ++-- v10.5.1/output/pydis_core.utils.commands.html | 4 +- v10.5.1/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v10.5.1/output/pydis_core.utils.html | 2 +- v10.5.1/output/pydis_core.utils.interactions.html | 8 +- v10.5.1/output/pydis_core.utils.members.html | 14 ++-- v10.6.0/.buildinfo | 2 +- v10.6.0/_static/pygments.css | 12 +-- v10.6.0/changelog.html | 4 +- v10.6.0/output/pydis_core.html | 14 ++-- v10.6.0/output/pydis_core.utils.channel.html | 14 ++-- v10.6.0/output/pydis_core.utils.checks.html | 10 +-- v10.6.0/output/pydis_core.utils.commands.html | 4 +- v10.6.0/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v10.6.0/output/pydis_core.utils.html | 2 +- v10.6.0/output/pydis_core.utils.interactions.html | 8 +- v10.6.0/output/pydis_core.utils.members.html | 14 ++-- v10.6.0/output/pydis_core.utils.pagination.html | 10 +-- v10.7.0/.buildinfo | 2 +- v10.7.0/_static/pygments.css | 12 +-- v10.7.0/changelog.html | 4 +- v10.7.0/output/pydis_core.html | 14 ++-- v10.7.0/output/pydis_core.utils.channel.html | 14 ++-- v10.7.0/output/pydis_core.utils.checks.html | 10 +-- v10.7.0/output/pydis_core.utils.commands.html | 4 +- v10.7.0/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v10.7.0/output/pydis_core.utils.html | 2 +- v10.7.0/output/pydis_core.utils.interactions.html | 10 +-- v10.7.0/output/pydis_core.utils.members.html | 14 ++-- v10.7.0/output/pydis_core.utils.pagination.html | 10 +-- v11.0.0/.buildinfo | 2 +- v11.0.0/_static/pygments.css | 12 +-- v11.0.0/changelog.html | 4 +- v11.0.0/output/pydis_core.html | 14 ++-- v11.0.0/output/pydis_core.utils.channel.html | 14 ++-- v11.0.0/output/pydis_core.utils.checks.html | 10 +-- v11.0.0/output/pydis_core.utils.commands.html | 4 +- v11.0.0/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v11.0.0/output/pydis_core.utils.html | 2 +- v11.0.0/output/pydis_core.utils.interactions.html | 10 +-- v11.0.0/output/pydis_core.utils.members.html | 14 ++-- v11.0.0/output/pydis_core.utils.pagination.html | 10 +-- v11.0.1/.buildinfo | 2 +- v11.0.1/_static/pygments.css | 12 +-- v11.0.1/changelog.html | 6 +- v11.0.1/output/pydis_core.html | 14 ++-- v11.0.1/output/pydis_core.utils.channel.html | 14 ++-- v11.0.1/output/pydis_core.utils.checks.html | 10 +-- v11.0.1/output/pydis_core.utils.commands.html | 4 +- v11.0.1/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v11.0.1/output/pydis_core.utils.html | 2 +- v11.0.1/output/pydis_core.utils.interactions.html | 10 +-- v11.0.1/output/pydis_core.utils.members.html | 14 ++-- v11.0.1/output/pydis_core.utils.pagination.html | 10 +-- v11.1.0/.buildinfo | 2 +- v11.1.0/_static/pygments.css | 12 +-- v11.1.0/changelog.html | 6 +- v11.1.0/output/pydis_core.html | 14 ++-- v11.1.0/output/pydis_core.utils.channel.html | 14 ++-- v11.1.0/output/pydis_core.utils.checks.html | 10 +-- v11.1.0/output/pydis_core.utils.commands.html | 4 +- v11.1.0/output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v11.1.0/output/pydis_core.utils.html | 2 +- v11.1.0/output/pydis_core.utils.interactions.html | 10 +-- v11.1.0/output/pydis_core.utils.members.html | 14 ++-- v11.1.0/output/pydis_core.utils.pagination.html | 10 +-- v9.0.0/.buildinfo | 2 +- v9.0.0/_static/pygments.css | 12 +-- v9.0.0/output/pydis_core.html | 4 +- v9.0.0/output/pydis_core.utils.channel.html | 14 ++-- v9.0.0/output/pydis_core.utils.commands.html | 4 +- v9.0.0/output/pydis_core.utils.cooldown.html | 2 +- v9.0.0/output/pydis_core.utils.html | 2 +- v9.0.0/output/pydis_core.utils.interactions.html | 8 +- v9.0.0/output/pydis_core.utils.members.html | 14 ++-- v9.1.1/.buildinfo | 2 +- v9.1.1/_static/pygments.css | 12 +-- v9.1.1/output/pydis_core.html | 4 +- v9.1.1/output/pydis_core.utils.channel.html | 14 ++-- v9.1.1/output/pydis_core.utils.commands.html | 4 +- v9.1.1/output/pydis_core.utils.cooldown.html | 2 +- v9.1.1/output/pydis_core.utils.html | 2 +- v9.1.1/output/pydis_core.utils.interactions.html | 8 +- v9.1.1/output/pydis_core.utils.members.html | 14 ++-- v9.10.0-alpha.1/.buildinfo | 2 +- v9.10.0-alpha.1/_static/pygments.css | 12 +-- v9.10.0-alpha.1/output/pydis_core.html | 4 +- .../output/pydis_core.utils.channel.html | 14 ++-- .../output/pydis_core.utils.commands.html | 4 +- .../output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v9.10.0-alpha.1/output/pydis_core.utils.html | 2 +- .../output/pydis_core.utils.interactions.html | 8 +- .../output/pydis_core.utils.members.html | 14 ++-- v9.10.0-alpha.2/.buildinfo | 2 +- v9.10.0-alpha.2/_static/pygments.css | 12 +-- v9.10.0-alpha.2/output/pydis_core.html | 4 +- .../output/pydis_core.utils.channel.html | 14 ++-- .../output/pydis_core.utils.commands.html | 4 +- .../output/pydis_core.utils.cooldown.html | 2 +- .../output/pydis_core.utils.error_handling.html | 4 +- v9.10.0-alpha.2/output/pydis_core.utils.html | 2 +- .../output/pydis_core.utils.interactions.html | 8 +- .../output/pydis_core.utils.members.html | 14 ++-- v9.2.0/.buildinfo | 2 +- v9.2.0/_static/pygments.css | 12 +-- v9.2.0/output/pydis_core.html | 4 +- v9.2.0/output/pydis_core.utils.channel.html | 14 ++-- v9.2.0/output/pydis_core.utils.commands.html | 4 +- v9.2.0/output/pydis_core.utils.cooldown.html | 2 +- v9.2.0/output/pydis_core.utils.html | 2 +- v9.2.0/output/pydis_core.utils.interactions.html | 8 +- v9.2.0/output/pydis_core.utils.members.html | 14 ++-- v9.3.0/.buildinfo | 2 +- v9.3.0/_static/pygments.css | 12 +-- v9.3.0/output/pydis_core.html | 4 +- v9.3.0/output/pydis_core.utils.channel.html | 14 ++-- v9.3.0/output/pydis_core.utils.commands.html | 4 +- v9.3.0/output/pydis_core.utils.cooldown.html | 2 +- v9.3.0/output/pydis_core.utils.html | 2 +- v9.3.0/output/pydis_core.utils.interactions.html | 8 +- v9.3.0/output/pydis_core.utils.members.html | 14 ++-- v9.4.0/.buildinfo | 2 +- v9.4.0/_static/pygments.css | 12 +-- v9.4.0/output/pydis_core.html | 4 +- v9.4.0/output/pydis_core.utils.channel.html | 14 ++-- v9.4.0/output/pydis_core.utils.commands.html | 4 +- v9.4.0/output/pydis_core.utils.cooldown.html | 2 +- v9.4.0/output/pydis_core.utils.html | 2 +- v9.4.0/output/pydis_core.utils.interactions.html | 8 +- v9.4.0/output/pydis_core.utils.members.html | 14 ++-- v9.4.1/.buildinfo | 2 +- v9.4.1/_static/pygments.css | 12 +-- v9.4.1/output/pydis_core.html | 4 +- v9.4.1/output/pydis_core.utils.channel.html | 14 ++-- v9.4.1/output/pydis_core.utils.commands.html | 4 +- v9.4.1/output/pydis_core.utils.cooldown.html | 2 +- v9.4.1/output/pydis_core.utils.html | 2 +- v9.4.1/output/pydis_core.utils.interactions.html | 8 +- v9.4.1/output/pydis_core.utils.members.html | 14 ++-- v9.5.0/.buildinfo | 2 +- v9.5.0/_static/pygments.css | 12 +-- v9.5.0/output/pydis_core.html | 4 +- v9.5.0/output/pydis_core.utils.channel.html | 14 ++-- v9.5.0/output/pydis_core.utils.commands.html | 4 +- v9.5.0/output/pydis_core.utils.cooldown.html | 2 +- v9.5.0/output/pydis_core.utils.html | 2 +- v9.5.0/output/pydis_core.utils.interactions.html | 8 +- v9.5.0/output/pydis_core.utils.members.html | 14 ++-- v9.5.1/.buildinfo | 2 +- v9.5.1/_static/pygments.css | 12 +-- v9.5.1/output/pydis_core.html | 4 +- v9.5.1/output/pydis_core.utils.channel.html | 14 ++-- v9.5.1/output/pydis_core.utils.commands.html | 4 +- v9.5.1/output/pydis_core.utils.cooldown.html | 2 +- v9.5.1/output/pydis_core.utils.html | 2 +- v9.5.1/output/pydis_core.utils.interactions.html | 8 +- v9.5.1/output/pydis_core.utils.members.html | 14 ++-- v9.6.0/.buildinfo | 2 +- v9.6.0/_static/pygments.css | 12 +-- v9.6.0/output/pydis_core.html | 4 +- v9.6.0/output/pydis_core.utils.channel.html | 14 ++-- v9.6.0/output/pydis_core.utils.commands.html | 4 +- v9.6.0/output/pydis_core.utils.cooldown.html | 2 +- v9.6.0/output/pydis_core.utils.html | 2 +- v9.6.0/output/pydis_core.utils.interactions.html | 8 +- v9.6.0/output/pydis_core.utils.members.html | 14 ++-- v9.7.0/.buildinfo | 2 +- v9.7.0/_static/pygments.css | 12 +-- v9.7.0/output/pydis_core.html | 4 +- v9.7.0/output/pydis_core.utils.channel.html | 14 ++-- v9.7.0/output/pydis_core.utils.commands.html | 4 +- v9.7.0/output/pydis_core.utils.cooldown.html | 2 +- v9.7.0/output/pydis_core.utils.error_handling.html | 4 +- v9.7.0/output/pydis_core.utils.html | 2 +- v9.7.0/output/pydis_core.utils.interactions.html | 8 +- v9.7.0/output/pydis_core.utils.members.html | 14 ++-- v9.8.0/.buildinfo | 2 +- v9.8.0/_static/pygments.css | 12 +-- v9.8.0/output/pydis_core.html | 4 +- v9.8.0/output/pydis_core.utils.channel.html | 14 ++-- v9.8.0/output/pydis_core.utils.commands.html | 4 +- v9.8.0/output/pydis_core.utils.cooldown.html | 2 +- v9.8.0/output/pydis_core.utils.error_handling.html | 4 +- v9.8.0/output/pydis_core.utils.html | 2 +- v9.8.0/output/pydis_core.utils.interactions.html | 8 +- v9.8.0/output/pydis_core.utils.members.html | 14 ++-- v9.9.0/.buildinfo | 2 +- v9.9.0/_static/pygments.css | 12 +-- v9.9.0/output/pydis_core.html | 4 +- v9.9.0/output/pydis_core.utils.channel.html | 14 ++-- v9.9.0/output/pydis_core.utils.commands.html | 4 +- v9.9.0/output/pydis_core.utils.cooldown.html | 2 +- v9.9.0/output/pydis_core.utils.error_handling.html | 4 +- v9.9.0/output/pydis_core.utils.html | 2 +- v9.9.0/output/pydis_core.utils.interactions.html | 8 +- v9.9.0/output/pydis_core.utils.members.html | 14 ++-- v9.9.1/.buildinfo | 2 +- v9.9.1/_static/pygments.css | 12 +-- v9.9.1/output/pydis_core.html | 4 +- v9.9.1/output/pydis_core.utils.channel.html | 14 ++-- v9.9.1/output/pydis_core.utils.commands.html | 4 +- v9.9.1/output/pydis_core.utils.cooldown.html | 2 +- v9.9.1/output/pydis_core.utils.error_handling.html | 4 +- v9.9.1/output/pydis_core.utils.html | 2 +- v9.9.1/output/pydis_core.utils.interactions.html | 8 +- v9.9.1/output/pydis_core.utils.members.html | 14 ++-- v9.9.2/.buildinfo | 2 +- v9.9.2/_static/pygments.css | 12 +-- v9.9.2/output/pydis_core.html | 4 +- v9.9.2/output/pydis_core.utils.channel.html | 14 ++-- v9.9.2/output/pydis_core.utils.commands.html | 4 +- v9.9.2/output/pydis_core.utils.cooldown.html | 2 +- v9.9.2/output/pydis_core.utils.error_handling.html | 4 +- v9.9.2/output/pydis_core.utils.html | 2 +- v9.9.2/output/pydis_core.utils.interactions.html | 8 +- v9.9.2/output/pydis_core.utils.members.html | 14 ++-- 332 files changed, 1342 insertions(+), 1337 deletions(-) diff --git a/_static/documentation_options.js b/_static/documentation_options.js index 8ad50753..98bea529 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '11.1.0', + VERSION: '11.2.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/index.html b/index.html index 6fd698b2..e0fd0a19 100644 --- a/index.html +++ b/index.html @@ -9,7 +9,7 @@ - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -54,7 +54,7 @@ Please click here if you were not redirected to the latest build. - + diff --git a/main/.buildinfo b/main/.buildinfo index 14372fbb..d436d28c 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: 4d689dd20168006344b632db5cc43b49 +config: fd7fed9cb50aa0235aaf6e14d1069991 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js index 8ad50753..98bea529 100644 --- a/main/_static/documentation_options.js +++ b/main/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '11.1.0', + VERSION: '11.2.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/main/_static/pygments.css b/main/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/main/_static/pygments.css +++ b/main/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/main/changelog.html b/main/changelog.html index eecae8f4..b69a7cd0 100644 --- a/main/changelog.html +++ b/main/changelog.html @@ -6,7 +6,7 @@ - Changelog - Pydis Core Latest (11.1.0) + Changelog - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0)
- + diff --git a/main/development.html b/main/development.html index d20758be..cd47d4c0 100644 --- a/main/development.html +++ b/main/development.html @@ -6,7 +6,7 @@ - Local Development & Testing - Pydis Core Latest (11.1.0) + Local Development & Testing - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -580,7 +580,7 @@ to help you test out certain features. Use them as needed.

- + diff --git a/main/genindex.html b/main/genindex.html index 8559b55d..69ffa846 100644 --- a/main/genindex.html +++ b/main/genindex.html @@ -4,7 +4,7 @@ - Index - Pydis Core Latest (11.1.0) + Index - Pydis Core Latest (11.2.0) @@ -181,7 +181,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -208,7 +208,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -1200,7 +1200,7 @@
- + diff --git a/main/index.html b/main/index.html index cfe05fe1..6be71e15 100644 --- a/main/index.html +++ b/main/index.html @@ -6,7 +6,7 @@ - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -583,7 +583,7 @@
- + diff --git a/main/index_redirect.html b/main/index_redirect.html index 6fd698b2..e0fd0a19 100644 --- a/main/index_redirect.html +++ b/main/index_redirect.html @@ -9,7 +9,7 @@ - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -54,7 +54,7 @@ Please click here if you were not redirected to the latest build. - + diff --git a/main/objects.inv b/main/objects.inv index 0d54d270..0e89e4ec 100644 Binary files a/main/objects.inv and b/main/objects.inv differ diff --git a/main/output/pydis_core.async_stats.html b/main/output/pydis_core.async_stats.html index f5d78885..4596ed62 100644 --- a/main/output/pydis_core.async_stats.html +++ b/main/output/pydis_core.async_stats.html @@ -6,7 +6,7 @@ - async_stats - Pydis Core Latest (11.1.0) + async_stats - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -457,12 +457,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:
@@ -479,7 +479,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:
@@ -564,7 +564,7 @@
- + diff --git a/main/output/pydis_core.exts.html b/main/output/pydis_core.exts.html index 55975c70..584e7bb2 100644 --- a/main/output/pydis_core.exts.html +++ b/main/output/pydis_core.exts.html @@ -6,7 +6,7 @@ - Exts - Pydis Core Latest (11.1.0) + Exts - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -506,7 +506,7 @@
- + diff --git a/main/output/pydis_core.html b/main/output/pydis_core.html index 40ef9a50..a5f369af 100644 --- a/main/output/pydis_core.html +++ b/main/output/pydis_core.html @@ -6,7 +6,7 @@ - Pydis Core - Pydis Core Latest (11.1.0) + Pydis Core - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -457,12 +457,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]¶
-

Bases: Bot

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

-guild_id[source]¶
+guild_id[source]¶

ID of the guild that the bot belongs to.

Type:
@@ -473,7 +473,7 @@
-http_session[source]¶
+http_session[source]¶

The http session used for sending out HTTP requests.

Type:
@@ -484,7 +484,7 @@
-api_client[source]¶
+api_client[source]¶

The API client used for communications with the site service.

Type:
@@ -495,7 +495,7 @@
-statsd_url[source]¶
+statsd_url[source]¶

The url that statsd sends metrics to.

Type:
@@ -506,7 +506,7 @@
-redis_session[source]¶
+redis_session[source]¶

The redis session used to communicate with the Redis instance.

Type:
@@ -517,7 +517,7 @@
-stats[source]¶
+stats[source]¶

The statsd client that sends metrics.

Type:
@@ -528,7 +528,7 @@
-all_extensions[source]¶
+all_extensions[source]¶

All extensions that were found within the module passed to self.load_extensions. Use self.extensions to get the loaded extensions.

@@ -540,7 +540,7 @@
-__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:
@@ -559,7 +559,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:
@@ -570,7 +570,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:
@@ -581,7 +581,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:
@@ -592,7 +592,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:
@@ -603,7 +603,7 @@ a dummy statsd client will be created.

-async load_extensions(module, *, sync_app_commands=True)[source]¶
+async load_extensions(module, *, sync_app_commands=True)[source]¶

Load all the extensions within the given module and save them to self.all_extensions.

Parameters:
@@ -617,7 +617,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:
@@ -628,7 +628,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.

@@ -641,7 +641,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:
@@ -652,7 +652,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:
@@ -663,7 +663,7 @@ will not be set and guild_available_but_cache_empty event will be e
-async process_commands(message)[source]¶
+async process_commands(message)[source]¶

Overwrite default Discord.py behaviour to process commands only after ensuring extensions are loaded.

This extension check is only relevant for clients that make use of pydis_core.BotBase.load_extensions.

@@ -675,7 +675,7 @@ will not be set and guild_available_but_cache_empty event will be e
-register_command_error_manager(manager)[source]¶
+register_command_error_manager(manager)[source]¶

Bind an instance of the command error manager to both the bot and the command tree.

The reason this doesn’t happen in the constructor is because error handlers might need an instance of the bot. So registration needs to happen once the bot instance has been created.

@@ -688,20 +688,20 @@ So registration needs to happen once the bot instance has been created.

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

Return type:
-

Command | None

+

Command | None

-async setup_hook()[source]¶
+async setup_hook()[source]¶

An async init to startup generic services.

Connects to statsd, and calls AsyncStatsClient.create_socket @@ -715,7 +715,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.

@@ -730,15 +730,15 @@ gateway event before giving up and thus not populating the cache for unavailable
-exception EmptyPaginatorEmbedError[source]¶
+exception EmptyPaginatorEmbedError[source]¶

Bases: Exception

Raised when attempting to paginate with empty contents.

-class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
-

Bases: Paginator

+class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶ +

Bases: Paginator

A class that aids in paginating code blocks for Discord messages.

Parameters:
@@ -754,14 +754,14 @@ gateway event before giving up and thus not populating the cache for unavailable
-__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
+__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶

This function overrides the Paginator.__init__ from inside discord.ext.commands.

It overrides in order to allow us to configure the maximum number of lines per page.

-add_line(line='', *, empty=False)[source]¶
+add_line(line='', *, empty=False)[source]¶

Adds a line to the current page.

If a line on a page exceeds max_size characters, then max_size will go up to scale_to_size for a single line before creating a new page for the overflow words. If it @@ -789,7 +789,7 @@ page at a reasonable size.

-async classmethod paginate(pagination_emojis, lines, ctx, embed, *, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]¶
+async classmethod paginate(pagination_emojis, lines, ctx, embed, *, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]¶

Use a paginator and set of reactions to provide pagination over a set of lines.

The reactions are used to switch page, or to finish with pagination.

When used, this will send a message using ctx.send() and apply a set of reactions to it. These reactions may @@ -802,15 +802,15 @@ to any user with a moderation role.

  • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

  • lines (list[str]) – A list of lines to be added to the paginated content.

    • -

  • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

    • -

  • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • +

  • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

    • +

  • embed (discord.Embed) – The embed that holds the content, it serves as the page.

  • prefix (str) – The prefix inserted to every page. e.g. three backticks.

  • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

  • max_lines (int) – The maximum amount of lines allowed in a page.

  • max_size (int) – The maximum amount of codepoints allowed in a page.

  • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

  • empty (bool) – Indicates whether an empty line should be added to each provided line.

    • -

  • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • +

  • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

  • timeout (int) – The timeout after which users cannot change pages anymore.

  • footer_text (str) – Text to be added as a footer for each page.

  • url (str) – The url to be set for the pagination embed.

    • @@ -820,7 +820,7 @@ to any user with a moderation role.

Return type:
-

Message | None

+

Message | None

Example: @@ -833,7 +833,7 @@ to any user with a moderation role.

-class PaginationEmojis(**data)[source]¶
+class PaginationEmojis(**data)[source]¶

Bases: BaseModel

The emojis that will be used for pagination.

@@ -860,12 +860,12 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
-exception StartupError(base)[source]¶
+exception StartupError(base)[source]¶

Bases: Exception

Exception class for startup errors.

-__init__(base)[source]¶
+__init__(base)[source]¶
@@ -1135,7 +1135,7 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
- + diff --git a/main/output/pydis_core.site_api.html b/main/output/pydis_core.site_api.html index 890eb7ad..8bc13ff7 100644 --- a/main/output/pydis_core.site_api.html +++ b/main/output/pydis_core.site_api.html @@ -6,7 +6,7 @@ - site_api - Pydis Core Latest (11.1.0) + site_api - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -457,12 +457,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:
@@ -477,7 +477,7 @@
-async close()[source]¶
+async close()[source]¶

Close the aiohttp session.

Return type:
@@ -488,7 +488,7 @@
-async delete(endpoint, *, raise_for_status=True, **kwargs)[source]¶
+async delete(endpoint, *, raise_for_status=True, **kwargs)[source]¶

Equivalent to APIClient.request() with DELETE passed as the method.

Return type:
@@ -499,7 +499,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:
@@ -510,7 +510,7 @@
-async static maybe_raise_for_status(response, *, should_raise)[source]¶
+async static maybe_raise_for_status(response, *, should_raise)[source]¶

Raise ResponseCodeError for non-OK response if an exception should be raised.

Parameters:
@@ -530,7 +530,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:
@@ -541,7 +541,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:
@@ -552,7 +552,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:
@@ -563,7 +563,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:
@@ -590,12 +590,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:
@@ -610,7 +610,7 @@
-__str__()[source]¶
+__str__()[source]¶

Return a string representation of the error.

@@ -702,7 +702,7 @@
- + diff --git a/main/output/pydis_core.utils.caching.html b/main/output/pydis_core.utils.caching.html index 725462b2..7631236f 100644 --- a/main/output/pydis_core.utils.caching.html +++ b/main/output/pydis_core.utils.caching.html @@ -6,7 +6,7 @@ - caching - Pydis Core Latest (11.1.0) + caching - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -457,14 +457,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:
@@ -481,7 +481,7 @@
-__init__(max_size=128)[source]¶
+__init__(max_size=128)[source]¶

Initialise a new AsyncCache instance.

Parameters:
@@ -492,7 +492,7 @@
-clear()[source]¶
+clear()[source]¶

Clear cache instance.

Return type:
@@ -578,7 +578,7 @@
- + diff --git a/main/output/pydis_core.utils.channel.html b/main/output/pydis_core.utils.channel.html index a3620722..a57655b6 100644 --- a/main/output/pydis_core.utils.channel.html +++ b/main/output/pydis_core.utils.channel.html @@ -6,7 +6,7 @@ - channel - Pydis Core Latest (11.1.0) + channel - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -457,25 +457,25 @@

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 | PrivateChannel | Thread

+

GuildChannel | PrivateChannel | Thread

Returns:

The channel from the ID.

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

@@ -574,7 +574,7 @@
- + diff --git a/main/output/pydis_core.utils.checks.html b/main/output/pydis_core.utils.checks.html index b02e59fc..57b589bf 100644 --- a/main/output/pydis_core.utils.checks.html +++ b/main/output/pydis_core.utils.checks.html @@ -6,7 +6,7 @@ - checks - Pydis Core Latest (11.1.0) + checks - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -456,26 +456,26 @@

checks¶

-exception ContextCheckFailure(redirect_channel)[source]¶
-

Bases: CheckFailure

+exception ContextCheckFailure(redirect_channel)[source]¶ +

Bases: CheckFailure

Raised when a context-specific check fails.

-__init__(redirect_channel)[source]¶
+__init__(redirect_channel)[source]¶
-exception InWhitelistCheckFailure(redirect_channel)[source]¶
+exception InWhitelistCheckFailure(redirect_channel)[source]¶

Bases: ContextCheckFailure

Raised when the in_whitelist check fails.

-cooldown_with_role_bypass(rate, per, type_=('default', 0), *, bypass_roles)[source]¶
+cooldown_with_role_bypass(rate, per, type_=('default', 0), *, bypass_roles)[source]¶

Decorate a command to have a cooldown, which can be bypassed by users with specified roles.

Note: This replaces the Command.before_invoke callback, which might introduce problems in the future.

@@ -483,7 +483,7 @@

  • rate (int) – Number of times a command can be used before triggering a cooldown.

  • per (float) – The duration (in seconds) for how long the cooldown lasts.

    • -

  • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

    • +

  • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

  • bypass_roles (Iterable[int]) – An iterable of role IDs that bypass the cooldown.

@@ -501,13 +501,13 @@
-async has_any_role_check(ctx, *roles)[source]¶
+async has_any_role_check(ctx, *roles)[source]¶

Verify if the context’s author has any of the specified roles.

This check will always fail if the context is a DM, since DMs don’t have roles.

Parameters:
@@ -522,13 +522,13 @@
-async has_no_roles_check(ctx, *roles)[source]¶
+async has_no_roles_check(ctx, *roles)[source]¶

Verify if the context’s author doesn’t have any of the specified roles.

This check will always fail if the context is a DM, since DMs don’t have roles.

Parameters:
@@ -543,12 +543,12 @@
-in_whitelist_check(ctx, redirect, channels=(), categories=(), roles=(), *, fail_silently=False)[source]¶
+in_whitelist_check(ctx, redirect, channels=(), categories=(), roles=(), *, fail_silently=False)[source]¶

Check if a command was issued in a context that is whitelisted by channel, category, or roles.

Parameters:
    -

  • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

    • +

  • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

  • redirect (int | None) – The channel ID to redirect the user to, if any.

  • channels (Container[int]) – Whitelisted channel IDs. Defaults to ().

  • categories (Container[int]) – Whitelisted category IDs. Defaults to ().

    • @@ -646,7 +646,7 @@
- + diff --git a/main/output/pydis_core.utils.commands.html b/main/output/pydis_core.utils.commands.html index ace04167..b2d48f4c 100644 --- a/main/output/pydis_core.utils.commands.html +++ b/main/output/pydis_core.utils.commands.html @@ -6,7 +6,7 @@ - commands - Pydis Core Latest (11.1.0) + commands - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -456,17 +456,17 @@

commands¶

-async clean_text_or_reply(ctx, text=None)[source]¶
+async clean_text_or_reply(ctx, text=None)[source]¶

Cleans a text argument or replied message’s content.

Parameters:
    -

  • ctx (Context) – The command’s context

    • +

  • ctx (Context) – The command’s context

  • text (str | None) – The provided text argument of the command (if given)

Raises:
-

discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

+

discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

Return type:

str

@@ -547,7 +547,7 @@
- + diff --git a/main/output/pydis_core.utils.cooldown.html b/main/output/pydis_core.utils.cooldown.html index 54d479ee..4eb3885a 100644 --- a/main/output/pydis_core.utils.cooldown.html +++ b/main/output/pydis_core.utils.cooldown.html @@ -6,7 +6,7 @@ - cooldown - Pydis Core Latest (11.1.0) + cooldown - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -457,17 +457,17 @@

Helpers for setting a cooldown on commands.

-exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
-

Bases: CommandError, Generic[P, R]

+exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶ +

Bases: CommandError, Generic[P, R]

Raised when a command is invoked while on cooldown.

-__init__(message, function, /, *args, **kwargs)[source]¶
+__init__(message, function, /, *args, **kwargs)[source]¶
-async call_without_cooldown()[source]¶
+async call_without_cooldown()[source]¶

Run the command this cooldown blocked.

Return type:
@@ -483,20 +483,20 @@
-P = ~P[source]¶
+P = ~P[source]¶

The command’s signature.

-class R[source]¶
+class R[source]¶

The command’s return value.

alias of TypeVar(‘R’)

-block_duplicate_invocations(*, cooldown_duration=5, send_notice=False, args_preprocessor=None)[source]¶
+block_duplicate_invocations(*, cooldown_duration=5, send_notice=False, args_preprocessor=None)[source]¶

Prevent duplicate invocations of a command with the same arguments in a channel for cooldown_duration seconds.

Parameters:
@@ -597,7 +597,7 @@ its return value is then used to check for the cooldown instead of the raw argum
- + diff --git a/main/output/pydis_core.utils.error_handling.commands.abc.html b/main/output/pydis_core.utils.error_handling.commands.abc.html index ec2b57c6..aa53d22c 100644 --- a/main/output/pydis_core.utils.error_handling.commands.abc.html +++ b/main/output/pydis_core.utils.error_handling.commands.abc.html @@ -6,7 +6,7 @@ - abc - Pydis Core Latest (11.1.0) + abc - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -456,12 +456,12 @@

abc¶

-class AbstractCommandErrorHandler[source]¶
+class AbstractCommandErrorHandler[source]¶

Bases: ABC

An abstract command error handler.

-abstract async handle_app_command_error(interaction, error)[source]¶
+abstract async handle_app_command_error(interaction, error)[source]¶

Handle error raised in the context of app commands.

Return type:
@@ -472,7 +472,7 @@
-abstract async handle_text_command_error(context, error)[source]¶
+abstract async handle_text_command_error(context, error)[source]¶

Handle error raised in the context of text commands.

Return type:
@@ -483,7 +483,7 @@
-abstract async should_handle_error(error)[source]¶
+abstract async should_handle_error(error)[source]¶

A predicate that determines whether the error should be handled.

Return type:
@@ -569,7 +569,7 @@
- + diff --git a/main/output/pydis_core.utils.error_handling.commands.html b/main/output/pydis_core.utils.error_handling.commands.html index 40e971b7..e702780c 100644 --- a/main/output/pydis_core.utils.error_handling.commands.html +++ b/main/output/pydis_core.utils.error_handling.commands.html @@ -6,7 +6,7 @@ - commands package - Pydis Core Latest (11.1.0) + commands package - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -456,12 +456,12 @@

commands package¶

-class AbstractCommandErrorHandler[source]¶
+class AbstractCommandErrorHandler[source]¶

Bases: ABC

An abstract command error handler.

-abstract async handle_app_command_error(interaction, error)[source]¶
+abstract async handle_app_command_error(interaction, error)[source]¶

Handle error raised in the context of app commands.

Return type:
@@ -472,7 +472,7 @@
-abstract async handle_text_command_error(context, error)[source]¶
+abstract async handle_text_command_error(context, error)[source]¶

Handle error raised in the context of text commands.

Return type:
@@ -483,7 +483,7 @@
-abstract async should_handle_error(error)[source]¶
+abstract async should_handle_error(error)[source]¶

A predicate that determines whether the error should be handled.

Return type:
@@ -496,17 +496,17 @@
-class CommandErrorManager(default)[source]¶
+class CommandErrorManager(default)[source]¶

Bases: object

A class that registers error handlers and handles all command related errors.

-__init__(default)[source]¶
+__init__(default)[source]¶
-async handle_error(error, context_or_interaction)[source]¶
+async handle_error(error, context_or_interaction)[source]¶

Handle a Discord exception.

Iterate through available handlers by registration order, and choose the first one capable of handling the error as determined by should_handle_error; there is no priority system.

@@ -519,7 +519,7 @@ the error as determined by should_handle_error; there is no priorit
-register_handler(handler)[source]¶
+register_handler(handler)[source]¶

Register a command error handler.

Return type:
@@ -637,7 +637,7 @@ the error as determined by should_handle_error; there is no priorit
- + diff --git a/main/output/pydis_core.utils.error_handling.commands.manager.html b/main/output/pydis_core.utils.error_handling.commands.manager.html index 9c313770..bfae2c9d 100644 --- a/main/output/pydis_core.utils.error_handling.commands.manager.html +++ b/main/output/pydis_core.utils.error_handling.commands.manager.html @@ -6,7 +6,7 @@ - manager - Pydis Core Latest (11.1.0) + manager - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -456,17 +456,17 @@

manager¶

-class CommandErrorManager(default)[source]¶
+class CommandErrorManager(default)[source]¶

Bases: object

A class that registers error handlers and handles all command related errors.

-__init__(default)[source]¶
+__init__(default)[source]¶
-async handle_error(error, context_or_interaction)[source]¶
+async handle_error(error, context_or_interaction)[source]¶

Handle a Discord exception.

Iterate through available handlers by registration order, and choose the first one capable of handling the error as determined by should_handle_error; there is no priority system.

@@ -479,7 +479,7 @@ the error as determined by should_handle_error; there is no priorit
-register_handler(handler)[source]¶
+register_handler(handler)[source]¶

Register a command error handler.

Return type:
@@ -565,7 +565,7 @@ the error as determined by should_handle_error; there is no priorit
- + diff --git a/main/output/pydis_core.utils.error_handling.html b/main/output/pydis_core.utils.error_handling.html index 4c24fd71..750bada2 100644 --- a/main/output/pydis_core.utils.error_handling.html +++ b/main/output/pydis_core.utils.error_handling.html @@ -6,7 +6,7 @@ - error_handling package - Pydis Core Latest (11.1.0) + error_handling package - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -456,13 +456,13 @@

error_handling package¶

-async handle_forbidden_from_block(error, message=None)[source]¶
+async handle_forbidden_from_block(error, message=None)[source]¶

Handles discord.Forbidden 90001 errors, or re-raises if error isn’t a 90001 error.

Parameters:
    -

  • error (Forbidden) – The raised discord.Forbidden to check.

    • -

  • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    • +

  • error (Forbidden) – The raised discord.Forbidden to check.

    • +

  • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

Return type:
@@ -575,7 +575,7 @@
- + diff --git a/main/output/pydis_core.utils.function.html b/main/output/pydis_core.utils.function.html index 44a390f5..491d03dc 100644 --- a/main/output/pydis_core.utils.function.html +++ b/main/output/pydis_core.utils.function.html @@ -6,7 +6,7 @@ - function - Pydis Core Latest (11.1.0) + function - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -457,14 +457,14 @@

Utils for manipulating functions.

-exception GlobalNameConflictError[source]¶
+exception GlobalNameConflictError[source]¶

Bases: Exception

Raised on a conflict between the globals used to resolve annotations of a wrapped function and its wrapper.

-command_wraps(wrapped, assigned=('__module__', '__name__', '__qualname__', '__doc__', '__annotations__'), updated=('__dict__',), *, ignored_conflict_names=frozenset({}))[source]¶
+command_wraps(wrapped, assigned=('__module__', '__name__', '__qualname__', '__doc__', '__annotations__'), updated=('__dict__',), *, ignored_conflict_names=frozenset({}))[source]¶

Update the decorated function to look like wrapped, and update globals for discord.py forwardref evaluation.

See update_wrapper_globals() for more details on how the globals are updated.

@@ -488,7 +488,7 @@ with the wrapper replaced with the function
-get_arg_value(name_or_pos, arguments)[source]¶
+get_arg_value(name_or_pos, arguments)[source]¶

Return a value from arguments based on a name or position.

Parameters:
@@ -511,7 +511,7 @@ with the wrapper replaced with the function
-get_arg_value_wrapper(decorator_func, name_or_pos, func=None)[source]¶
+get_arg_value_wrapper(decorator_func, name_or_pos, func=None)[source]¶

Call decorator_func with the value of the arg at the given name/position.

Parameters:
@@ -533,7 +533,7 @@ parameter names to argument values of the function it’s decorating.

-get_bound_args(func, args, kwargs)[source]¶
+get_bound_args(func, args, kwargs)[source]¶

Bind args and kwargs to func and return a mapping of parameter names to argument values.

Default parameter values are also set.

@@ -555,7 +555,7 @@ parameter names to argument values of the function it’s decorating.

-update_wrapper_globals(wrapper, wrapped, *, ignored_conflict_names=frozenset({}))[source]¶
+update_wrapper_globals(wrapper, wrapped, *, ignored_conflict_names=frozenset({}))[source]¶

Create a copy of wrapper, the copy’s globals are updated with wrapped's globals.

For forwardrefs in command annotations, discord.py uses the __global__ attribute of the function to resolve their values. This breaks for decorators that replace the function because they have @@ -658,7 +658,7 @@ changes won’t be reflected in the new function’s globals.

- + diff --git a/main/output/pydis_core.utils.html b/main/output/pydis_core.utils.html index f8b57199..578be712 100644 --- a/main/output/pydis_core.utils.html +++ b/main/output/pydis_core.utils.html @@ -6,7 +6,7 @@ - Utils - Pydis Core Latest (11.1.0) + Utils - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -457,7 +457,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.

Return type:
@@ -465,7 +465,7 @@
-
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 +

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

@@ -476,7 +476,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:
@@ -749,7 +749,7 @@ that will act as top-level groups rather than being aliases of the command’s g
- + diff --git a/main/output/pydis_core.utils.interactions.html b/main/output/pydis_core.utils.interactions.html index 5d48c79d..a041e3a8 100644 --- a/main/output/pydis_core.utils.interactions.html +++ b/main/output/pydis_core.utils.interactions.html @@ -6,7 +6,7 @@ - interactions - Pydis Core Latest (11.1.0) + interactions - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
-
Pydis Core Latest (11.1.0)
 +
Pydis Core Latest (11.2.0)
@@ -210,7 +210,7 @@
- Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -456,8 +456,8 @@

interactions¶

-class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
-

Bases: Button

+class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶ +

Bases: Button

A button that can be added to a view to delete the message containing the view on click.

This button itself carries out no interaction checks, these should be done by the parent view.

See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

@@ -471,12 +471,12 @@
-__init__(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
+__init__(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
-async callback(interaction)[source]¶
+async callback(interaction)[source]¶

Delete the original message on button click.

Return type:
@@ -489,8 +489,8 @@
-class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
-

Bases: View

+class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶ +

Bases: View

A view that allows the original invoker and moderators to interact with it.

Parameters:
@@ -499,23 +499,23 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • -__init__(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    +__init__(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -async interaction_check(interaction)[source]¶
    +async interaction_check(interaction)[source]¶

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    @@ -525,7 +525,7 @@ If None
    -async on_timeout()[source]¶
    +async on_timeout()[source]¶

    Remove the view from self.message if set.

    Return type:
    @@ -536,7 +536,7 @@ If None
    -stop()[source]¶
    +stop()[source]¶

    Stop listening for interactions, and remove the view from self.message if set.

    Return type:
    @@ -549,12 +549,12 @@ If None
    -user_has_access(user, *, allowed_users=(), allowed_roles=())[source]¶
    +user_has_access(user, *, allowed_users=(), allowed_roles=())[source]¶

    Return whether the user is in the allowed_users list, or has a role from allowed_roles.

    Parameters:
      -

    • user (User | Member) – The user to check

      • +

    • user (User | Member) – The user to check

    • allowed_users (Sequence[int]) – A sequence of user ids that are allowed access

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed access

    @@ -647,7 +647,7 @@ If None
    - + diff --git a/main/output/pydis_core.utils.lock.html b/main/output/pydis_core.utils.lock.html index f3b42dbb..c2767249 100644 --- a/main/output/pydis_core.utils.lock.html +++ b/main/output/pydis_core.utils.lock.html @@ -6,7 +6,7 @@ - lock - Pydis Core Latest (11.1.0) + lock - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
    -
    Pydis Core Latest (11.1.0)
     +
    Pydis Core Latest (11.2.0)
    @@ -210,7 +210,7 @@
    - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -456,12 +456,12 @@

    lock¶

    -exception LockedResourceError(resource_type, resource_id)[source]¶
    +exception LockedResourceError(resource_type, resource_id)[source]¶

    Bases: RuntimeError

    Exception raised when an operation is attempted on a locked resource.

    -type[source]¶
    +type[source]¶

    Name of the locked resource’s type

    Type:
    @@ -472,7 +472,7 @@
    -id[source]¶
    +id[source]¶

    ID of the locked resource

    Type:
    @@ -483,38 +483,38 @@
    -__init__(resource_type, resource_id)[source]¶
    +__init__(resource_type, resource_id)[source]¶
    -class SharedEvent[source]¶
    +class SharedEvent[source]¶

    Bases: object

    Context manager managing an internal event exposed through the wait coro.

    While any code is executing in this context manager, the underlying event will not be set; when all of the holders finish the event will be set.

    -__enter__()[source]¶
    +__enter__()[source]¶

    Increment the count of the active holders and clear the internal event.

    -__exit__(_exc_type, _exc_val, _exc_tb)[source]¶
    +__exit__(_exc_type, _exc_val, _exc_tb)[source]¶

    Decrement the count of the active holders; if 0 is reached set the internal event.

    -__init__()[source]¶
    +__init__()[source]¶
    -async wait()[source]¶
    +async wait()[source]¶

    Wait for all active holders to exit.

    Return type:
    @@ -527,7 +527,7 @@ when all of the holders finish the event will be set.

    -lock(namespace, resource_id, *, raise_error=False, wait=False)[source]¶
    +lock(namespace, resource_id, *, raise_error=False, wait=False)[source]¶

    Turn the decorated coroutine function into a mutually exclusive operation on a resource_id.

    If decorating a command, this decorator must go before (below) the command decorator.

    @@ -554,7 +554,7 @@ and return None.

    -lock_arg(namespace, name_or_pos, func=None, *, raise_error=False, wait=False)[source]¶
    +lock_arg(namespace, name_or_pos, func=None, *, raise_error=False, wait=False)[source]¶

    Apply the lock decorator using the value of the arg at the given name/position as the ID.

    See lock docs for more information.

    @@ -651,7 +651,7 @@ and return None.

    - + diff --git a/main/output/pydis_core.utils.logging.html b/main/output/pydis_core.utils.logging.html index a2327aa4..35a55f50 100644 --- a/main/output/pydis_core.utils.logging.html +++ b/main/output/pydis_core.utils.logging.html @@ -6,7 +6,7 @@ - logging - Pydis Core Latest (11.1.0) + logging - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
    -
    Pydis Core Latest (11.1.0)
     +
    Pydis Core Latest (11.2.0)
    @@ -210,7 +210,7 @@
    - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -457,12 +457,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)
@@ -486,7 +486,7 @@
 
 
    
 
    
-get_logger(name=None)[source]¶
    
+get_logger(name=None)[source]¶
 
    Utility to make mypy recognise that logger is of type CustomLogger.
    
 
    
 
    Parameters:
    
@@ -503,7 +503,7 @@
 
 
    
 
    
-log_format[source]¶
    
+log_format[source]¶
 
    A logging.Formatter that can be used to standardise logging across all projects using pydis_core.
    
 
    
 
    
@@ -584,7 +584,7 @@
    -
    +
    diff --git a/main/output/pydis_core.utils.members.html b/main/output/pydis_core.utils.members.html index e5c1cd6f..96c0496e 100644 --- a/main/output/pydis_core.utils.members.html +++ b/main/output/pydis_core.utils.members.html @@ -6,7 +6,7 @@ - members - Pydis Core Latest (11.1.0) + members - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
    -
    Pydis Core Latest (11.1.0)
     +
    Pydis Core Latest (11.2.0)
    @@ -210,7 +210,7 @@
    - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -454,33 +454,33 @@

    members¶

    -

    Useful helper functions for interactin with discord.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:
    -

    Member | None

    +

    Member | None

    Returns:
    -

    The discord.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 role as the sole argument.

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

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

    Parameters:
    Return type:
    @@ -560,7 +560,7 @@
    - + diff --git a/main/output/pydis_core.utils.messages.html b/main/output/pydis_core.utils.messages.html index c881db53..91527e11 100644 --- a/main/output/pydis_core.utils.messages.html +++ b/main/output/pydis_core.utils.messages.html @@ -6,7 +6,7 @@ - messages - Pydis Core Latest (11.1.0) + messages - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
    -
    Pydis Core Latest (11.1.0)
     +
    Pydis Core Latest (11.2.0)
    @@ -210,7 +210,7 @@
    - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -456,7 +456,7 @@

    messages¶

    -reaction_check(reaction, user, *, message_id, allowed_emoji, allowed_users, allowed_roles=None)[source]¶
    +reaction_check(reaction, user, *, message_id, allowed_emoji, allowed_users, allowed_roles=None)[source]¶

    Check if a reaction’s emoji and author are allowed and the message is message_id.

    If the user is not allowed, remove the reaction. Ignore reactions made by the bot. If allow_mods is True, allow users with moderator roles even if they’re not in allowed_users.

    @@ -537,7 +537,7 @@ If allow_mods is True, allow users with moderator roles even if the
    - + diff --git a/main/output/pydis_core.utils.pagination.html b/main/output/pydis_core.utils.pagination.html index ff1570b5..c430e336 100644 --- a/main/output/pydis_core.utils.pagination.html +++ b/main/output/pydis_core.utils.pagination.html @@ -6,7 +6,7 @@ - pagination - Pydis Core Latest (11.1.0) + pagination - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
    -
    Pydis Core Latest (11.1.0)
     +
    Pydis Core Latest (11.2.0)
    @@ -210,7 +210,7 @@
    - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -456,15 +456,15 @@

    pagination¶

    -exception EmptyPaginatorEmbedError[source]¶
    +exception EmptyPaginatorEmbedError[source]¶

    Bases: Exception

    Raised when attempting to paginate with empty contents.

    -class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    -

    Bases: Paginator

    +class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶ +

    Bases: Paginator

    A class that aids in paginating code blocks for Discord messages.

    Parameters:
    @@ -480,14 +480,14 @@
    -__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    +__init__(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶

    This function overrides the Paginator.__init__ from inside discord.ext.commands.

    It overrides in order to allow us to configure the maximum number of lines per page.

    -add_line(line='', *, empty=False)[source]¶
    +add_line(line='', *, empty=False)[source]¶

    Adds a line to the current page.

    If a line on a page exceeds max_size characters, then max_size will go up to scale_to_size for a single line before creating a new page for the overflow words. If it @@ -515,7 +515,7 @@ page at a reasonable size.

    -async classmethod paginate(pagination_emojis, lines, ctx, embed, *, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]¶
    +async classmethod paginate(pagination_emojis, lines, ctx, embed, *, prefix='', suffix='', max_lines=None, max_size=500, scale_to_size=4000, empty=True, restrict_to_user=None, timeout=300, footer_text=None, url=None, exception_on_empty_embed=False, reply=False, allowed_roles=None)[source]¶

    Use a paginator and set of reactions to provide pagination over a set of lines.

    The reactions are used to switch page, or to finish with pagination.

    When used, this will send a message using ctx.send() and apply a set of reactions to it. These reactions may @@ -528,15 +528,15 @@ to any user with a moderation role.

    • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

    • lines (list[str]) – A list of lines to be added to the paginated content.

      • -

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • -

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • +

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • prefix (str) – The prefix inserted to every page. e.g. three backticks.

    • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

    • max_lines (int) – The maximum amount of lines allowed in a page.

    • max_size (int) – The maximum amount of codepoints allowed in a page.

    • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

    • empty (bool) – Indicates whether an empty line should be added to each provided line.

      • -

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

      • +

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • timeout (int) – The timeout after which users cannot change pages anymore.

    • footer_text (str) – Text to be added as a footer for each page.

    • url (str) – The url to be set for the pagination embed.

      • @@ -546,7 +546,7 @@ to any user with a moderation role.

    Return type:
    -

    Message | None

    +

    Message | None

    Example: @@ -559,7 +559,7 @@ to any user with a moderation role.

    -class PaginationEmojis(**data)[source]¶
    +class PaginationEmojis(**data)[source]¶

    Bases: BaseModel

    The emojis that will be used for pagination.

    @@ -666,7 +666,7 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
    - + diff --git a/main/output/pydis_core.utils.paste_service.html b/main/output/pydis_core.utils.paste_service.html index 0c62cb54..098f6d36 100644 --- a/main/output/pydis_core.utils.paste_service.html +++ b/main/output/pydis_core.utils.paste_service.html @@ -6,7 +6,7 @@ - paste_service - Pydis Core Latest (11.1.0) + paste_service - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
    -
    Pydis Core Latest (11.1.0)
     +
    Pydis Core Latest (11.2.0)
    @@ -210,7 +210,7 @@
    - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -456,13 +456,13 @@

    paste_service¶

    -MAX_PASTE_SIZE = 524288[source]¶
    +MAX_PASTE_SIZE = 524288[source]¶

    The maximum allows size of a paste, in bytes.

    -class PasteFile(**data)[source]¶
    +class PasteFile(**data)[source]¶

    Bases: BaseModel

    A file to be pasted to the paste service.

    @@ -498,7 +498,7 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
    -class PasteResponse(**data)[source]¶
    +class PasteResponse(**data)[source]¶

    Bases: BaseModel

    A successful response from the paste service.

    @@ -533,28 +533,28 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
    -exception PasteTooLongError[source]¶
    +exception PasteTooLongError[source]¶

    Bases: Exception

    Raised when content is too large to upload to the paste service.

    -exception PasteUnsupportedLexerError[source]¶
    +exception PasteUnsupportedLexerError[source]¶

    Bases: Exception

    Raised when an unsupported lexer is used.

    -exception PasteUploadError[source]¶
    +exception PasteUploadError[source]¶

    Bases: Exception

    Raised when an error is encountered uploading to the paste service.

    -async send_to_paste_service(*, files, http_session, paste_url='https://paste.pythondiscord.com', max_size=524288)[source]¶
    +async send_to_paste_service(*, files, http_session, paste_url='https://paste.pythondiscord.com', max_size=524288)[source]¶

    Upload some contents to the paste service.

    Parameters:
    @@ -667,7 +667,7 @@ mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
    - + diff --git a/main/output/pydis_core.utils.regex.html b/main/output/pydis_core.utils.regex.html index 3352d4ca..3041e154 100644 --- a/main/output/pydis_core.utils.regex.html +++ b/main/output/pydis_core.utils.regex.html @@ -6,7 +6,7 @@ - regex - Pydis Core Latest (11.1.0) + regex - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
    -
    Pydis Core Latest (11.1.0)
     +
    Pydis Core Latest (11.2.0)
    @@ -210,7 +210,7 @@
    - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -457,7 +457,7 @@

    Common regular expressions.

    -DISCORD_INVITE[source]¶
    +DISCORD_INVITE[source]¶

    Regex for Discord server invites.

    Warning

    @@ -471,7 +471,7 @@ such as
    -FORMATTED_CODE_REGEX[source]¶
    +FORMATTED_CODE_REGEX[source]¶

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

    @@ -479,7 +479,7 @@ such as
    -RAW_CODE_REGEX[source]¶
    +RAW_CODE_REGEX[source]¶

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

    @@ -557,7 +557,7 @@ such as +
    diff --git a/main/output/pydis_core.utils.scheduling.html b/main/output/pydis_core.utils.scheduling.html index 52f2a2e8..72c6a689 100644 --- a/main/output/pydis_core.utils.scheduling.html +++ b/main/output/pydis_core.utils.scheduling.html @@ -6,7 +6,7 @@ - scheduling - Pydis Core Latest (11.1.0) + scheduling - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
    -
    Pydis Core Latest (11.1.0)
     +
    Pydis Core Latest (11.2.0)
    @@ -210,7 +210,7 @@
    - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -457,7 +457,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 @@ -471,7 +471,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:
    @@ -488,7 +488,7 @@ the same ID used to schedule it.

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

    Initialize a new Scheduler instance.

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

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

    Unschedule all known tasks.

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

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

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

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

    @@ -690,7 +690,7 @@ otherwise the running loop is used.

    - + diff --git a/main/py-modindex.html b/main/py-modindex.html index f7431eae..073bf2c3 100644 --- a/main/py-modindex.html +++ b/main/py-modindex.html @@ -4,7 +4,7 @@ - Python Module Index - Pydis Core Latest (11.1.0) + Python Module Index - Pydis Core Latest (11.2.0) @@ -181,7 +181,7 @@
    -
    Pydis Core Latest (11.1.0)
     +
    Pydis Core Latest (11.2.0)
    @@ -208,7 +208,7 @@
    - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -634,7 +634,7 @@
    - + diff --git a/main/search.html b/main/search.html index 20d98d59..a645103a 100644 --- a/main/search.html +++ b/main/search.html @@ -7,7 +7,7 @@ -Search - Pydis Core Latest (11.1.0) +Search - Pydis Core Latest (11.2.0) @@ -183,7 +183,7 @@
    -
    Pydis Core Latest (11.1.0)
     +
    Pydis Core Latest (11.2.0)
    @@ -210,7 +210,7 @@
    - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -489,7 +489,7 @@
    - + diff --git a/main/searchindex.js b/main/searchindex.js index 58395ced..4ee95360 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Changelog": [[0, "changelog"]], "Extras": [[2, "extras"]], "Exts": [[5, "module-pydis_core.exts"]], "Local Development & Testing": [[1, "local-development-testing"]], "Modules:": [[2, null]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Pydis Core": [[3, "module-pydis_core"]], "Reference": [[2, "reference"]], "Submodules": [[3, "submodules"], [7, "submodules"], [14, "submodules"]], "Subpackages": [[3, "subpackages"], [7, "subpackages"], [13, "subpackages"]], "Utils": [[7, "module-pydis_core.utils"]], "abc": [[15, "module-pydis_core.utils.error_handling.commands.abc"]], "async_stats": [[4, "module-pydis_core.async_stats"]], "caching": [[8, "module-pydis_core.utils.caching"]], "channel": [[9, "module-pydis_core.utils.channel"]], "checks": [[10, "module-pydis_core.utils.checks"]], "commands": [[11, "module-pydis_core.utils.commands"]], "commands package": [[14, "module-pydis_core.utils.error_handling.commands"]], "cooldown": [[12, "module-pydis_core.utils.cooldown"]], "error_handling package": [[13, "module-pydis_core.utils.error_handling"]], "function": [[17, "module-pydis_core.utils.function"]], "interactions": [[18, "module-pydis_core.utils.interactions"]], "lock": [[19, "module-pydis_core.utils.lock"]], "logging": [[20, "module-pydis_core.utils.logging"]], "manager": [[16, "module-pydis_core.utils.error_handling.commands.manager"]], "members": [[21, "module-pydis_core.utils.members"]], "messages": [[22, "module-pydis_core.utils.messages"]], "pagination": [[23, "module-pydis_core.utils.pagination"]], "paste_service": [[24, "module-pydis_core.utils.paste_service"]], "regex": [[25, "module-pydis_core.utils.regex"]], "scheduling": [[26, "module-pydis_core.utils.scheduling"]], "site_api": [[6, "module-pydis_core.site_api"]]}, "docnames": ["changelog", "development", "index", "output/pydis_core", "output/pydis_core.async_stats", "output/pydis_core.exts", "output/pydis_core.site_api", "output/pydis_core.utils", "output/pydis_core.utils.caching", "output/pydis_core.utils.channel", "output/pydis_core.utils.checks", "output/pydis_core.utils.commands", "output/pydis_core.utils.cooldown", "output/pydis_core.utils.error_handling", "output/pydis_core.utils.error_handling.commands", "output/pydis_core.utils.error_handling.commands.abc", "output/pydis_core.utils.error_handling.commands.manager", "output/pydis_core.utils.function", "output/pydis_core.utils.interactions", "output/pydis_core.utils.lock", "output/pydis_core.utils.logging", "output/pydis_core.utils.members", "output/pydis_core.utils.messages", "output/pydis_core.utils.pagination", "output/pydis_core.utils.paste_service", "output/pydis_core.utils.regex", "output/pydis_core.utils.scheduling"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2}, "filenames": ["changelog.rst", "development.rst", "index.rst", "output/pydis_core.rst", "output/pydis_core.async_stats.rst", "output/pydis_core.exts.rst", "output/pydis_core.site_api.rst", "output/pydis_core.utils.rst", "output/pydis_core.utils.caching.rst", "output/pydis_core.utils.channel.rst", "output/pydis_core.utils.checks.rst", "output/pydis_core.utils.commands.rst", "output/pydis_core.utils.cooldown.rst", "output/pydis_core.utils.error_handling.rst", "output/pydis_core.utils.error_handling.commands.rst", "output/pydis_core.utils.error_handling.commands.abc.rst", "output/pydis_core.utils.error_handling.commands.manager.rst", "output/pydis_core.utils.function.rst", "output/pydis_core.utils.interactions.rst", "output/pydis_core.utils.lock.rst", "output/pydis_core.utils.logging.rst", "output/pydis_core.utils.members.rst", "output/pydis_core.utils.messages.rst", "output/pydis_core.utils.pagination.rst", "output/pydis_core.utils.paste_service.rst", "output/pydis_core.utils.regex.rst", "output/pydis_core.utils.scheduling.rst"], "indexentries": {"__call__() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.__call__", false]], "__contains__() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.__contains__", false]], "__enter__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__enter__", false]], "__exit__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__exit__", false]], "__init__() (apiclient method)": [[6, "pydis_core.site_api.APIClient.__init__", false]], "__init__() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.__init__", false]], "__init__() (asyncstatsclient method)": [[4, "pydis_core.async_stats.AsyncStatsClient.__init__", false]], "__init__() (botbase method)": [[3, "pydis_core.BotBase.__init__", false]], "__init__() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.__init__", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.__init__", false]], "__init__() (commandoncooldown method)": [[12, "pydis_core.utils.cooldown.CommandOnCooldown.__init__", false]], "__init__() (contextcheckfailure method)": [[10, "pydis_core.utils.checks.ContextCheckFailure.__init__", false]], "__init__() (deletemessagebutton method)": [[18, "pydis_core.utils.interactions.DeleteMessageButton.__init__", false]], "__init__() (linepaginator method)": [[3, "pydis_core.LinePaginator.__init__", false], [23, "pydis_core.utils.pagination.LinePaginator.__init__", false]], "__init__() (lockedresourceerror method)": [[19, "pydis_core.utils.lock.LockedResourceError.__init__", false]], "__init__() (responsecodeerror method)": [[6, "pydis_core.site_api.ResponseCodeError.__init__", false]], "__init__() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.__init__", false]], "__init__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__init__", false]], "__init__() (startuperror method)": [[3, "pydis_core.StartupError.__init__", false]], "__init__() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.__init__", false]], "__str__() (responsecodeerror method)": [[6, "pydis_core.site_api.ResponseCodeError.__str__", false]], "abstractcommanderrorhandler (class in pydis_core.utils.error_handling.commands)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler", false]], "abstractcommanderrorhandler (class in pydis_core.utils.error_handling.commands.abc)": [[15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler", false]], "add_cog() (botbase method)": [[3, "pydis_core.BotBase.add_cog", false]], "add_command() (botbase method)": [[3, "pydis_core.BotBase.add_command", false]], "add_line() (linepaginator method)": [[3, "pydis_core.LinePaginator.add_line", false], [23, "pydis_core.utils.pagination.LinePaginator.add_line", false]], "all_extensions (botbase attribute)": [[3, "pydis_core.BotBase.all_extensions", false]], "api_client (botbase attribute)": [[3, "pydis_core.BotBase.api_client", false]], "apiclient (class in pydis_core.site_api)": [[6, "pydis_core.site_api.APIClient", false]], "apply_monkey_patches() (in module pydis_core.utils)": [[7, "pydis_core.utils.apply_monkey_patches", false]], "asynccache (class in pydis_core.utils.caching)": [[8, "pydis_core.utils.caching.AsyncCache", false]], "asyncstatsclient (class in pydis_core.async_stats)": [[4, "pydis_core.async_stats.AsyncStatsClient", false]], "block_duplicate_invocations() (in module pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.block_duplicate_invocations", false]], "botbase (class in pydis_core)": [[3, "pydis_core.BotBase", false]], "call_without_cooldown() (commandoncooldown method)": [[12, "pydis_core.utils.cooldown.CommandOnCooldown.call_without_cooldown", false]], "callback() (deletemessagebutton method)": [[18, "pydis_core.utils.interactions.DeleteMessageButton.callback", false]], "cancel() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.cancel", false]], "cancel_all() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.cancel_all", false]], "clean_text_or_reply() (in module pydis_core.utils.commands)": [[11, "pydis_core.utils.commands.clean_text_or_reply", false]], "clear() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.clear", false]], "clear() (botbase method)": [[3, "pydis_core.BotBase.clear", false]], "close() (apiclient method)": [[6, "pydis_core.site_api.APIClient.close", false]], "close() (botbase method)": [[3, "pydis_core.BotBase.close", false]], "command_wraps() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.command_wraps", false]], "commanderrormanager (class in pydis_core.utils.error_handling.commands)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager", false]], "commanderrormanager (class in pydis_core.utils.error_handling.commands.manager)": [[16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager", false]], "commandoncooldown": [[12, "pydis_core.utils.cooldown.CommandOnCooldown", false]], "contextcheckfailure": [[10, "pydis_core.utils.checks.ContextCheckFailure", false]], "cooldown_with_role_bypass() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.cooldown_with_role_bypass", false]], "create_socket() (asyncstatsclient method)": [[4, "pydis_core.async_stats.AsyncStatsClient.create_socket", false]], "create_task() (in module pydis_core.utils.scheduling)": [[26, "pydis_core.utils.scheduling.create_task", false]], "customlogger (class in pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.CustomLogger", false]], "delete() (apiclient method)": [[6, "pydis_core.site_api.APIClient.delete", false]], "deletemessagebutton (class in pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.DeleteMessageButton", false]], "discord_invite (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.DISCORD_INVITE", false]], "emptypaginatorembederror": [[3, "pydis_core.EmptyPaginatorEmbedError", false], [23, "pydis_core.utils.pagination.EmptyPaginatorEmbedError", false]], "formatted_code_regex (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.FORMATTED_CODE_REGEX", false]], "get() (apiclient method)": [[6, "pydis_core.site_api.APIClient.get", false]], "get_arg_value() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_arg_value", false]], "get_arg_value_wrapper() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_arg_value_wrapper", false]], "get_bound_args() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_bound_args", false]], "get_logger() (in module pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.get_logger", false]], "get_or_fetch_channel() (in module pydis_core.utils.channel)": [[9, "pydis_core.utils.channel.get_or_fetch_channel", false]], "get_or_fetch_member() (in module pydis_core.utils.members)": [[21, "pydis_core.utils.members.get_or_fetch_member", false]], "globalnameconflicterror": [[17, "pydis_core.utils.function.GlobalNameConflictError", false]], "guild_id (botbase attribute)": [[3, "pydis_core.BotBase.guild_id", false]], "handle_app_command_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_app_command_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_app_command_error", false]], "handle_error() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.handle_error", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.handle_error", false]], "handle_forbidden_from_block() (in module pydis_core.utils.error_handling)": [[13, "pydis_core.utils.error_handling.handle_forbidden_from_block", false]], "handle_role_change() (in module pydis_core.utils.members)": [[21, "pydis_core.utils.members.handle_role_change", false]], "handle_text_command_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_text_command_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_text_command_error", false]], "has_any_role_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.has_any_role_check", false]], "has_no_roles_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.has_no_roles_check", false]], "http_session (botbase attribute)": [[3, "pydis_core.BotBase.http_session", false]], "id (lockedresourceerror attribute)": [[19, "pydis_core.utils.lock.LockedResourceError.id", false]], "in_whitelist_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.in_whitelist_check", false]], "interaction_check() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.interaction_check", false]], "inwhitelistcheckfailure": [[10, "pydis_core.utils.checks.InWhitelistCheckFailure", false]], "is_in_category() (in module pydis_core.utils.channel)": [[9, "pydis_core.utils.channel.is_in_category", false]], "linepaginator (class in pydis_core)": [[3, "pydis_core.LinePaginator", false]], "linepaginator (class in pydis_core.utils.pagination)": [[23, "pydis_core.utils.pagination.LinePaginator", false]], "load_extensions() (botbase method)": [[3, "pydis_core.BotBase.load_extensions", false]], "lock() (in module pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.lock", false]], "lock_arg() (in module pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.lock_arg", false]], "lockedresourceerror": [[19, "pydis_core.utils.lock.LockedResourceError", false]], "log_format (in module pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.log_format", false]], "log_to_dev_log() (botbase method)": [[3, "pydis_core.BotBase.log_to_dev_log", false]], "max_paste_size (in module pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.MAX_PASTE_SIZE", false]], "maybe_raise_for_status() (apiclient static method)": [[6, "pydis_core.site_api.APIClient.maybe_raise_for_status", false]], "model_computed_fields (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.model_computed_fields", false], [23, "pydis_core.utils.pagination.PaginationEmojis.model_computed_fields", false]], "model_computed_fields (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.model_computed_fields", false]], "model_computed_fields (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.model_computed_fields", false]], "model_config (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.model_config", false], [23, "pydis_core.utils.pagination.PaginationEmojis.model_config", false]], "model_config (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.model_config", false]], "model_config (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.model_config", false]], "model_fields (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.model_fields", false], [23, "pydis_core.utils.pagination.PaginationEmojis.model_fields", false]], "model_fields (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.model_fields", false]], "model_fields (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.model_fields", false]], "module": [[3, "module-pydis_core", false], [4, "module-pydis_core.async_stats", false], [5, "module-pydis_core.exts", false], [6, "module-pydis_core.site_api", false], [7, "module-pydis_core.utils", false], [8, "module-pydis_core.utils.caching", false], [9, "module-pydis_core.utils.channel", false], [10, "module-pydis_core.utils.checks", false], [11, "module-pydis_core.utils.commands", false], [12, "module-pydis_core.utils.cooldown", false], [13, "module-pydis_core.utils.error_handling", false], [14, "module-pydis_core.utils.error_handling.commands", false], [15, "module-pydis_core.utils.error_handling.commands.abc", false], [16, "module-pydis_core.utils.error_handling.commands.manager", false], [17, "module-pydis_core.utils.function", false], [18, "module-pydis_core.utils.interactions", false], [19, "module-pydis_core.utils.lock", false], [20, "module-pydis_core.utils.logging", false], [21, "module-pydis_core.utils.members", false], [22, "module-pydis_core.utils.messages", false], [23, "module-pydis_core.utils.pagination", false], [24, "module-pydis_core.utils.paste_service", false], [25, "module-pydis_core.utils.regex", false], [26, "module-pydis_core.utils.scheduling", false]], "on_guild_available() (botbase method)": [[3, "pydis_core.BotBase.on_guild_available", false]], "on_guild_unavailable() (botbase method)": [[3, "pydis_core.BotBase.on_guild_unavailable", false]], "on_timeout() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.on_timeout", false]], "p (in module pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.P", false]], "paginate() (linepaginator class method)": [[3, "pydis_core.LinePaginator.paginate", false], [23, "pydis_core.utils.pagination.LinePaginator.paginate", false]], "paginationemojis (class in pydis_core)": [[3, "pydis_core.PaginationEmojis", false]], "paginationemojis (class in pydis_core.utils.pagination)": [[23, "pydis_core.utils.pagination.PaginationEmojis", false]], "pastefile (class in pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.PasteFile", false]], "pasteresponse (class in pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.PasteResponse", false]], "pastetoolongerror": [[24, "pydis_core.utils.paste_service.PasteTooLongError", false]], "pasteunsupportedlexererror": [[24, "pydis_core.utils.paste_service.PasteUnsupportedLexerError", false]], "pasteuploaderror": [[24, "pydis_core.utils.paste_service.PasteUploadError", false]], "patch() (apiclient method)": [[6, "pydis_core.site_api.APIClient.patch", false]], "ping_services() (botbase method)": [[3, "pydis_core.BotBase.ping_services", false]], "post() (apiclient method)": [[6, "pydis_core.site_api.APIClient.post", false]], "process_commands() (botbase method)": [[3, "pydis_core.BotBase.process_commands", false]], "put() (apiclient method)": [[6, "pydis_core.site_api.APIClient.put", false]], "pydis_core": [[3, "module-pydis_core", false]], "pydis_core.async_stats": [[4, "module-pydis_core.async_stats", false]], "pydis_core.exts": [[5, "module-pydis_core.exts", false]], "pydis_core.site_api": [[6, "module-pydis_core.site_api", false]], "pydis_core.utils": [[7, "module-pydis_core.utils", false]], "pydis_core.utils.caching": [[8, "module-pydis_core.utils.caching", false]], "pydis_core.utils.channel": [[9, "module-pydis_core.utils.channel", false]], "pydis_core.utils.checks": [[10, "module-pydis_core.utils.checks", false]], "pydis_core.utils.commands": [[11, "module-pydis_core.utils.commands", false]], "pydis_core.utils.cooldown": [[12, "module-pydis_core.utils.cooldown", false]], "pydis_core.utils.error_handling": [[13, "module-pydis_core.utils.error_handling", false]], "pydis_core.utils.error_handling.commands": [[14, "module-pydis_core.utils.error_handling.commands", false]], "pydis_core.utils.error_handling.commands.abc": [[15, "module-pydis_core.utils.error_handling.commands.abc", false]], "pydis_core.utils.error_handling.commands.manager": [[16, "module-pydis_core.utils.error_handling.commands.manager", false]], "pydis_core.utils.function": [[17, "module-pydis_core.utils.function", false]], "pydis_core.utils.interactions": [[18, "module-pydis_core.utils.interactions", false]], "pydis_core.utils.lock": [[19, "module-pydis_core.utils.lock", false]], "pydis_core.utils.logging": [[20, "module-pydis_core.utils.logging", false]], "pydis_core.utils.members": [[21, "module-pydis_core.utils.members", false]], "pydis_core.utils.messages": [[22, "module-pydis_core.utils.messages", false]], "pydis_core.utils.pagination": [[23, "module-pydis_core.utils.pagination", false]], "pydis_core.utils.paste_service": [[24, "module-pydis_core.utils.paste_service", false]], "pydis_core.utils.regex": [[25, "module-pydis_core.utils.regex", false]], "pydis_core.utils.scheduling": [[26, "module-pydis_core.utils.scheduling", false]], "r (class in pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.R", false]], "raw_code_regex (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.RAW_CODE_REGEX", false]], "reaction_check() (in module pydis_core.utils.messages)": [[22, "pydis_core.utils.messages.reaction_check", false]], "redis_session (botbase attribute)": [[3, "pydis_core.BotBase.redis_session", false]], "register_command_error_manager() (botbase method)": [[3, "pydis_core.BotBase.register_command_error_manager", false]], "register_handler() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.register_handler", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.register_handler", false]], "remove_command() (botbase method)": [[3, "pydis_core.BotBase.remove_command", false]], "request() (apiclient method)": [[6, "pydis_core.site_api.APIClient.request", false]], "responsecodeerror": [[6, "pydis_core.site_api.ResponseCodeError", false]], "schedule() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule", false]], "schedule_at() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule_at", false]], "schedule_later() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule_later", false]], "scheduler (class in pydis_core.utils.scheduling)": [[26, "pydis_core.utils.scheduling.Scheduler", false]], "send_to_paste_service() (in module pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.send_to_paste_service", false]], "setup_hook() (botbase method)": [[3, "pydis_core.BotBase.setup_hook", false]], "sharedevent (class in pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.SharedEvent", false]], "should_handle_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.should_handle_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.should_handle_error", false]], "startuperror": [[3, "pydis_core.StartupError", false]], "stats (botbase attribute)": [[3, "pydis_core.BotBase.stats", false]], "statsd_url (botbase attribute)": [[3, "pydis_core.BotBase.statsd_url", false]], "stop() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.stop", false]], "trace() (customlogger method)": [[20, "pydis_core.utils.logging.CustomLogger.trace", false]], "type (lockedresourceerror attribute)": [[19, "pydis_core.utils.lock.LockedResourceError.type", false]], "unqualify() (in module pydis_core.utils)": [[7, "pydis_core.utils.unqualify", false]], "update_wrapper_globals() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.update_wrapper_globals", false]], "user_has_access() (in module pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.user_has_access", false]], "viewwithuserandrolecheck (class in pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck", false]], "wait() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.wait", false]], "wait_until_guild_available() (botbase method)": [[3, "pydis_core.BotBase.wait_until_guild_available", false]]}, "objects": {"": [[3, 0, 0, "-", "pydis_core"]], "pydis_core": [[3, 1, 1, "", "BotBase"], [3, 4, 1, "", "EmptyPaginatorEmbedError"], [3, 1, 1, "", "LinePaginator"], [3, 1, 1, "", "PaginationEmojis"], [3, 4, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "pydis_core.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 3, 1, "", "all_extensions"], [3, 3, 1, "", "api_client"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [3, 3, 1, "", "guild_id"], [3, 3, 1, "", "http_session"], [3, 2, 1, "", "load_extensions"], [3, 2, 1, "", "log_to_dev_log"], [3, 2, 1, "", "on_guild_available"], [3, 2, 1, "", "on_guild_unavailable"], [3, 2, 1, "", "ping_services"], [3, 2, 1, "", "process_commands"], [3, 3, 1, "", "redis_session"], [3, 2, 1, "", "register_command_error_manager"], [3, 2, 1, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 3, 1, "", "stats"], [3, 3, 1, "", "statsd_url"], [3, 2, 1, "", "wait_until_guild_available"]], "pydis_core.LinePaginator": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_line"], [3, 2, 1, "", "paginate"]], "pydis_core.PaginationEmojis": [[3, 3, 1, "", "model_computed_fields"], [3, 3, 1, "", "model_config"], [3, 3, 1, "", "model_fields"]], "pydis_core.StartupError": [[3, 2, 1, "", "__init__"]], "pydis_core.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "pydis_core.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "pydis_core.site_api": [[6, 1, 1, "", "APIClient"], [6, 4, 1, "", "ResponseCodeError"]], "pydis_core.site_api.APIClient": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "close"], [6, 2, 1, "", "delete"], [6, 2, 1, "", "get"], [6, 2, 1, "", "maybe_raise_for_status"], [6, 2, 1, "", "patch"], [6, 2, 1, "", "post"], [6, 2, 1, "", "put"], [6, 2, 1, "", "request"]], "pydis_core.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "pydis_core.utils": [[7, 5, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "checks"], [11, 0, 0, "-", "commands"], [12, 0, 0, "-", "cooldown"], [13, 0, 0, "-", "error_handling"], [17, 0, 0, "-", "function"], [18, 0, 0, "-", "interactions"], [19, 0, 0, "-", "lock"], [20, 0, 0, "-", "logging"], [21, 0, 0, "-", "members"], [22, 0, 0, "-", "messages"], [23, 0, 0, "-", "pagination"], [24, 0, 0, "-", "paste_service"], [25, 0, 0, "-", "regex"], [26, 0, 0, "-", "scheduling"], [7, 5, 1, "", "unqualify"]], "pydis_core.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "pydis_core.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "pydis_core.utils.channel": [[9, 5, 1, "", "get_or_fetch_channel"], [9, 5, 1, "", "is_in_category"]], "pydis_core.utils.checks": [[10, 4, 1, "", "ContextCheckFailure"], [10, 4, 1, "", "InWhitelistCheckFailure"], [10, 5, 1, "", "cooldown_with_role_bypass"], [10, 5, 1, "", "has_any_role_check"], [10, 5, 1, "", "has_no_roles_check"], [10, 5, 1, "", "in_whitelist_check"]], "pydis_core.utils.checks.ContextCheckFailure": [[10, 2, 1, "", "__init__"]], "pydis_core.utils.commands": [[11, 5, 1, "", "clean_text_or_reply"]], "pydis_core.utils.cooldown": [[12, 4, 1, "", "CommandOnCooldown"], [12, 6, 1, "", "P"], [12, 1, 1, "", "R"], [12, 5, 1, "", "block_duplicate_invocations"]], "pydis_core.utils.cooldown.CommandOnCooldown": [[12, 2, 1, "", "__init__"], [12, 2, 1, "", "call_without_cooldown"]], "pydis_core.utils.error_handling": [[14, 0, 0, "-", "commands"], [13, 5, 1, "", "handle_forbidden_from_block"]], "pydis_core.utils.error_handling.commands": [[14, 1, 1, "", "AbstractCommandErrorHandler"], [14, 1, 1, "", "CommandErrorManager"], [15, 0, 0, "-", "abc"], [16, 0, 0, "-", "manager"]], "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler": [[14, 2, 1, "", "handle_app_command_error"], [14, 2, 1, "", "handle_text_command_error"], [14, 2, 1, "", "should_handle_error"]], "pydis_core.utils.error_handling.commands.CommandErrorManager": [[14, 2, 1, "", "__init__"], [14, 2, 1, "", "handle_error"], [14, 2, 1, "", "register_handler"]], "pydis_core.utils.error_handling.commands.abc": [[15, 1, 1, "", "AbstractCommandErrorHandler"]], "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler": [[15, 2, 1, "", "handle_app_command_error"], [15, 2, 1, "", "handle_text_command_error"], [15, 2, 1, "", "should_handle_error"]], "pydis_core.utils.error_handling.commands.manager": [[16, 1, 1, "", "CommandErrorManager"]], "pydis_core.utils.error_handling.commands.manager.CommandErrorManager": [[16, 2, 1, "", "__init__"], [16, 2, 1, "", "handle_error"], [16, 2, 1, "", "register_handler"]], "pydis_core.utils.function": [[17, 4, 1, "", "GlobalNameConflictError"], [17, 5, 1, "", "command_wraps"], [17, 5, 1, "", "get_arg_value"], [17, 5, 1, "", "get_arg_value_wrapper"], [17, 5, 1, "", "get_bound_args"], [17, 5, 1, "", "update_wrapper_globals"]], "pydis_core.utils.interactions": [[18, 1, 1, "", "DeleteMessageButton"], [18, 1, 1, "", "ViewWithUserAndRoleCheck"], [18, 5, 1, "", "user_has_access"]], "pydis_core.utils.interactions.DeleteMessageButton": [[18, 2, 1, "", "__init__"], [18, 2, 1, "", "callback"]], "pydis_core.utils.interactions.ViewWithUserAndRoleCheck": [[18, 2, 1, "", "__init__"], [18, 2, 1, "", "interaction_check"], [18, 2, 1, "", "on_timeout"], [18, 2, 1, "", "stop"]], "pydis_core.utils.lock": [[19, 4, 1, "", "LockedResourceError"], [19, 1, 1, "", "SharedEvent"], [19, 5, 1, "", "lock"], [19, 5, 1, "", "lock_arg"]], "pydis_core.utils.lock.LockedResourceError": [[19, 2, 1, "", "__init__"], [19, 3, 1, "", "id"], [19, 3, 1, "", "type"]], "pydis_core.utils.lock.SharedEvent": [[19, 2, 1, "", "__enter__"], [19, 2, 1, "", "__exit__"], [19, 2, 1, "", "__init__"], [19, 2, 1, "", "wait"]], "pydis_core.utils.logging": [[20, 1, 1, "", "CustomLogger"], [20, 5, 1, "", "get_logger"], [20, 6, 1, "", "log_format"]], "pydis_core.utils.logging.CustomLogger": [[20, 2, 1, "", "trace"]], "pydis_core.utils.members": [[21, 5, 1, "", "get_or_fetch_member"], [21, 5, 1, "", "handle_role_change"]], "pydis_core.utils.messages": [[22, 5, 1, "", "reaction_check"]], "pydis_core.utils.pagination": [[23, 4, 1, "", "EmptyPaginatorEmbedError"], [23, 1, 1, "", "LinePaginator"], [23, 1, 1, "", "PaginationEmojis"]], "pydis_core.utils.pagination.LinePaginator": [[23, 2, 1, "", "__init__"], [23, 2, 1, "", "add_line"], [23, 2, 1, "", "paginate"]], "pydis_core.utils.pagination.PaginationEmojis": [[23, 3, 1, "", "model_computed_fields"], [23, 3, 1, "", "model_config"], [23, 3, 1, "", "model_fields"]], "pydis_core.utils.paste_service": [[24, 6, 1, "", "MAX_PASTE_SIZE"], [24, 1, 1, "", "PasteFile"], [24, 1, 1, "", "PasteResponse"], [24, 4, 1, "", "PasteTooLongError"], [24, 4, 1, "", "PasteUnsupportedLexerError"], [24, 4, 1, "", "PasteUploadError"], [24, 5, 1, "", "send_to_paste_service"]], "pydis_core.utils.paste_service.PasteFile": [[24, 3, 1, "", "model_computed_fields"], [24, 3, 1, "", "model_config"], [24, 3, 1, "", "model_fields"]], "pydis_core.utils.paste_service.PasteResponse": [[24, 3, 1, "", "model_computed_fields"], [24, 3, 1, "", "model_config"], [24, 3, 1, "", "model_fields"]], "pydis_core.utils.regex": [[25, 6, 1, "", "DISCORD_INVITE"], [25, 6, 1, "", "FORMATTED_CODE_REGEX"], [25, 6, 1, "", "RAW_CODE_REGEX"]], "pydis_core.utils.scheduling": [[26, 1, 1, "", "Scheduler"], [26, 5, 1, "", "create_task"]], "pydis_core.utils.scheduling.Scheduler": [[26, 2, 1, "", "__contains__"], [26, 2, 1, "", "__init__"], [26, 2, 1, "", "cancel"], [26, 2, 1, "", "cancel_all"], [26, 2, 1, "", "schedule"], [26, 2, 1, "", "schedule_at"], [26, 2, 1, "", "schedule_later"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "exception", "Python exception"], "5": ["py", "function", "Python function"], "6": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:exception", "5": "py:function", "6": "py:data"}, "terms": {"": [0, 1, 3, 7, 8, 10, 11, 12, 17, 18, 19, 20, 22, 23, 25, 26], "0": [0, 8, 10, 18, 19, 20], "0a0": 0, "0eb3d26": 0, "1": [0, 20], "10": 0, "101": 0, "103": 0, "104": 0, "106": 0, "107": 0, "108": 0, "10th": 0, "11": 0, "110": 0, "12": 0, "124": 0, "125": 0, "128": 8, "138": 0, "13th": 0, "14th": 0, "15": 0, "151": 0, "157": 0, "158": 0, "162": 0, "169": 0, "16th": 0, "170": 0, "171": 0, "172": 0, "173": 0, "174": 0, "175": 0, "176": 0, "177": 0, "179": 0, "17th": 0, "180": 18, "181": 0, "182": 0, "183": 0, "184": 0, "185": 0, "187": 0, "188": 0, "189": 0, "18th": 0, "190": 0, "192": 0, "194": 0, "195": 0, "196": 0, "197": 0, "199": 0, "19th": 0, "2": [0, 3, 18], "200": 0, "202": 0, "2021": 0, "2022": 0, "2023": 0, "2024": 0, "204": [0, 6], "205": 0, "206": 0, "207": 0, "208": 0, "209": 0, "20th": 0, "210": 0, "21st": 0, "22nd": 0, "23rd": 0, "24th": 0, "25th": 0, "26th": 0, "27th": 0, "28th": 0, "29": 0, "2nd": 0, "3": 0, "30": 0, "300": [3, 23], "30th": 0, "32": 0, "34": 0, "35": 0, "37": 0, "39": 0, "3rd": 0, "4": 0, "4000": [3, 23], "403": 7, "42": 0, "4cbe8f5": 0, "5": [0, 12], "500": [3, 23], "524288": 24, "54": 0, "56": 0, "5a06fa5": 0, "5th": 0, "6": 0, "61": 0, "63": 0, "637136429717389331": [3, 23], "64": 0, "65": 0, "66": 0, "68": 0, "69": 0, "6th": 0, "7": 0, "72": 0, "75": 0, "78": 0, "79": 0, "8": 0, "8125": 4, "88": 0, "9": 0, "90001": [0, 13], "91": 0, "93": 0, "96": 0, "98": 0, "987235d": 0, "9th": 0, "A": [1, 3, 6, 7, 8, 9, 10, 12, 14, 15, 16, 17, 18, 20, 23, 24, 26], "As": 0, "Be": 0, "For": 17, "If": [3, 6, 10, 12, 17, 18, 19, 22, 23, 26], "In": [3, 23], "It": [3, 7, 19, 23], "Not": 3, "On": 0, "That": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 17, 18, 20, 21, 23, 24, 26], "These": [3, 23], "To": [1, 3, 20], "_": 0, "__annotations__": 17, "__call__": [7, 8], "__contains__": [7, 26], "__dict__": 17, "__doc__": 17, "__enter__": [7, 19], "__exit__": [7, 19], "__fields__": [3, 23, 24], "__global__": 17, "__init__": [0, 2, 3, 4, 6, 7, 8, 10, 12, 13, 14, 16, 18, 19, 23, 26], "__module__": 17, "__name__": 17, "__qualname__": 17, "__str__": [3, 6], "_exc_tb": 19, "_exc_typ": 19, "_exc_val": 19, "_guild_avail": 0, "_p": 17, "_r": 17, "_transport": 0, "abc": [0, 13, 14], "abl": 0, "about": [3, 12, 23, 24], "abstract": [0, 14, 15], "abstractcommanderrorhandl": [0, 7, 13, 14, 15], "abstracteventloop": [4, 26], "accept": [17, 18], "access": 18, "acquir": 19, "across": [0, 3, 20, 23], "act": 7, "action": 0, "activ": 19, "actual": 0, "ad": [0, 1, 3, 7, 18, 20, 23], "add": [0, 3, 10, 12, 23], "add_cog": [2, 3], "add_command": [2, 3], "add_lin": [2, 3, 7, 23], "add_rol": 21, "addit": 0, "after": [0, 3, 18, 23, 26], "again": 1, "aid": [3, 23], "aiodn": 0, "aiohttp": [0, 3, 6, 24], "alia": [3, 7, 12], "alias": [3, 7], "all": [0, 1, 3, 4, 7, 14, 16, 19, 20, 26], "all_command": 3, "all_extens": [2, 3], "allow": [0, 1, 3, 18, 22, 23, 24], "allow_mod": 22, "allowed_emoji": 22, "allowed_rol": [0, 1, 3, 18, 22, 23], "allowed_us": [0, 18, 22], "alpha": 0, "alreadi": [3, 23, 26], "also": [0, 3, 7, 17, 18, 19, 23], "alwai": 10, "among": 19, "amount": [3, 23], "an": [0, 1, 3, 4, 6, 7, 8, 9, 10, 14, 15, 17, 19, 20, 23, 24, 26], "ani": [3, 6, 10, 17, 19, 23, 25, 26], "annot": [3, 17, 23, 24], "anymor": [3, 23], "anyth": [1, 24], "api": [0, 3, 6, 21], "api_cli": [0, 2, 3], "apicli": [0, 2, 3, 6], "app": [0, 3, 14, 15], "appear": 3, "append": [3, 23], "appli": [3, 7, 8, 10, 12, 19, 23, 24], "applic": 1, "apply_monkey_patch": [0, 2, 3, 7], "approach": 1, "april": 0, "ar": [0, 1, 3, 8, 17, 18, 22, 23, 25], "arg": [3, 12, 17, 19, 20], "arg_offset": 8, "args_preprocessor": 12, "argument": [6, 7, 8, 11, 12, 17, 19, 20, 21], "around": 6, "assign": 17, "async": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 21, 23, 24], "async_rediscach": [0, 3], "async_stat": [2, 3], "asynccach": [3, 7, 8], "asyncio": [0, 4, 26], "asyncresolv": 0, "asyncstatscli": [2, 3, 4], "asyncstatsdcli": 0, "attach": 0, "attempt": [0, 3, 9, 19, 21, 23], "attr": 0, "attribut": [0, 7, 17], "august": 0, "authent": 6, "author": [3, 10, 22, 23], "auto": 0, "auto_mod": 0, "autogener": 0, "automat": [0, 3, 23], "avail": [0, 3, 14, 16, 19], "avoid": [0, 3, 23], "await": [0, 3, 12, 18, 19, 21, 23], "awar": [0, 26], "back": 0, "backtick": [3, 23], "bad": 0, "badargu": 11, "base": [0, 3, 4, 6, 8, 10, 12, 14, 15, 16, 17, 18, 19, 20, 23, 24, 26], "basemodel": [3, 23, 24], "basic": [0, 18], "becaus": [3, 17], "becom": [3, 19], "been": [0, 3], "befor": [0, 3, 10, 18, 19, 23, 26], "before_invok": 10, "behav": 17, "behavior": 10, "behaviour": [0, 3], "being": [0, 7, 10, 21], "belong": 3, "below": [1, 19], "best": [3, 23], "between": [0, 1, 17], "bind": [3, 17], "block": [0, 3, 12, 23, 25], "block_duplicate_invoc": [3, 7, 12], "bodi": 0, "boilerpl": 0, "bool": [3, 6, 9, 10, 12, 14, 15, 18, 19, 22, 23, 26], "bot": [0, 1, 3, 7, 9, 22], "bot_token": 1, "botbas": [0, 2, 3], "both": [0, 1, 3, 24], "boundari": [3, 23], "break": [0, 3, 17, 23], "broke": 0, "buckettyp": 10, "bug": 0, "bump": 0, "button": [0, 18], "buttonstyl": 18, "bypass": 10, "bypass_rol": 10, "byte": 24, "cach": [0, 3, 7, 9, 21], "calcul": 26, "call": [0, 3, 12, 17, 26], "call_without_cooldown": [7, 12], "callabl": [8, 10, 12, 17, 19, 21], "callback": [7, 10, 18], "can": [0, 1, 3, 10, 18, 19, 20, 23, 26], "cancel": [7, 26], "cancel_al": [7, 26], "cannot": [0, 3, 19, 23], "capabl": [14, 16], "captur": [0, 17, 25], "carri": 18, "case": [0, 3, 23], "categori": [9, 10], "category_id": 9, "caus": [3, 7, 23], "certain": [0, 1], "chang": [0, 1, 3, 17, 23], "changelog": 2, "changeset": 0, "channel": [0, 3, 7, 10, 12], "channel_id": 9, "charact": [0, 3, 23], "chardet": 0, "check": [0, 3, 6, 7, 9, 12, 13, 18, 22, 26], "checkfailur": 10, "choos": [14, 16], "chunk": 0, "ci": 0, "class": [0, 3, 4, 6, 8, 12, 14, 15, 16, 18, 19, 20, 23, 24, 26], "classmethod": [3, 23], "classvar": [3, 23, 24], "clean": [0, 11], "clean_text_or_repli": [3, 7, 11], "clear": [2, 3, 7, 8, 19], "click": 18, "client": [0, 3, 4], "clientrespons": 6, "clientsess": [3, 6, 24], "close": [0, 2, 3, 6, 26], "cloudflar": 7, "code": [0, 1, 3, 6, 19, 23, 25], "codepoint": [3, 23], "cog": [0, 3, 5], "collect": 10, "collis": 19, "com": [0, 24], "comma": 1, "command": [0, 1, 3, 7, 9, 10, 12, 13, 15, 16, 17, 19, 23], "command_wrap": [3, 7, 17], "commanderror": 12, "commanderrormanag": [0, 7, 13, 14, 16], "commandinvokeerror": 0, "commandoncooldown": [3, 7, 12], "commit": 0, "common": [0, 1, 3, 7, 20, 25], "commun": [3, 4], "compos": 1, "comput": [3, 23, 24], "computedfieldinfo": [3, 23, 24], "concurr": 0, "config": [0, 3, 23, 24], "configdict": [3, 23, 24], "configur": [1, 3, 23, 24], "conflict": 17, "conform": [3, 23, 24], "connect": [0, 3, 4], "connector": 3, "constructor": [3, 6], "contain": [1, 3, 10, 18, 23, 24, 26], "content": [0, 3, 11, 23, 24], "context": [3, 10, 11, 14, 15, 19, 23], "context_or_interact": [14, 16], "contextcheckfailur": [3, 7, 10], "continu": [3, 23], "control": 0, "cooldown": [3, 7, 10], "cooldown_dur": 12, "cooldown_with_role_bypass": [3, 7, 10], "copi": [1, 17], "core": [0, 1], "coro": [19, 21, 26], "coroutin": [8, 19, 21, 26], "correct": [0, 1], "correspond": [3, 23, 24], "could": [0, 21], "count": 19, "crash": 0, "creat": [0, 3, 4, 8, 12, 17, 23, 26], "create_datagram_endpoint": 4, "create_socket": [3, 4], "create_task": [3, 7, 26], "creation": 0, "criteria": 0, "ctx": [3, 10, 11, 18, 23], "current": [0, 3, 19, 23, 26], "custom": [0, 8, 20], "customlogg": [3, 7, 20], "cut": 0, "d": [1, 17], "dai": 0, "data": [3, 23, 24], "datetim": 26, "deal": 0, "decemb": 0, "declar": 0, "decor": [0, 8, 10, 12, 17, 19], "decorator_func": 17, "decrement": 19, "default": [0, 1, 3, 10, 14, 16, 17, 23, 24], "defin": [3, 23, 24], "delai": 26, "delet": [0, 3, 6, 8, 18, 23, 24], "deletemessagebutton": [0, 3, 7, 18], "depend": [0, 9], "deprec": 0, "describ": 10, "detail": 17, "detect": 0, "determin": [14, 15, 16], "dev": [1, 3], "develop": [0, 2, 3, 7], "dict": [3, 6, 17, 23, 24], "dictat": 0, "dictionari": [3, 23, 24], "did": 0, "directli": [0, 17], "directori": 1, "discord": [0, 1, 3, 5, 7, 9, 10, 11, 13, 14, 16, 17, 21, 23, 25], "discord_invit": [0, 3, 7, 25], "disnak": 0, "distinguish": 26, "django": 6, "dm": 10, "do": [0, 1, 9, 19], "doc": [0, 19], "docker": 1, "docstr": 0, "document": 0, "doe": [0, 17], "doesn": [3, 10, 26], "don": [0, 10, 26], "done": [3, 18, 23, 26], "drop": 0, "due": 0, "dummi": [0, 3], "duplic": [0, 12], "durat": 10, "dynam": 0, "e": [3, 23], "each": [0, 3, 23], "edit": 3, "effort": [3, 23], "either": [0, 3], "els": 11, "elsewher": 26, "emb": [0, 3, 23], "emit": 3, "emoji": [0, 3, 22, 23], "empti": [3, 23], "emptypaginatorembederror": [2, 3, 7, 23], "enabl": [0, 1], "encount": 24, "end": [3, 23], "endpoint": 6, "ensur": [0, 3, 18, 25], "entir": [0, 3], "env": 1, "environ": [0, 1], "equival": 6, "error": [0, 3, 6, 7, 13, 14, 15, 16, 21, 24], "error_handl": [0, 3, 7], "etc": [1, 10], "evalu": 17, "even": 22, "event": [0, 3, 4, 19, 26], "event_loop": 26, "everi": [3, 23], "exact": 1, "exampl": [3, 23], "exc_info": 20, "exce": [3, 8, 23], "exceed": [3, 23], "except": [3, 6, 10, 12, 14, 16, 17, 19, 20, 23, 24, 26], "exception_on_empty_emb": [3, 23], "excess": [3, 23], "exclus": 19, "execut": [19, 26], "exist": [0, 1, 26], "exit": 19, "expect": 21, "expiri": 0, "explain": 0, "expos": 19, "express": 25, "ext": [0, 2, 3, 7, 9, 10, 11, 23], "extend": 0, "extens": [0, 3], "extra": [0, 6], "extract": 0, "facilit": 0, "fail": [9, 10, 24], "fail_sil": 10, "failur": 21, "fakeredi": 0, "fals": [3, 10, 12, 19, 23, 24], "featur": [0, 1, 3], "februari": 0, "fetch": [9, 21], "few": 1, "field": [3, 23, 24], "fieldinfo": [3, 23, 24], "fifo": 8, "file": [0, 1, 24], "filter": 0, "finish": [3, 19, 23], "first": [3, 14, 16, 23], "five": [3, 23], "fix": 0, "float": [10, 12, 18, 26], "folder": 1, "footer": [3, 23], "footer_text": [3, 23], "forbidden": [0, 9, 13], "format": [24, 25], "formatt": 20, "formatted_code_regex": [3, 7, 25], "forum": 0, "forwardref": 17, "found": [3, 17, 21, 26], "free": 1, "from": [0, 1, 3, 4, 6, 7, 9, 17, 18, 21, 23, 24, 26], "frozenset": [3, 17], "func": [17, 19], "function": [0, 3, 7, 8, 9, 12, 19, 20, 21, 23, 26], "functool": 17, "futur": [10, 26], "g": [3, 23], "gatewai": 3, "gener": [0, 3, 12, 26], "get": [0, 3, 6, 9, 17, 21], "get_arg_valu": [3, 7, 17], "get_arg_value_wrapp": [3, 7, 17], "get_bound_arg": [3, 7, 17], "get_logg": [3, 7, 20], "get_or_fetch_channel": [0, 3, 7, 9], "get_or_fetch_memb": [0, 3, 7, 21], "git": 1, "github": 0, "give": 3, "given": [0, 3, 4, 7, 9, 11, 17, 19, 20, 21, 26], "global": 17, "globalnameconflicterror": [3, 7, 17], "go": [1, 3, 19, 23], "greater": 24, "groundwork": 1, "group": [7, 25], "guild": [0, 1, 3, 10, 21], "guild_available_but_cache_empti": 3, "guild_creat": 3, "guild_id": [1, 2, 3], "guildchannel": 9, "ha": [0, 3, 7, 10, 18], "handl": [0, 13, 14, 15, 16, 21, 26], "handle_app_command_error": [13, 14, 15], "handle_error": [13, 14, 16], "handle_forbidden_from_block": [3, 7, 13], "handle_role_chang": [0, 3, 7, 21], "handle_text_command_error": [13, 14, 15], "handler": [0, 3, 14, 15, 16], "happen": 3, "has_any_role_check": [3, 7, 10], "has_no_roles_check": [3, 7, 10], "hashabl": [19, 26], "have": [0, 9, 10, 17, 20], "heavi": 7, "help": [0, 1], "helper": [0, 9, 12, 21], "hold": [3, 19, 23], "holder": 19, "hook": 0, "host": 4, "houston": 20, "how": [0, 8, 10, 17, 26], "howev": 1, "http": [0, 3, 6, 24, 25], "http_session": [2, 3, 24], "httpexcept": 9, "i": [0, 1, 3, 6, 7, 9, 10, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "icon": [3, 23], "icon_url": [3, 23], "id": [1, 3, 7, 9, 10, 18, 19, 23, 26], "identifi": [19, 26], "ignor": [1, 7, 17, 22], "ignored_conflict_nam": 17, "immedi": 26, "implement": [0, 3, 4, 8, 18, 20], "import": 0, "in_whitelist": 10, "in_whitelist_check": [3, 7, 10], "inadequ": 3, "includ": [0, 1, 13], "incorrect": 0, "increment": 19, "independantli": 0, "index": 2, "indic": [3, 21, 23], "individu": 3, "info": [0, 1], "inform": [2, 19, 20], "init": [0, 3, 4], "initi": [6, 26], "initialis": [3, 8], "input": 18, "insert": [3, 23], "insid": [3, 23], "instal": [0, 1], "instanc": [0, 3, 6, 8, 9, 10, 20, 26], "instanti": [3, 18, 26], "instead": [3, 12, 26], "int": [3, 4, 8, 9, 10, 17, 18, 23, 24], "intend": 21, "intent": 1, "interact": [0, 3, 7, 9, 14, 15, 23], "interactin": 21, "interaction_check": [7, 18], "interest": 20, "intern": [3, 7, 19], "intersphinx": 0, "introduc": 10, "invalid": 9, "invaliddata": 9, "invit": [0, 25], "invoc": [0, 12], "invok": [1, 10, 12, 18], "inwhitelistcheckfailur": [3, 7, 10], "is_in_categori": [3, 7, 9], "isn": [0, 13, 17], "issu": 10, "item": 8, "iter": [10, 12, 14, 16], "its": [0, 3, 12, 17], "itself": 18, "januari": 0, "json": 6, "juli": 0, "june": 0, "just": 0, "keep": [3, 23, 26], "kei": 8, "keyword": [6, 7, 17, 20], "known": 26, "kwarg": [3, 6, 12, 17, 18, 20, 26], "label": [0, 18], "lancebot": 1, "larg": 24, "larger": 24, "last": [3, 10, 18, 23], "latest": 0, "lead": 0, "least": 10, "left": [3, 23], "length": [3, 12, 23], "level": [0, 7, 20], "lexer": [0, 24], "librari": [0, 1], "like": [1, 17], "limit": [3, 23], "line": [3, 23], "linepagin": [0, 2, 3, 7, 23], "linesep": [3, 23], "link": 24, "lint": 0, "list": [0, 1, 3, 18, 23, 24], "listen": 18, "ll": [1, 26], "load": [0, 1, 3, 7], "load_extens": [0, 2, 3], "local": 2, "localhost": 4, "lock": [0, 3, 7], "lock_arg": [3, 7, 19], "lockedresourceerror": [3, 7, 19], "log": [0, 3, 7, 13, 21, 26], "log_format": [0, 3, 7, 20], "log_to_dev_log": [2, 3], "logger": [0, 20], "logic": 0, "long": [10, 24, 26], "longer": [0, 18], "look": [17, 26], "loop": [4, 26], "lot": 0, "lru": 8, "lua": 0, "lupa": 0, "m": 1, "machin": 1, "made": [0, 22], "mai": [0, 3, 8, 19, 23], "main": 0, "make": [0, 1, 3, 20, 23], "manag": [0, 3, 13, 14, 19], "mani": [0, 3, 8], "manipul": [0, 17], "manual": 3, "map": [3, 17, 19, 23, 24], "march": 0, "mark": 0, "match": [0, 3, 17], "max": 24, "max_length": 24, "max_lin": [3, 23], "max_paste_s": [3, 7, 24], "max_siz": [3, 8, 23, 24], "maximum": [3, 8, 23, 24], "maybe_raise_for_statu": [3, 6], "mean": 1, "meant": 0, "member": [0, 3, 7, 18], "member_id": 21, "mention": [1, 3], "messag": [0, 3, 7, 11, 12, 13, 18, 20, 23, 26], "message_id": 22, "message_typ": 0, "metadata": [3, 23, 24], "method": [0, 4, 6, 7, 20], "metric": 3, "might": [1, 3, 10], "migrat": 0, "minut": [3, 23], "miss": 0, "mod": 0, "model": [3, 23, 24], "model_computed_field": [2, 3, 7, 23, 24], "model_config": [2, 3, 7, 23, 24], "model_field": [2, 3, 7, 23, 24], "moder": [3, 18, 22, 23], "modifi": [1, 21], "modul": [0, 3, 7, 17, 26], "monitor": 1, "monkei": [0, 7], "month": 0, "more": [0, 1, 3, 17, 19, 23], "most": 1, "move": 0, "msg": 20, "multipl": 0, "multivers": 0, "must": [0, 17, 19, 26], "mutual": 19, "mypi": 20, "n": [3, 23], "name": [3, 7, 17, 19, 20, 23, 24, 26], "name_or_po": [17, 19], "namespac": [0, 19, 26], "navig": [0, 1, 3, 23], "na\u00efv": 26, "need": [0, 1, 3, 23], "new": [0, 1, 3, 4, 6, 8, 17, 23, 26], "newer": 0, "newli": 0, "next": [3, 23], "non": 6, "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 26], "noreturn": [14, 15], "normal": 3, "notabl": 0, "note": [0, 10], "notfound": 9, "notic": 0, "notifi": 12, "novemb": 0, "now": [0, 1, 26], "number": [0, 3, 10, 23, 24], "object": [3, 6, 7, 8, 9, 12, 14, 16, 19, 21, 23, 24, 26], "occur": 18, "octob": 0, "offset": 8, "ok": 6, "older": 0, "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "on_readi": 3, "on_timeout": [7, 18], "onc": [0, 3, 8], "one": [0, 3, 10, 14, 16, 23], "ones": 1, "onli": [0, 3], "onto": [3, 23], "oper": [3, 19, 23, 26], "option": [0, 8, 17, 19], "order": [3, 8, 14, 16, 17, 19, 23, 26], "ordereddict": [17, 19], "origin": [0, 18], "other": [0, 1, 19, 26], "otherwis": [10, 19, 26], "our": [0, 1, 7], "out": [0, 1, 3, 18], "output": 25, "over": [0, 3, 23], "overflow": [3, 23], "overrid": [3, 23], "overwrit": [0, 3], "own": [0, 17], "p": [3, 7, 12], "packag": [0, 3, 7], "page": [2, 3, 23], "pagin": [0, 2, 3, 7], "pagination_emoji": [3, 23], "paginationemoji": [2, 3, 7, 23], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 17, 18, 19, 20, 21, 23, 24, 26], "paramspec": [12, 17], "parent": [0, 18], "pars": 25, "pass": [0, 3, 6, 17, 20, 21, 26], "past": [0, 24, 26], "paste_servic": [0, 3, 7], "paste_url": 24, "pastebin": 0, "pastefil": [0, 3, 7, 24], "pasterespons": [3, 7, 24], "pastetoolongerror": [3, 7, 24], "pasteunsupportedlexererror": [3, 7, 24], "pasteuploaderror": [3, 7, 24], "patch": [0, 3, 6, 7], "path": 1, "pattern": 25, "per": [3, 10, 23], "perform": 19, "permiss": [0, 9], "ping": 3, "ping_servic": [0, 2, 3], "pip": 1, "place": [3, 23], "pleas": 25, "poetri": [0, 1], "popul": 3, "port": [0, 4], "posit": [8, 17, 19], "possibl": 1, "post": [3, 6, 24], "pre": 1, "predic": [0, 14, 15], "prefix": [1, 3, 4, 23], "prematur": 26, "press": 0, "prevent": [12, 19, 26], "previous": 0, "prioriti": [14, 16], "privatechannel": [0, 9], "problem": [10, 20], "process": [0, 3], "process_command": [0, 2, 3], "program": 1, "project": [0, 1, 20], "provid": [0, 1, 3, 8, 11, 13, 23, 26], "public": 0, "publish": 0, "purpos": 21, "push": 0, "put": [3, 6], "py": [0, 3, 17], "pydant": [0, 3, 23, 24], "pydi": [0, 2], "pydis_cor": [0, 1, 3, 18, 20], "pypi": 0, "pyproject": [0, 1], "python": [0, 1, 3, 24, 26], "pythondiscord": [0, 24], "qualifi": 7, "quot": 25, "r": [3, 7, 12], "rais": [3, 6, 9, 10, 11, 12, 13, 14, 15, 17, 19, 21, 23, 24, 26], "raise_error": 19, "raise_for_statu": 6, "rate": 10, "rather": 7, "raw": [12, 25], "raw_code_regex": [3, 7, 25], "rc2": 0, "re": [1, 3, 13, 22, 26], "reach": 19, "reaction": [0, 3, 22, 23], "reaction_check": [0, 3, 7, 22], "read": 0, "readi": 3, "real": 0, "reason": [3, 23], "receiv": [0, 6, 9], "recognis": 20, "reconnect": 0, "redi": [0, 3], "redirect": 10, "redirect_channel": 10, "redis_sess": [2, 3], "rediscach": 0, "redissess": 3, "refer": 0, "referenc": 0, "reflect": 17, "regex": [0, 3, 7], "regist": [0, 14, 16], "register_command_error_manag": [2, 3], "register_handl": [13, 14, 16], "registr": [3, 14, 16], "regular": 25, "reinstal": 1, "reject": 24, "relat": [8, 14, 16, 20], "releas": 0, "relev": 3, "reli": 0, "remain": [3, 23], "remov": [0, 3, 18, 22, 23, 24], "remove_command": [2, 3], "remove_rol": 21, "renam": 0, "replac": [3, 10, 17, 23, 24], "repli": [3, 11, 12, 13, 23], "repo": 0, "represent": 6, "request": [0, 3, 6, 25], "requir": [0, 1, 3, 23, 24, 26], "resolut": 0, "resolv": [3, 17], "resourc": 19, "resource_id": 19, "resource_typ": 19, "respons": [0, 6, 24], "response_json": 6, "response_text": 6, "responsecodeerror": [2, 3, 6], "restor": 0, "restrict": [0, 3, 23], "restrict_to_us": [3, 23], "result": [0, 26], "retriev": 9, "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "reusabl": 5, "revert": 0, "right": [0, 3, 23], "role": [0, 1, 3, 10, 18, 21, 22, 23], "root": [1, 3, 7], "root_alias": 7, "rout": 7, "ruff": 0, "rule": 0, "run": [0, 1, 12, 19, 26], "runtimeerror": 19, "safe": 0, "same": [12, 26], "sampl": 0, "sanitis": 25, "save": [0, 3, 24], "scale": [3, 23], "scale_to_s": [3, 23], "schedul": [0, 3, 7], "schedule_at": [7, 26], "schedule_lat": [7, 26], "script": 0, "search": 2, "second": [3, 10, 12, 18, 23, 26], "secondari": 18, "see": [0, 1, 17, 18, 19], "self": [0, 3, 18], "send": [0, 3, 6, 18, 23], "send_notic": 12, "send_to_paste_servic": [0, 3, 7, 24], "send_typ": 7, "seper": 1, "septemb": 0, "sequenc": [3, 7, 17, 18, 23], "serv": [3, 23], "server": [3, 25], "servic": [0, 1, 3, 24], "session": [0, 3, 6, 24], "session_kwarg": 6, "set": [0, 1, 3, 12, 17, 18, 19, 23], "set_author": [3, 23], "setup": [0, 3], "setup_hook": [2, 3], "sever": 20, "share": [0, 17], "sharedev": [3, 7, 19], "should": [0, 1, 3, 6, 14, 15, 18, 23, 24], "should_handle_error": [13, 14, 15, 16], "should_rais": 6, "signatur": 12, "silent": 10, "similar": [18, 25], "sinc": 10, "singl": [0, 3, 23], "sir": 1, "site": [0, 3, 6], "site_api": [0, 2, 3], "site_api_token": 6, "site_api_url": 6, "size": [3, 8, 23, 24], "so": [0, 1, 3, 7], "socket": 4, "sole": 21, "some": [0, 3, 23, 24], "someth": 25, "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "specif": [0, 10], "specifi": [0, 10, 12, 18], "sphinx": 0, "split": 0, "stabl": 0, "standardis": [0, 20], "start": [0, 3, 26], "startup": 3, "startuperror": [2, 3], "stat": [0, 2, 3, 4], "state": 17, "static": 6, "statsclientbas": 4, "statsd": [0, 3, 4], "statsd_url": [0, 2, 3], "step": 1, "still": [3, 23], "stop": [0, 7, 18], "store": [0, 3, 7, 8, 23], "str": [3, 4, 6, 7, 10, 11, 17, 18, 19, 20, 23, 24, 26], "string": [0, 6], "style": 18, "sub": [0, 3], "submodul": [2, 13], "subpackag": 2, "subtract": 26, "success": [0, 24], "suffix": [3, 23], "suggest": 26, "support": [0, 4, 7, 26], "suppressed_except": 26, "sure": 1, "switch": [3, 23], "sync": [0, 3], "sync_app_command": 3, "system": [0, 1, 14, 16], "t": [0, 3, 10, 11, 13, 17, 19, 26], "target": [0, 8], "task": [0, 26], "task_id": 26, "task_return": 26, "templat": 1, "test": 2, "text": [0, 3, 6, 11, 14, 15, 23, 24], "textchannel": 9, "than": [7, 24], "thei": [3, 17, 22], "them": [1, 3, 17, 26], "thi": [0, 1, 3, 7, 9, 10, 12, 17, 18, 19, 21, 23, 24, 25, 26], "thread": [0, 9], "three": [3, 23], "through": [14, 16, 19], "thrown": 7, "thu": 3, "tild": 0, "time": [0, 10, 26], "timeout": [0, 3, 18, 23], "timezon": 26, "token": [1, 6], "toml": [0, 1], "too": 24, "tool": [3, 7], "top": 7, "total": [3, 23], "trace": [0, 7, 20], "track": 26, "transport": 4, "trashcan": [3, 23], "tree": 3, "trigger": 10, "true": [3, 6, 10, 12, 19, 20, 22, 23, 24, 26], "truncat": [3, 23], "tupl": [17, 26], "turn": 19, "two": 7, "type": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "type_": 10, "typeerror": [10, 17], "typehint": 17, "typevar": [12, 17, 26], "u": [0, 3, 23], "ui": 18, "unavail": 3, "unawait": 26, "under": 7, "underli": 19, "union": 10, "uniqu": 26, "unknown": 9, "unqualifi": [0, 2, 3, 7], "unschedul": 26, "unsupport": 24, "unti": [3, 23], "until": [0, 3, 19, 25], "up": [0, 1, 3, 23], "updat": [0, 17], "update_wrapper_glob": [3, 7, 17], "upload": [0, 24], "upon": 0, "url": [0, 3, 6, 23, 24], "urllib": 25, "us": [0, 1, 3, 4, 6, 7, 9, 10, 12, 17, 19, 20, 21, 23, 24, 25, 26], "usag": 0, "user": [0, 3, 10, 12, 18, 22, 23], "user_has_access": [0, 3, 7, 18], "utc": 26, "util": [0, 1, 2, 3, 8, 17, 18, 20], "v1": [0, 3, 23, 24], "valid": 0, "valu": [12, 17, 19, 20], "valueerror": [6, 17, 24], "vari": 1, "variabl": 1, "variou": [0, 9], "verifi": 10, "version": [0, 11], "view": [0, 18], "viewwithuserandrolecheck": [0, 3, 7, 18], "wa": [0, 9, 10, 26], "wait": [0, 3, 7, 19, 26], "wait_until_guild_avail": [2, 3], "want": 1, "warn": [0, 26], "wasn": 11, "we": [20, 21], "websocket": 0, "were": 3, "what": 1, "when": [0, 3, 4, 6, 7, 8, 10, 12, 17, 19, 23, 24, 26], "where": 10, "whether": [0, 3, 6, 9, 10, 14, 15, 18, 23], "which": [0, 1, 3, 7, 10, 12, 17, 19, 23, 26], "while": [3, 12, 19, 23], "whitelist": 10, "whitespac": [0, 25], "who": [0, 18], "whom": [3, 23], "within": [0, 3], "without": [0, 10], "won": 17, "word": [3, 23], "work": [0, 1], "worker": 7, "workflow": 0, "would": [3, 23], "wrap": [8, 17, 26], "wrapper": [0, 6, 12, 17, 26], "write": [0, 1], "wrong": 0, "www": 0, "x": 0, "you": [0, 1, 9, 25], "your": 1}, "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Pydis Core", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "checks", "commands", "cooldown", "error_handling package", "commands package", "abc", "manager", "function", "interactions", "lock", "logging", "members", "messages", "pagination", "paste_service", "regex", "scheduling"], "titleterms": {"1": 1, "2": 1, "abc": 15, "async_stat": 4, "bot": 2, "cach": 8, "changelog": 0, "channel": 9, "check": 10, "command": [11, 14], "cooldown": 12, "core": [2, 3], "develop": 1, "document": 2, "error_handl": 13, "ext": 5, "extra": 2, "function": 17, "interact": 18, "local": 1, "lock": 19, "log": 20, "manag": 16, "member": 21, "messag": 22, "modul": 2, "option": 1, "packag": [13, 14], "pagin": 23, "paste_servic": 24, "project": 2, "pydi": 3, "refer": 2, "regex": 25, "schedul": 26, "site_api": 6, "submodul": [3, 7, 14], "subpackag": [3, 7, 13], "test": 1, "util": 7}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Changelog": [[0, "changelog"]], "Extras": [[2, "extras"]], "Exts": [[5, "module-pydis_core.exts"]], "Local Development & Testing": [[1, "local-development-testing"]], "Modules:": [[2, null]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Pydis Core": [[3, "module-pydis_core"]], "Reference": [[2, "reference"]], "Submodules": [[3, "submodules"], [7, "submodules"], [14, "submodules"]], "Subpackages": [[3, "subpackages"], [7, "subpackages"], [13, "subpackages"]], "Utils": [[7, "module-pydis_core.utils"]], "abc": [[15, "module-pydis_core.utils.error_handling.commands.abc"]], "async_stats": [[4, "module-pydis_core.async_stats"]], "caching": [[8, "module-pydis_core.utils.caching"]], "channel": [[9, "module-pydis_core.utils.channel"]], "checks": [[10, "module-pydis_core.utils.checks"]], "commands": [[11, "module-pydis_core.utils.commands"]], "commands package": [[14, "module-pydis_core.utils.error_handling.commands"]], "cooldown": [[12, "module-pydis_core.utils.cooldown"]], "error_handling package": [[13, "module-pydis_core.utils.error_handling"]], "function": [[17, "module-pydis_core.utils.function"]], "interactions": [[18, "module-pydis_core.utils.interactions"]], "lock": [[19, "module-pydis_core.utils.lock"]], "logging": [[20, "module-pydis_core.utils.logging"]], "manager": [[16, "module-pydis_core.utils.error_handling.commands.manager"]], "members": [[21, "module-pydis_core.utils.members"]], "messages": [[22, "module-pydis_core.utils.messages"]], "pagination": [[23, "module-pydis_core.utils.pagination"]], "paste_service": [[24, "module-pydis_core.utils.paste_service"]], "regex": [[25, "module-pydis_core.utils.regex"]], "scheduling": [[26, "module-pydis_core.utils.scheduling"]], "site_api": [[6, "module-pydis_core.site_api"]]}, "docnames": ["changelog", "development", "index", "output/pydis_core", "output/pydis_core.async_stats", "output/pydis_core.exts", "output/pydis_core.site_api", "output/pydis_core.utils", "output/pydis_core.utils.caching", "output/pydis_core.utils.channel", "output/pydis_core.utils.checks", "output/pydis_core.utils.commands", "output/pydis_core.utils.cooldown", "output/pydis_core.utils.error_handling", "output/pydis_core.utils.error_handling.commands", "output/pydis_core.utils.error_handling.commands.abc", "output/pydis_core.utils.error_handling.commands.manager", "output/pydis_core.utils.function", "output/pydis_core.utils.interactions", "output/pydis_core.utils.lock", "output/pydis_core.utils.logging", "output/pydis_core.utils.members", "output/pydis_core.utils.messages", "output/pydis_core.utils.pagination", "output/pydis_core.utils.paste_service", "output/pydis_core.utils.regex", "output/pydis_core.utils.scheduling"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2}, "filenames": ["changelog.rst", "development.rst", "index.rst", "output/pydis_core.rst", "output/pydis_core.async_stats.rst", "output/pydis_core.exts.rst", "output/pydis_core.site_api.rst", "output/pydis_core.utils.rst", "output/pydis_core.utils.caching.rst", "output/pydis_core.utils.channel.rst", "output/pydis_core.utils.checks.rst", "output/pydis_core.utils.commands.rst", "output/pydis_core.utils.cooldown.rst", "output/pydis_core.utils.error_handling.rst", "output/pydis_core.utils.error_handling.commands.rst", "output/pydis_core.utils.error_handling.commands.abc.rst", "output/pydis_core.utils.error_handling.commands.manager.rst", "output/pydis_core.utils.function.rst", "output/pydis_core.utils.interactions.rst", "output/pydis_core.utils.lock.rst", "output/pydis_core.utils.logging.rst", "output/pydis_core.utils.members.rst", "output/pydis_core.utils.messages.rst", "output/pydis_core.utils.pagination.rst", "output/pydis_core.utils.paste_service.rst", "output/pydis_core.utils.regex.rst", "output/pydis_core.utils.scheduling.rst"], "indexentries": {"__call__() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.__call__", false]], "__contains__() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.__contains__", false]], "__enter__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__enter__", false]], "__exit__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__exit__", false]], "__init__() (apiclient method)": [[6, "pydis_core.site_api.APIClient.__init__", false]], "__init__() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.__init__", false]], "__init__() (asyncstatsclient method)": [[4, "pydis_core.async_stats.AsyncStatsClient.__init__", false]], "__init__() (botbase method)": [[3, "pydis_core.BotBase.__init__", false]], "__init__() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.__init__", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.__init__", false]], "__init__() (commandoncooldown method)": [[12, "pydis_core.utils.cooldown.CommandOnCooldown.__init__", false]], "__init__() (contextcheckfailure method)": [[10, "pydis_core.utils.checks.ContextCheckFailure.__init__", false]], "__init__() (deletemessagebutton method)": [[18, "pydis_core.utils.interactions.DeleteMessageButton.__init__", false]], "__init__() (linepaginator method)": [[3, "pydis_core.LinePaginator.__init__", false], [23, "pydis_core.utils.pagination.LinePaginator.__init__", false]], "__init__() (lockedresourceerror method)": [[19, "pydis_core.utils.lock.LockedResourceError.__init__", false]], "__init__() (responsecodeerror method)": [[6, "pydis_core.site_api.ResponseCodeError.__init__", false]], "__init__() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.__init__", false]], "__init__() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.__init__", false]], "__init__() (startuperror method)": [[3, "pydis_core.StartupError.__init__", false]], "__init__() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.__init__", false]], "__str__() (responsecodeerror method)": [[6, "pydis_core.site_api.ResponseCodeError.__str__", false]], "abstractcommanderrorhandler (class in pydis_core.utils.error_handling.commands)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler", false]], "abstractcommanderrorhandler (class in pydis_core.utils.error_handling.commands.abc)": [[15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler", false]], "add_cog() (botbase method)": [[3, "pydis_core.BotBase.add_cog", false]], "add_command() (botbase method)": [[3, "pydis_core.BotBase.add_command", false]], "add_line() (linepaginator method)": [[3, "pydis_core.LinePaginator.add_line", false], [23, "pydis_core.utils.pagination.LinePaginator.add_line", false]], "all_extensions (botbase attribute)": [[3, "pydis_core.BotBase.all_extensions", false]], "api_client (botbase attribute)": [[3, "pydis_core.BotBase.api_client", false]], "apiclient (class in pydis_core.site_api)": [[6, "pydis_core.site_api.APIClient", false]], "apply_monkey_patches() (in module pydis_core.utils)": [[7, "pydis_core.utils.apply_monkey_patches", false]], "asynccache (class in pydis_core.utils.caching)": [[8, "pydis_core.utils.caching.AsyncCache", false]], "asyncstatsclient (class in pydis_core.async_stats)": [[4, "pydis_core.async_stats.AsyncStatsClient", false]], "block_duplicate_invocations() (in module pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.block_duplicate_invocations", false]], "botbase (class in pydis_core)": [[3, "pydis_core.BotBase", false]], "call_without_cooldown() (commandoncooldown method)": [[12, "pydis_core.utils.cooldown.CommandOnCooldown.call_without_cooldown", false]], "callback() (deletemessagebutton method)": [[18, "pydis_core.utils.interactions.DeleteMessageButton.callback", false]], "cancel() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.cancel", false]], "cancel_all() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.cancel_all", false]], "clean_text_or_reply() (in module pydis_core.utils.commands)": [[11, "pydis_core.utils.commands.clean_text_or_reply", false]], "clear() (asynccache method)": [[8, "pydis_core.utils.caching.AsyncCache.clear", false]], "clear() (botbase method)": [[3, "pydis_core.BotBase.clear", false]], "close() (apiclient method)": [[6, "pydis_core.site_api.APIClient.close", false]], "close() (botbase method)": [[3, "pydis_core.BotBase.close", false]], "command_wraps() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.command_wraps", false]], "commanderrormanager (class in pydis_core.utils.error_handling.commands)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager", false]], "commanderrormanager (class in pydis_core.utils.error_handling.commands.manager)": [[16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager", false]], "commandoncooldown": [[12, "pydis_core.utils.cooldown.CommandOnCooldown", false]], "contextcheckfailure": [[10, "pydis_core.utils.checks.ContextCheckFailure", false]], "cooldown_with_role_bypass() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.cooldown_with_role_bypass", false]], "create_socket() (asyncstatsclient method)": [[4, "pydis_core.async_stats.AsyncStatsClient.create_socket", false]], "create_task() (in module pydis_core.utils.scheduling)": [[26, "pydis_core.utils.scheduling.create_task", false]], "customlogger (class in pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.CustomLogger", false]], "delete() (apiclient method)": [[6, "pydis_core.site_api.APIClient.delete", false]], "deletemessagebutton (class in pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.DeleteMessageButton", false]], "discord_invite (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.DISCORD_INVITE", false]], "emptypaginatorembederror": [[3, "pydis_core.EmptyPaginatorEmbedError", false], [23, "pydis_core.utils.pagination.EmptyPaginatorEmbedError", false]], "formatted_code_regex (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.FORMATTED_CODE_REGEX", false]], "get() (apiclient method)": [[6, "pydis_core.site_api.APIClient.get", false]], "get_arg_value() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_arg_value", false]], "get_arg_value_wrapper() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_arg_value_wrapper", false]], "get_bound_args() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.get_bound_args", false]], "get_logger() (in module pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.get_logger", false]], "get_or_fetch_channel() (in module pydis_core.utils.channel)": [[9, "pydis_core.utils.channel.get_or_fetch_channel", false]], "get_or_fetch_member() (in module pydis_core.utils.members)": [[21, "pydis_core.utils.members.get_or_fetch_member", false]], "globalnameconflicterror": [[17, "pydis_core.utils.function.GlobalNameConflictError", false]], "guild_id (botbase attribute)": [[3, "pydis_core.BotBase.guild_id", false]], "handle_app_command_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_app_command_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_app_command_error", false]], "handle_error() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.handle_error", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.handle_error", false]], "handle_forbidden_from_block() (in module pydis_core.utils.error_handling)": [[13, "pydis_core.utils.error_handling.handle_forbidden_from_block", false]], "handle_role_change() (in module pydis_core.utils.members)": [[21, "pydis_core.utils.members.handle_role_change", false]], "handle_text_command_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_text_command_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_text_command_error", false]], "has_any_role_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.has_any_role_check", false]], "has_no_roles_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.has_no_roles_check", false]], "http_session (botbase attribute)": [[3, "pydis_core.BotBase.http_session", false]], "id (lockedresourceerror attribute)": [[19, "pydis_core.utils.lock.LockedResourceError.id", false]], "in_whitelist_check() (in module pydis_core.utils.checks)": [[10, "pydis_core.utils.checks.in_whitelist_check", false]], "interaction_check() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.interaction_check", false]], "inwhitelistcheckfailure": [[10, "pydis_core.utils.checks.InWhitelistCheckFailure", false]], "is_in_category() (in module pydis_core.utils.channel)": [[9, "pydis_core.utils.channel.is_in_category", false]], "linepaginator (class in pydis_core)": [[3, "pydis_core.LinePaginator", false]], "linepaginator (class in pydis_core.utils.pagination)": [[23, "pydis_core.utils.pagination.LinePaginator", false]], "load_extensions() (botbase method)": [[3, "pydis_core.BotBase.load_extensions", false]], "lock() (in module pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.lock", false]], "lock_arg() (in module pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.lock_arg", false]], "lockedresourceerror": [[19, "pydis_core.utils.lock.LockedResourceError", false]], "log_format (in module pydis_core.utils.logging)": [[20, "pydis_core.utils.logging.log_format", false]], "log_to_dev_log() (botbase method)": [[3, "pydis_core.BotBase.log_to_dev_log", false]], "max_paste_size (in module pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.MAX_PASTE_SIZE", false]], "maybe_raise_for_status() (apiclient static method)": [[6, "pydis_core.site_api.APIClient.maybe_raise_for_status", false]], "model_computed_fields (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.model_computed_fields", false], [23, "pydis_core.utils.pagination.PaginationEmojis.model_computed_fields", false]], "model_computed_fields (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.model_computed_fields", false]], "model_computed_fields (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.model_computed_fields", false]], "model_config (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.model_config", false], [23, "pydis_core.utils.pagination.PaginationEmojis.model_config", false]], "model_config (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.model_config", false]], "model_config (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.model_config", false]], "model_fields (paginationemojis attribute)": [[3, "pydis_core.PaginationEmojis.model_fields", false], [23, "pydis_core.utils.pagination.PaginationEmojis.model_fields", false]], "model_fields (pastefile attribute)": [[24, "pydis_core.utils.paste_service.PasteFile.model_fields", false]], "model_fields (pasteresponse attribute)": [[24, "pydis_core.utils.paste_service.PasteResponse.model_fields", false]], "module": [[3, "module-pydis_core", false], [4, "module-pydis_core.async_stats", false], [5, "module-pydis_core.exts", false], [6, "module-pydis_core.site_api", false], [7, "module-pydis_core.utils", false], [8, "module-pydis_core.utils.caching", false], [9, "module-pydis_core.utils.channel", false], [10, "module-pydis_core.utils.checks", false], [11, "module-pydis_core.utils.commands", false], [12, "module-pydis_core.utils.cooldown", false], [13, "module-pydis_core.utils.error_handling", false], [14, "module-pydis_core.utils.error_handling.commands", false], [15, "module-pydis_core.utils.error_handling.commands.abc", false], [16, "module-pydis_core.utils.error_handling.commands.manager", false], [17, "module-pydis_core.utils.function", false], [18, "module-pydis_core.utils.interactions", false], [19, "module-pydis_core.utils.lock", false], [20, "module-pydis_core.utils.logging", false], [21, "module-pydis_core.utils.members", false], [22, "module-pydis_core.utils.messages", false], [23, "module-pydis_core.utils.pagination", false], [24, "module-pydis_core.utils.paste_service", false], [25, "module-pydis_core.utils.regex", false], [26, "module-pydis_core.utils.scheduling", false]], "on_guild_available() (botbase method)": [[3, "pydis_core.BotBase.on_guild_available", false]], "on_guild_unavailable() (botbase method)": [[3, "pydis_core.BotBase.on_guild_unavailable", false]], "on_timeout() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.on_timeout", false]], "p (in module pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.P", false]], "paginate() (linepaginator class method)": [[3, "pydis_core.LinePaginator.paginate", false], [23, "pydis_core.utils.pagination.LinePaginator.paginate", false]], "paginationemojis (class in pydis_core)": [[3, "pydis_core.PaginationEmojis", false]], "paginationemojis (class in pydis_core.utils.pagination)": [[23, "pydis_core.utils.pagination.PaginationEmojis", false]], "pastefile (class in pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.PasteFile", false]], "pasteresponse (class in pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.PasteResponse", false]], "pastetoolongerror": [[24, "pydis_core.utils.paste_service.PasteTooLongError", false]], "pasteunsupportedlexererror": [[24, "pydis_core.utils.paste_service.PasteUnsupportedLexerError", false]], "pasteuploaderror": [[24, "pydis_core.utils.paste_service.PasteUploadError", false]], "patch() (apiclient method)": [[6, "pydis_core.site_api.APIClient.patch", false]], "ping_services() (botbase method)": [[3, "pydis_core.BotBase.ping_services", false]], "post() (apiclient method)": [[6, "pydis_core.site_api.APIClient.post", false]], "process_commands() (botbase method)": [[3, "pydis_core.BotBase.process_commands", false]], "put() (apiclient method)": [[6, "pydis_core.site_api.APIClient.put", false]], "pydis_core": [[3, "module-pydis_core", false]], "pydis_core.async_stats": [[4, "module-pydis_core.async_stats", false]], "pydis_core.exts": [[5, "module-pydis_core.exts", false]], "pydis_core.site_api": [[6, "module-pydis_core.site_api", false]], "pydis_core.utils": [[7, "module-pydis_core.utils", false]], "pydis_core.utils.caching": [[8, "module-pydis_core.utils.caching", false]], "pydis_core.utils.channel": [[9, "module-pydis_core.utils.channel", false]], "pydis_core.utils.checks": [[10, "module-pydis_core.utils.checks", false]], "pydis_core.utils.commands": [[11, "module-pydis_core.utils.commands", false]], "pydis_core.utils.cooldown": [[12, "module-pydis_core.utils.cooldown", false]], "pydis_core.utils.error_handling": [[13, "module-pydis_core.utils.error_handling", false]], "pydis_core.utils.error_handling.commands": [[14, "module-pydis_core.utils.error_handling.commands", false]], "pydis_core.utils.error_handling.commands.abc": [[15, "module-pydis_core.utils.error_handling.commands.abc", false]], "pydis_core.utils.error_handling.commands.manager": [[16, "module-pydis_core.utils.error_handling.commands.manager", false]], "pydis_core.utils.function": [[17, "module-pydis_core.utils.function", false]], "pydis_core.utils.interactions": [[18, "module-pydis_core.utils.interactions", false]], "pydis_core.utils.lock": [[19, "module-pydis_core.utils.lock", false]], "pydis_core.utils.logging": [[20, "module-pydis_core.utils.logging", false]], "pydis_core.utils.members": [[21, "module-pydis_core.utils.members", false]], "pydis_core.utils.messages": [[22, "module-pydis_core.utils.messages", false]], "pydis_core.utils.pagination": [[23, "module-pydis_core.utils.pagination", false]], "pydis_core.utils.paste_service": [[24, "module-pydis_core.utils.paste_service", false]], "pydis_core.utils.regex": [[25, "module-pydis_core.utils.regex", false]], "pydis_core.utils.scheduling": [[26, "module-pydis_core.utils.scheduling", false]], "r (class in pydis_core.utils.cooldown)": [[12, "pydis_core.utils.cooldown.R", false]], "raw_code_regex (in module pydis_core.utils.regex)": [[25, "pydis_core.utils.regex.RAW_CODE_REGEX", false]], "reaction_check() (in module pydis_core.utils.messages)": [[22, "pydis_core.utils.messages.reaction_check", false]], "redis_session (botbase attribute)": [[3, "pydis_core.BotBase.redis_session", false]], "register_command_error_manager() (botbase method)": [[3, "pydis_core.BotBase.register_command_error_manager", false]], "register_handler() (commanderrormanager method)": [[14, "pydis_core.utils.error_handling.commands.CommandErrorManager.register_handler", false], [16, "pydis_core.utils.error_handling.commands.manager.CommandErrorManager.register_handler", false]], "remove_command() (botbase method)": [[3, "pydis_core.BotBase.remove_command", false]], "request() (apiclient method)": [[6, "pydis_core.site_api.APIClient.request", false]], "responsecodeerror": [[6, "pydis_core.site_api.ResponseCodeError", false]], "schedule() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule", false]], "schedule_at() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule_at", false]], "schedule_later() (scheduler method)": [[26, "pydis_core.utils.scheduling.Scheduler.schedule_later", false]], "scheduler (class in pydis_core.utils.scheduling)": [[26, "pydis_core.utils.scheduling.Scheduler", false]], "send_to_paste_service() (in module pydis_core.utils.paste_service)": [[24, "pydis_core.utils.paste_service.send_to_paste_service", false]], "setup_hook() (botbase method)": [[3, "pydis_core.BotBase.setup_hook", false]], "sharedevent (class in pydis_core.utils.lock)": [[19, "pydis_core.utils.lock.SharedEvent", false]], "should_handle_error() (abstractcommanderrorhandler method)": [[14, "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.should_handle_error", false], [15, "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.should_handle_error", false]], "startuperror": [[3, "pydis_core.StartupError", false]], "stats (botbase attribute)": [[3, "pydis_core.BotBase.stats", false]], "statsd_url (botbase attribute)": [[3, "pydis_core.BotBase.statsd_url", false]], "stop() (viewwithuserandrolecheck method)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck.stop", false]], "trace() (customlogger method)": [[20, "pydis_core.utils.logging.CustomLogger.trace", false]], "type (lockedresourceerror attribute)": [[19, "pydis_core.utils.lock.LockedResourceError.type", false]], "unqualify() (in module pydis_core.utils)": [[7, "pydis_core.utils.unqualify", false]], "update_wrapper_globals() (in module pydis_core.utils.function)": [[17, "pydis_core.utils.function.update_wrapper_globals", false]], "user_has_access() (in module pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.user_has_access", false]], "viewwithuserandrolecheck (class in pydis_core.utils.interactions)": [[18, "pydis_core.utils.interactions.ViewWithUserAndRoleCheck", false]], "wait() (sharedevent method)": [[19, "pydis_core.utils.lock.SharedEvent.wait", false]], "wait_until_guild_available() (botbase method)": [[3, "pydis_core.BotBase.wait_until_guild_available", false]]}, "objects": {"": [[3, 0, 0, "-", "pydis_core"]], "pydis_core": [[3, 1, 1, "", "BotBase"], [3, 4, 1, "", "EmptyPaginatorEmbedError"], [3, 1, 1, "", "LinePaginator"], [3, 1, 1, "", "PaginationEmojis"], [3, 4, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "pydis_core.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 3, 1, "", "all_extensions"], [3, 3, 1, "", "api_client"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [3, 3, 1, "", "guild_id"], [3, 3, 1, "", "http_session"], [3, 2, 1, "", "load_extensions"], [3, 2, 1, "", "log_to_dev_log"], [3, 2, 1, "", "on_guild_available"], [3, 2, 1, "", "on_guild_unavailable"], [3, 2, 1, "", "ping_services"], [3, 2, 1, "", "process_commands"], [3, 3, 1, "", "redis_session"], [3, 2, 1, "", "register_command_error_manager"], [3, 2, 1, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 3, 1, "", "stats"], [3, 3, 1, "", "statsd_url"], [3, 2, 1, "", "wait_until_guild_available"]], "pydis_core.LinePaginator": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_line"], [3, 2, 1, "", "paginate"]], "pydis_core.PaginationEmojis": [[3, 3, 1, "", "model_computed_fields"], [3, 3, 1, "", "model_config"], [3, 3, 1, "", "model_fields"]], "pydis_core.StartupError": [[3, 2, 1, "", "__init__"]], "pydis_core.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "pydis_core.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "pydis_core.site_api": [[6, 1, 1, "", "APIClient"], [6, 4, 1, "", "ResponseCodeError"]], "pydis_core.site_api.APIClient": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "close"], [6, 2, 1, "", "delete"], [6, 2, 1, "", "get"], [6, 2, 1, "", "maybe_raise_for_status"], [6, 2, 1, "", "patch"], [6, 2, 1, "", "post"], [6, 2, 1, "", "put"], [6, 2, 1, "", "request"]], "pydis_core.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "pydis_core.utils": [[7, 5, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "checks"], [11, 0, 0, "-", "commands"], [12, 0, 0, "-", "cooldown"], [13, 0, 0, "-", "error_handling"], [17, 0, 0, "-", "function"], [18, 0, 0, "-", "interactions"], [19, 0, 0, "-", "lock"], [20, 0, 0, "-", "logging"], [21, 0, 0, "-", "members"], [22, 0, 0, "-", "messages"], [23, 0, 0, "-", "pagination"], [24, 0, 0, "-", "paste_service"], [25, 0, 0, "-", "regex"], [26, 0, 0, "-", "scheduling"], [7, 5, 1, "", "unqualify"]], "pydis_core.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "pydis_core.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "pydis_core.utils.channel": [[9, 5, 1, "", "get_or_fetch_channel"], [9, 5, 1, "", "is_in_category"]], "pydis_core.utils.checks": [[10, 4, 1, "", "ContextCheckFailure"], [10, 4, 1, "", "InWhitelistCheckFailure"], [10, 5, 1, "", "cooldown_with_role_bypass"], [10, 5, 1, "", "has_any_role_check"], [10, 5, 1, "", "has_no_roles_check"], [10, 5, 1, "", "in_whitelist_check"]], "pydis_core.utils.checks.ContextCheckFailure": [[10, 2, 1, "", "__init__"]], "pydis_core.utils.commands": [[11, 5, 1, "", "clean_text_or_reply"]], "pydis_core.utils.cooldown": [[12, 4, 1, "", "CommandOnCooldown"], [12, 6, 1, "", "P"], [12, 1, 1, "", "R"], [12, 5, 1, "", "block_duplicate_invocations"]], "pydis_core.utils.cooldown.CommandOnCooldown": [[12, 2, 1, "", "__init__"], [12, 2, 1, "", "call_without_cooldown"]], "pydis_core.utils.error_handling": [[14, 0, 0, "-", "commands"], [13, 5, 1, "", "handle_forbidden_from_block"]], "pydis_core.utils.error_handling.commands": [[14, 1, 1, "", "AbstractCommandErrorHandler"], [14, 1, 1, "", "CommandErrorManager"], [15, 0, 0, "-", "abc"], [16, 0, 0, "-", "manager"]], "pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler": [[14, 2, 1, "", "handle_app_command_error"], [14, 2, 1, "", "handle_text_command_error"], [14, 2, 1, "", "should_handle_error"]], "pydis_core.utils.error_handling.commands.CommandErrorManager": [[14, 2, 1, "", "__init__"], [14, 2, 1, "", "handle_error"], [14, 2, 1, "", "register_handler"]], "pydis_core.utils.error_handling.commands.abc": [[15, 1, 1, "", "AbstractCommandErrorHandler"]], "pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler": [[15, 2, 1, "", "handle_app_command_error"], [15, 2, 1, "", "handle_text_command_error"], [15, 2, 1, "", "should_handle_error"]], "pydis_core.utils.error_handling.commands.manager": [[16, 1, 1, "", "CommandErrorManager"]], "pydis_core.utils.error_handling.commands.manager.CommandErrorManager": [[16, 2, 1, "", "__init__"], [16, 2, 1, "", "handle_error"], [16, 2, 1, "", "register_handler"]], "pydis_core.utils.function": [[17, 4, 1, "", "GlobalNameConflictError"], [17, 5, 1, "", "command_wraps"], [17, 5, 1, "", "get_arg_value"], [17, 5, 1, "", "get_arg_value_wrapper"], [17, 5, 1, "", "get_bound_args"], [17, 5, 1, "", "update_wrapper_globals"]], "pydis_core.utils.interactions": [[18, 1, 1, "", "DeleteMessageButton"], [18, 1, 1, "", "ViewWithUserAndRoleCheck"], [18, 5, 1, "", "user_has_access"]], "pydis_core.utils.interactions.DeleteMessageButton": [[18, 2, 1, "", "__init__"], [18, 2, 1, "", "callback"]], "pydis_core.utils.interactions.ViewWithUserAndRoleCheck": [[18, 2, 1, "", "__init__"], [18, 2, 1, "", "interaction_check"], [18, 2, 1, "", "on_timeout"], [18, 2, 1, "", "stop"]], "pydis_core.utils.lock": [[19, 4, 1, "", "LockedResourceError"], [19, 1, 1, "", "SharedEvent"], [19, 5, 1, "", "lock"], [19, 5, 1, "", "lock_arg"]], "pydis_core.utils.lock.LockedResourceError": [[19, 2, 1, "", "__init__"], [19, 3, 1, "", "id"], [19, 3, 1, "", "type"]], "pydis_core.utils.lock.SharedEvent": [[19, 2, 1, "", "__enter__"], [19, 2, 1, "", "__exit__"], [19, 2, 1, "", "__init__"], [19, 2, 1, "", "wait"]], "pydis_core.utils.logging": [[20, 1, 1, "", "CustomLogger"], [20, 5, 1, "", "get_logger"], [20, 6, 1, "", "log_format"]], "pydis_core.utils.logging.CustomLogger": [[20, 2, 1, "", "trace"]], "pydis_core.utils.members": [[21, 5, 1, "", "get_or_fetch_member"], [21, 5, 1, "", "handle_role_change"]], "pydis_core.utils.messages": [[22, 5, 1, "", "reaction_check"]], "pydis_core.utils.pagination": [[23, 4, 1, "", "EmptyPaginatorEmbedError"], [23, 1, 1, "", "LinePaginator"], [23, 1, 1, "", "PaginationEmojis"]], "pydis_core.utils.pagination.LinePaginator": [[23, 2, 1, "", "__init__"], [23, 2, 1, "", "add_line"], [23, 2, 1, "", "paginate"]], "pydis_core.utils.pagination.PaginationEmojis": [[23, 3, 1, "", "model_computed_fields"], [23, 3, 1, "", "model_config"], [23, 3, 1, "", "model_fields"]], "pydis_core.utils.paste_service": [[24, 6, 1, "", "MAX_PASTE_SIZE"], [24, 1, 1, "", "PasteFile"], [24, 1, 1, "", "PasteResponse"], [24, 4, 1, "", "PasteTooLongError"], [24, 4, 1, "", "PasteUnsupportedLexerError"], [24, 4, 1, "", "PasteUploadError"], [24, 5, 1, "", "send_to_paste_service"]], "pydis_core.utils.paste_service.PasteFile": [[24, 3, 1, "", "model_computed_fields"], [24, 3, 1, "", "model_config"], [24, 3, 1, "", "model_fields"]], "pydis_core.utils.paste_service.PasteResponse": [[24, 3, 1, "", "model_computed_fields"], [24, 3, 1, "", "model_config"], [24, 3, 1, "", "model_fields"]], "pydis_core.utils.regex": [[25, 6, 1, "", "DISCORD_INVITE"], [25, 6, 1, "", "FORMATTED_CODE_REGEX"], [25, 6, 1, "", "RAW_CODE_REGEX"]], "pydis_core.utils.scheduling": [[26, 1, 1, "", "Scheduler"], [26, 5, 1, "", "create_task"]], "pydis_core.utils.scheduling.Scheduler": [[26, 2, 1, "", "__contains__"], [26, 2, 1, "", "__init__"], [26, 2, 1, "", "cancel"], [26, 2, 1, "", "cancel_all"], [26, 2, 1, "", "schedule"], [26, 2, 1, "", "schedule_at"], [26, 2, 1, "", "schedule_later"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "exception", "Python exception"], "5": ["py", "function", "Python function"], "6": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:exception", "5": "py:function", "6": "py:data"}, "terms": {"": [0, 1, 3, 7, 8, 10, 11, 12, 17, 18, 19, 20, 22, 23, 25, 26], "0": [0, 8, 10, 18, 19, 20], "0a0": 0, "0eb3d26": 0, "1": [0, 20], "10": 0, "101": 0, "103": 0, "104": 0, "106": 0, "107": 0, "108": 0, "10th": 0, "11": 0, "110": 0, "12": 0, "124": 0, "125": 0, "128": 8, "138": 0, "13th": 0, "14th": 0, "15": 0, "151": 0, "157": 0, "158": 0, "162": 0, "169": 0, "16th": 0, "170": 0, "171": 0, "172": 0, "173": 0, "174": 0, "175": 0, "176": 0, "177": 0, "179": 0, "17th": 0, "180": 18, "181": 0, "182": 0, "183": 0, "184": 0, "185": 0, "187": 0, "188": 0, "189": 0, "18th": 0, "190": 0, "192": 0, "194": 0, "195": 0, "196": 0, "197": 0, "199": 0, "19th": 0, "2": [0, 3, 18], "200": 0, "202": 0, "2021": 0, "2022": 0, "2023": 0, "2024": 0, "204": [0, 6], "205": 0, "206": 0, "207": 0, "208": 0, "209": 0, "20th": 0, "210": 0, "21st": 0, "22nd": 0, "23rd": 0, "244": 0, "24th": 0, "25th": 0, "26th": 0, "27th": 0, "28th": 0, "29": 0, "2nd": 0, "3": 0, "30": 0, "300": [3, 23], "30th": 0, "32": 0, "34": 0, "35": 0, "37": 0, "39": 0, "3rd": 0, "4": 0, "4000": [3, 23], "403": 7, "42": 0, "4cbe8f5": 0, "5": [0, 12], "500": [3, 23], "524288": 24, "54": 0, "56": 0, "5a06fa5": 0, "5th": 0, "6": 0, "61": 0, "63": 0, "637136429717389331": [3, 23], "64": 0, "65": 0, "66": 0, "68": 0, "69": 0, "6th": 0, "7": 0, "72": 0, "75": 0, "78": 0, "79": 0, "8": 0, "8125": 4, "88": 0, "9": 0, "90001": [0, 13], "91": 0, "93": 0, "96": 0, "98": 0, "987235d": 0, "9th": 0, "A": [1, 3, 6, 7, 8, 9, 10, 12, 14, 15, 16, 17, 18, 20, 23, 24, 26], "As": 0, "Be": 0, "For": 17, "If": [3, 6, 10, 12, 17, 18, 19, 22, 23, 26], "In": [3, 23], "It": [3, 7, 19, 23], "Not": 3, "On": 0, "That": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 17, 18, 20, 21, 23, 24, 26], "These": [3, 23], "To": [1, 3, 20], "_": 0, "__annotations__": 17, "__call__": [7, 8], "__contains__": [7, 26], "__dict__": 17, "__doc__": 17, "__enter__": [7, 19], "__exit__": [7, 19], "__fields__": [3, 23, 24], "__global__": 17, "__init__": [0, 2, 3, 4, 6, 7, 8, 10, 12, 13, 14, 16, 18, 19, 23, 26], "__module__": 17, "__name__": 17, "__qualname__": 17, "__str__": [3, 6], "_exc_tb": 19, "_exc_typ": 19, "_exc_val": 19, "_guild_avail": 0, "_p": 17, "_r": 17, "_transport": 0, "abc": [0, 13, 14], "abl": 0, "about": [3, 12, 23, 24], "abstract": [0, 14, 15], "abstractcommanderrorhandl": [0, 7, 13, 14, 15], "abstracteventloop": [4, 26], "accept": [17, 18], "access": 18, "acquir": 19, "across": [0, 3, 20, 23], "act": 7, "action": 0, "activ": 19, "actual": 0, "ad": [0, 1, 3, 7, 18, 20, 23], "add": [0, 3, 10, 12, 23], "add_cog": [2, 3], "add_command": [2, 3], "add_lin": [2, 3, 7, 23], "add_rol": 21, "addit": 0, "after": [0, 3, 18, 23, 26], "again": 1, "aid": [3, 23], "aiodn": 0, "aiohttp": [0, 3, 6, 24], "alia": [3, 7, 12], "alias": [3, 7], "all": [0, 1, 3, 4, 7, 14, 16, 19, 20, 26], "all_command": 3, "all_extens": [2, 3], "allow": [0, 1, 3, 18, 22, 23, 24], "allow_mod": 22, "allowed_emoji": 22, "allowed_rol": [0, 1, 3, 18, 22, 23], "allowed_us": [0, 18, 22], "alpha": 0, "alreadi": [3, 23, 26], "also": [0, 3, 7, 17, 18, 19, 23], "alwai": 10, "among": 19, "amount": [3, 23], "an": [0, 1, 3, 4, 6, 7, 8, 9, 10, 14, 15, 17, 19, 20, 23, 24, 26], "ani": [3, 6, 10, 17, 19, 23, 25, 26], "annot": [3, 17, 23, 24], "anymor": [3, 23], "anyth": [1, 24], "api": [0, 3, 6, 21], "api_cli": [0, 2, 3], "apicli": [0, 2, 3, 6], "app": [0, 3, 14, 15], "appear": 3, "append": [3, 23], "appli": [3, 7, 8, 10, 12, 19, 23, 24], "applic": 1, "apply_monkey_patch": [0, 2, 3, 7], "approach": 1, "april": 0, "ar": [0, 1, 3, 8, 17, 18, 22, 23, 25], "arg": [3, 12, 17, 19, 20], "arg_offset": 8, "args_preprocessor": 12, "argument": [6, 7, 8, 11, 12, 17, 19, 20, 21], "around": 6, "assign": 17, "async": [0, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 21, 23, 24], "async_rediscach": [0, 3], "async_stat": [2, 3], "asynccach": [3, 7, 8], "asyncio": [0, 4, 26], "asyncresolv": 0, "asyncstatscli": [2, 3, 4], "asyncstatsdcli": 0, "attach": 0, "attempt": [0, 3, 9, 19, 21, 23], "attr": 0, "attribut": [0, 7, 17], "august": 0, "authent": 6, "author": [3, 10, 22, 23], "auto": 0, "auto_mod": 0, "autogener": 0, "automat": [0, 3, 23], "avail": [0, 3, 14, 16, 19], "avoid": [0, 3, 23], "await": [0, 3, 12, 18, 19, 21, 23], "awar": [0, 26], "back": 0, "backtick": [3, 23], "bad": 0, "badargu": 11, "base": [0, 3, 4, 6, 8, 10, 12, 14, 15, 16, 17, 18, 19, 20, 23, 24, 26], "basemodel": [3, 23, 24], "basic": [0, 18], "becaus": [3, 17], "becom": [3, 19], "been": [0, 3], "befor": [0, 3, 10, 18, 19, 23, 26], "before_invok": 10, "behav": 17, "behavior": 10, "behaviour": [0, 3], "being": [0, 7, 10, 21], "belong": 3, "below": [1, 19], "best": [3, 23], "between": [0, 1, 17], "bind": [3, 17], "block": [0, 3, 12, 23, 25], "block_duplicate_invoc": [3, 7, 12], "bodi": 0, "boilerpl": 0, "bool": [3, 6, 9, 10, 12, 14, 15, 18, 19, 22, 23, 26], "bot": [0, 1, 3, 7, 9, 22], "bot_token": 1, "botbas": [0, 2, 3], "both": [0, 1, 3, 24], "boundari": [3, 23], "break": [0, 3, 17, 23], "broke": 0, "buckettyp": 10, "bug": 0, "bump": 0, "button": [0, 18], "buttonstyl": 18, "bypass": 10, "bypass_rol": 10, "byte": 24, "cach": [0, 3, 7, 9, 21], "calcul": 26, "call": [0, 3, 12, 17, 26], "call_without_cooldown": [7, 12], "callabl": [8, 10, 12, 17, 19, 21], "callback": [7, 10, 18], "can": [0, 1, 3, 10, 18, 19, 20, 23, 26], "cancel": [7, 26], "cancel_al": [7, 26], "cannot": [0, 3, 19, 23], "capabl": [14, 16], "captur": [0, 17, 25], "carri": 18, "case": [0, 3, 23], "categori": [9, 10], "category_id": 9, "caus": [3, 7, 23], "certain": [0, 1], "chang": [0, 1, 3, 17, 23], "changelog": 2, "changeset": 0, "channel": [0, 3, 7, 10, 12], "channel_id": 9, "charact": [0, 3, 23], "chardet": 0, "check": [0, 3, 6, 7, 9, 12, 13, 18, 22, 26], "checkfailur": 10, "choos": [14, 16], "chunk": 0, "ci": 0, "class": [0, 3, 4, 6, 8, 12, 14, 15, 16, 18, 19, 20, 23, 24, 26], "classmethod": [3, 23], "classvar": [3, 23, 24], "clean": [0, 11], "clean_text_or_repli": [3, 7, 11], "clear": [2, 3, 7, 8, 19], "click": 18, "client": [0, 3, 4], "clientrespons": 6, "clientsess": [3, 6, 24], "close": [0, 2, 3, 6, 26], "cloudflar": 7, "code": [0, 1, 3, 6, 19, 23, 25], "codepoint": [3, 23], "cog": [0, 3, 5], "collect": 10, "collis": 19, "com": [0, 24], "comma": 1, "command": [0, 1, 3, 7, 9, 10, 12, 13, 15, 16, 17, 19, 23], "command_wrap": [3, 7, 17], "commanderror": 12, "commanderrormanag": [0, 7, 13, 14, 16], "commandinvokeerror": 0, "commandoncooldown": [3, 7, 12], "commit": 0, "common": [0, 1, 3, 7, 20, 25], "commun": [3, 4], "compos": 1, "comput": [3, 23, 24], "computedfieldinfo": [3, 23, 24], "concurr": 0, "config": [0, 3, 23, 24], "configdict": [3, 23, 24], "configur": [1, 3, 23, 24], "conflict": 17, "conform": [3, 23, 24], "connect": [0, 3, 4], "connector": 3, "constructor": [3, 6], "contain": [1, 3, 10, 18, 23, 24, 26], "content": [0, 3, 11, 23, 24], "context": [3, 10, 11, 14, 15, 19, 23], "context_or_interact": [14, 16], "contextcheckfailur": [3, 7, 10], "continu": [3, 23], "control": 0, "cooldown": [3, 7, 10], "cooldown_dur": 12, "cooldown_with_role_bypass": [3, 7, 10], "copi": [1, 17], "core": [0, 1], "coro": [19, 21, 26], "coroutin": [8, 19, 21, 26], "correct": [0, 1], "correspond": [3, 23, 24], "could": [0, 21], "count": 19, "crash": 0, "creat": [0, 3, 4, 8, 12, 17, 23, 26], "create_datagram_endpoint": 4, "create_socket": [3, 4], "create_task": [3, 7, 26], "creation": 0, "criteria": 0, "ctx": [3, 10, 11, 18, 23], "current": [0, 3, 19, 23, 26], "custom": [0, 8, 20], "customlogg": [3, 7, 20], "cut": 0, "d": [1, 17], "dai": 0, "data": [3, 23, 24], "datetim": 26, "deal": 0, "decemb": 0, "declar": 0, "decor": [0, 8, 10, 12, 17, 19], "decorator_func": 17, "decrement": 19, "default": [0, 1, 3, 10, 14, 16, 17, 23, 24], "defin": [3, 23, 24], "delai": 26, "delet": [0, 3, 6, 8, 18, 23, 24], "deletemessagebutton": [0, 3, 7, 18], "depend": [0, 9], "deprec": 0, "describ": 10, "detail": 17, "detect": 0, "determin": [14, 15, 16], "dev": [1, 3], "develop": [0, 2, 3, 7], "dict": [3, 6, 17, 23, 24], "dictat": 0, "dictionari": [3, 23, 24], "did": 0, "directli": [0, 17], "directori": 1, "discord": [0, 1, 3, 5, 7, 9, 10, 11, 13, 14, 16, 17, 21, 23, 25], "discord_invit": [0, 3, 7, 25], "disnak": 0, "distinguish": 26, "django": 6, "dm": 10, "do": [0, 1, 9, 19], "doc": [0, 19], "docker": 1, "docstr": 0, "document": 0, "doe": [0, 17], "doesn": [3, 10, 26], "don": [0, 10, 26], "done": [3, 18, 23, 26], "drop": 0, "due": 0, "dummi": [0, 3], "duplic": [0, 12], "durat": 10, "dynam": 0, "e": [3, 23], "each": [0, 3, 23], "edit": 3, "effort": [3, 23], "either": [0, 3], "els": 11, "elsewher": 26, "emb": [0, 3, 23], "emit": 3, "emoji": [0, 3, 22, 23], "empti": [3, 23], "emptypaginatorembederror": [2, 3, 7, 23], "enabl": [0, 1], "encount": 24, "end": [3, 23], "endpoint": 6, "ensur": [0, 3, 18, 25], "entir": [0, 3], "env": 1, "environ": [0, 1], "equival": 6, "error": [0, 3, 6, 7, 13, 14, 15, 16, 21, 24], "error_handl": [0, 3, 7], "etc": [1, 10], "evalu": 17, "even": 22, "event": [0, 3, 4, 19, 26], "event_loop": 26, "everi": [3, 23], "exact": 1, "exampl": [3, 23], "exc_info": 20, "exce": [3, 8, 23], "exceed": [3, 23], "except": [3, 6, 10, 12, 14, 16, 17, 19, 20, 23, 24, 26], "exception_on_empty_emb": [3, 23], "excess": [3, 23], "exclus": 19, "execut": [19, 26], "exist": [0, 1, 26], "exit": 19, "expect": 21, "expiri": 0, "explain": 0, "expos": 19, "express": 25, "ext": [0, 2, 3, 7, 9, 10, 11, 23], "extend": 0, "extens": [0, 3], "extra": [0, 6], "extract": 0, "facilit": 0, "fail": [9, 10, 24], "fail_sil": 10, "failur": 21, "fakeredi": 0, "fals": [3, 10, 12, 19, 23, 24], "featur": [0, 1, 3], "februari": 0, "fetch": [9, 21], "few": 1, "field": [3, 23, 24], "fieldinfo": [3, 23, 24], "fifo": 8, "file": [0, 1, 24], "filter": 0, "finish": [3, 19, 23], "first": [3, 14, 16, 23], "five": [3, 23], "fix": 0, "float": [10, 12, 18, 26], "folder": 1, "footer": [3, 23], "footer_text": [3, 23], "forbidden": [0, 9, 13], "format": [24, 25], "formatt": 20, "formatted_code_regex": [3, 7, 25], "forum": 0, "forwardref": 17, "found": [3, 17, 21, 26], "free": 1, "from": [0, 1, 3, 4, 6, 7, 9, 17, 18, 21, 23, 24, 26], "frozenset": [3, 17], "func": [17, 19], "function": [0, 3, 7, 8, 9, 12, 19, 20, 21, 23, 26], "functool": 17, "futur": [10, 26], "g": [3, 23], "gatewai": 3, "gener": [0, 3, 12, 26], "get": [0, 3, 6, 9, 17, 21], "get_arg_valu": [3, 7, 17], "get_arg_value_wrapp": [3, 7, 17], "get_bound_arg": [3, 7, 17], "get_logg": [3, 7, 20], "get_or_fetch_channel": [0, 3, 7, 9], "get_or_fetch_memb": [0, 3, 7, 21], "git": 1, "github": 0, "give": 3, "given": [0, 3, 4, 7, 9, 11, 17, 19, 20, 21, 26], "global": 17, "globalnameconflicterror": [3, 7, 17], "go": [1, 3, 19, 23], "greater": 24, "groundwork": 1, "group": [7, 25], "guild": [0, 1, 3, 10, 21], "guild_available_but_cache_empti": 3, "guild_creat": 3, "guild_id": [1, 2, 3], "guildchannel": 9, "ha": [0, 3, 7, 10, 18], "handl": [0, 13, 14, 15, 16, 21, 26], "handle_app_command_error": [13, 14, 15], "handle_error": [13, 14, 16], "handle_forbidden_from_block": [3, 7, 13], "handle_role_chang": [0, 3, 7, 21], "handle_text_command_error": [13, 14, 15], "handler": [0, 3, 14, 15, 16], "happen": 3, "has_any_role_check": [3, 7, 10], "has_no_roles_check": [3, 7, 10], "hashabl": [19, 26], "have": [0, 9, 10, 17, 20], "heavi": 7, "help": [0, 1], "helper": [0, 9, 12, 21], "hold": [3, 19, 23], "holder": 19, "hook": 0, "host": 4, "houston": 20, "how": [0, 8, 10, 17, 26], "howev": 1, "http": [0, 3, 6, 24, 25], "http_session": [2, 3, 24], "httpexcept": 9, "i": [0, 1, 3, 6, 7, 9, 10, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "icon": [3, 23], "icon_url": [3, 23], "id": [1, 3, 7, 9, 10, 18, 19, 23, 26], "identifi": [19, 26], "ignor": [1, 7, 17, 22], "ignored_conflict_nam": 17, "immedi": 26, "implement": [0, 3, 4, 8, 18, 20], "import": 0, "in_whitelist": 10, "in_whitelist_check": [3, 7, 10], "inadequ": 3, "includ": [0, 1, 13], "incorrect": 0, "increment": 19, "independantli": 0, "index": 2, "indic": [3, 21, 23], "individu": 3, "info": [0, 1], "inform": [2, 19, 20], "init": [0, 3, 4], "initi": [6, 26], "initialis": [3, 8], "input": 18, "insert": [3, 23], "insid": [3, 23], "instal": [0, 1], "instanc": [0, 3, 6, 8, 9, 10, 20, 26], "instanti": [3, 18, 26], "instead": [3, 12, 26], "int": [3, 4, 8, 9, 10, 17, 18, 23, 24], "intend": 21, "intent": 1, "interact": [0, 3, 7, 9, 14, 15, 23], "interactin": 21, "interaction_check": [7, 18], "interest": 20, "intern": [3, 7, 19], "intersphinx": 0, "introduc": 10, "invalid": 9, "invaliddata": 9, "invit": [0, 25], "invoc": [0, 12], "invok": [1, 10, 12, 18], "inwhitelistcheckfailur": [3, 7, 10], "is_in_categori": [3, 7, 9], "isn": [0, 13, 17], "issu": 10, "item": 8, "iter": [10, 12, 14, 16], "its": [0, 3, 12, 17], "itself": 18, "januari": 0, "json": 6, "juli": 0, "june": 0, "just": 0, "keep": [3, 23, 26], "kei": 8, "keyword": [6, 7, 17, 20], "known": 26, "kwarg": [3, 6, 12, 17, 18, 20, 26], "label": [0, 18], "lancebot": 1, "larg": 24, "larger": 24, "last": [3, 10, 18, 23], "latest": 0, "lead": 0, "least": 10, "left": [3, 23], "length": [3, 12, 23], "level": [0, 7, 20], "lexer": [0, 24], "librari": [0, 1], "like": [1, 17], "limit": [3, 23], "line": [3, 23], "linepagin": [0, 2, 3, 7, 23], "linesep": [3, 23], "link": 24, "lint": 0, "list": [0, 1, 3, 18, 23, 24], "listen": 18, "ll": [1, 26], "load": [0, 1, 3, 7], "load_extens": [0, 2, 3], "local": 2, "localhost": 4, "lock": [0, 3, 7], "lock_arg": [3, 7, 19], "lockedresourceerror": [3, 7, 19], "log": [0, 3, 7, 13, 21, 26], "log_format": [0, 3, 7, 20], "log_to_dev_log": [2, 3], "logger": [0, 20], "logic": 0, "long": [10, 24, 26], "longer": [0, 18], "look": [17, 26], "loop": [4, 26], "lot": 0, "lru": 8, "lua": 0, "lupa": 0, "m": 1, "machin": 1, "made": [0, 22], "mai": [0, 3, 8, 19, 23], "main": 0, "make": [0, 1, 3, 20, 23], "manag": [0, 3, 13, 14, 19], "mani": [0, 3, 8], "manipul": [0, 17], "manual": 3, "map": [3, 17, 19, 23, 24], "march": 0, "mark": 0, "match": [0, 3, 17], "max": 24, "max_length": 24, "max_lin": [3, 23], "max_paste_s": [3, 7, 24], "max_siz": [3, 8, 23, 24], "maximum": [3, 8, 23, 24], "maybe_raise_for_statu": [3, 6], "mean": 1, "meant": 0, "member": [0, 3, 7, 18], "member_id": 21, "mention": [1, 3], "messag": [0, 3, 7, 11, 12, 13, 18, 20, 23, 26], "message_id": 22, "message_typ": 0, "metadata": [3, 23, 24], "method": [0, 4, 6, 7, 20], "metric": 3, "might": [1, 3, 10], "migrat": 0, "minut": [3, 23], "miss": 0, "mod": 0, "model": [3, 23, 24], "model_computed_field": [2, 3, 7, 23, 24], "model_config": [2, 3, 7, 23, 24], "model_field": [2, 3, 7, 23, 24], "moder": [3, 18, 22, 23], "modifi": [1, 21], "modul": [0, 3, 7, 17, 26], "monitor": 1, "monkei": [0, 7], "month": 0, "more": [0, 1, 3, 17, 19, 23], "most": 1, "move": 0, "msg": 20, "multipl": 0, "multivers": 0, "must": [0, 17, 19, 26], "mutual": 19, "mypi": 20, "n": [3, 23], "name": [3, 7, 17, 19, 20, 23, 24, 26], "name_or_po": [17, 19], "namespac": [0, 19, 26], "navig": [0, 1, 3, 23], "na\u00efv": 26, "need": [0, 1, 3, 23], "new": [0, 1, 3, 4, 6, 8, 17, 23, 26], "newer": 0, "newli": 0, "next": [3, 23], "non": 6, "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 26], "noreturn": [14, 15], "normal": 3, "notabl": 0, "note": [0, 10], "notfound": 9, "notic": 0, "notifi": 12, "novemb": 0, "now": [0, 1, 26], "number": [0, 3, 10, 23, 24], "object": [3, 6, 7, 8, 9, 12, 14, 16, 19, 21, 23, 24, 26], "occur": 18, "octob": 0, "offset": 8, "ok": 6, "older": 0, "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "on_readi": 3, "on_timeout": [7, 18], "onc": [0, 3, 8], "one": [0, 3, 10, 14, 16, 23], "ones": 1, "onli": [0, 3], "onto": [3, 23], "oper": [3, 19, 23, 26], "option": [0, 8, 17, 19], "order": [3, 8, 14, 16, 17, 19, 23, 26], "ordereddict": [17, 19], "origin": [0, 18], "other": [0, 1, 19, 26], "otherwis": [10, 19, 26], "our": [0, 1, 7], "out": [0, 1, 3, 18], "output": 25, "over": [0, 3, 23], "overflow": [3, 23], "overrid": [3, 23], "overwrit": [0, 3], "own": [0, 17], "p": [3, 7, 12], "packag": [0, 3, 7], "page": [2, 3, 23], "pagin": [0, 2, 3, 7], "pagination_emoji": [3, 23], "paginationemoji": [2, 3, 7, 23], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 17, 18, 19, 20, 21, 23, 24, 26], "paramspec": [12, 17], "parent": [0, 18], "pars": 25, "pass": [0, 3, 6, 17, 20, 21, 26], "past": [0, 24, 26], "paste_servic": [0, 3, 7], "paste_url": 24, "pastebin": 0, "pastefil": [0, 3, 7, 24], "pasterespons": [3, 7, 24], "pastetoolongerror": [3, 7, 24], "pasteunsupportedlexererror": [3, 7, 24], "pasteuploaderror": [3, 7, 24], "patch": [0, 3, 6, 7], "path": 1, "pattern": 25, "per": [3, 10, 23], "perform": 19, "permiss": [0, 9], "ping": 3, "ping_servic": [0, 2, 3], "pip": 1, "place": [3, 23], "pleas": 25, "poetri": [0, 1], "popul": 3, "port": [0, 4], "posit": [8, 17, 19], "possibl": 1, "post": [3, 6, 24], "pre": 1, "predic": [0, 14, 15], "prefix": [1, 3, 4, 23], "prematur": 26, "press": 0, "prevent": [12, 19, 26], "previous": 0, "prioriti": [14, 16], "privatechannel": [0, 9], "problem": [10, 20], "process": [0, 3], "process_command": [0, 2, 3], "program": 1, "project": [0, 1, 20], "provid": [0, 1, 3, 8, 11, 13, 23, 26], "public": 0, "publish": 0, "purpos": 21, "push": 0, "put": [3, 6], "py": [0, 3, 17], "pydant": [0, 3, 23, 24], "pydi": [0, 2], "pydis_cor": [0, 1, 3, 18, 20], "pypi": 0, "pyproject": [0, 1], "python": [0, 1, 3, 24, 26], "pythondiscord": [0, 24], "qualifi": 7, "quot": 25, "r": [3, 7, 12], "rais": [3, 6, 9, 10, 11, 12, 13, 14, 15, 17, 19, 21, 23, 24, 26], "raise_error": 19, "raise_for_statu": 6, "rate": 10, "rather": 7, "raw": [12, 25], "raw_code_regex": [3, 7, 25], "rc2": 0, "re": [1, 3, 13, 22, 26], "reach": 19, "reaction": [0, 3, 22, 23], "reaction_check": [0, 3, 7, 22], "read": 0, "readi": 3, "real": 0, "reason": [3, 23], "receiv": [0, 6, 9], "recognis": 20, "reconnect": 0, "redi": [0, 3], "redirect": 10, "redirect_channel": 10, "redis_sess": [2, 3], "rediscach": 0, "redissess": 3, "refer": 0, "referenc": 0, "reflect": 17, "regex": [0, 3, 7], "regist": [0, 14, 16], "register_command_error_manag": [2, 3], "register_handl": [13, 14, 16], "registr": [3, 14, 16], "regular": 25, "reinstal": 1, "reject": 24, "relat": [8, 14, 16, 20], "releas": 0, "relev": 3, "reli": 0, "remain": [3, 23], "remov": [0, 3, 18, 22, 23, 24], "remove_command": [2, 3], "remove_rol": 21, "renam": 0, "replac": [3, 10, 17, 23, 24], "repli": [3, 11, 12, 13, 23], "repo": 0, "represent": 6, "request": [0, 3, 6, 25], "requir": [0, 1, 3, 23, 24, 26], "resolut": 0, "resolv": [3, 17], "resourc": 19, "resource_id": 19, "resource_typ": 19, "respons": [0, 6, 24], "response_json": 6, "response_text": 6, "responsecodeerror": [2, 3, 6], "restor": 0, "restrict": [0, 3, 23], "restrict_to_us": [3, 23], "result": [0, 26], "retriev": 9, "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "reusabl": 5, "revert": 0, "right": [0, 3, 23], "role": [0, 1, 3, 10, 18, 21, 22, 23], "root": [1, 3, 7], "root_alias": 7, "rout": 7, "ruff": 0, "rule": 0, "run": [0, 1, 12, 19, 26], "runtimeerror": 19, "safe": 0, "same": [12, 26], "sampl": 0, "sanitis": 25, "save": [0, 3, 24], "scale": [3, 23], "scale_to_s": [3, 23], "schedul": [0, 3, 7], "schedule_at": [7, 26], "schedule_lat": [7, 26], "script": 0, "search": 2, "second": [3, 10, 12, 18, 23, 26], "secondari": 18, "see": [0, 1, 17, 18, 19], "self": [0, 3, 18], "send": [0, 3, 6, 18, 23], "send_notic": 12, "send_to_paste_servic": [0, 3, 7, 24], "send_typ": 7, "seper": 1, "septemb": 0, "sequenc": [3, 7, 17, 18, 23], "serv": [3, 23], "server": [3, 25], "servic": [0, 1, 3, 24], "session": [0, 3, 6, 24], "session_kwarg": 6, "set": [0, 1, 3, 12, 17, 18, 19, 23], "set_author": [3, 23], "setup": [0, 3], "setup_hook": [2, 3], "sever": 20, "share": [0, 17], "sharedev": [3, 7, 19], "should": [0, 1, 3, 6, 14, 15, 18, 23, 24], "should_handle_error": [13, 14, 15, 16], "should_rais": 6, "signatur": 12, "silent": 10, "similar": [18, 25], "sinc": 10, "singl": [0, 3, 23], "sir": 1, "site": [0, 3, 6], "site_api": [0, 2, 3], "site_api_token": 6, "site_api_url": 6, "size": [3, 8, 23, 24], "so": [0, 1, 3, 7], "socket": 4, "sole": 21, "some": [0, 3, 23, 24], "someth": 25, "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26], "specif": [0, 10], "specifi": [0, 10, 12, 18], "sphinx": 0, "split": 0, "stabl": 0, "standardis": [0, 20], "start": [0, 3, 26], "startup": 3, "startuperror": [2, 3], "stat": [0, 2, 3, 4], "state": 17, "static": 6, "statsclientbas": 4, "statsd": [0, 3, 4], "statsd_url": [0, 2, 3], "step": 1, "still": [3, 23], "stop": [0, 7, 18], "store": [0, 3, 7, 8, 23], "str": [3, 4, 6, 7, 10, 11, 17, 18, 19, 20, 23, 24, 26], "string": [0, 6], "style": 18, "sub": [0, 3], "submodul": [2, 13], "subpackag": 2, "subtract": 26, "success": [0, 24], "suffix": [3, 23], "suggest": 26, "support": [0, 4, 7, 26], "suppressed_except": 26, "sure": 1, "switch": [3, 23], "sync": [0, 3], "sync_app_command": 3, "system": [0, 1, 14, 16], "t": [0, 3, 10, 11, 13, 17, 19, 26], "target": [0, 8], "task": [0, 26], "task_id": 26, "task_return": 26, "templat": 1, "test": 2, "text": [0, 3, 6, 11, 14, 15, 23, 24], "textchannel": 9, "than": [7, 24], "thei": [3, 17, 22], "them": [1, 3, 17, 26], "thi": [0, 1, 3, 7, 9, 10, 12, 17, 18, 19, 21, 23, 24, 25, 26], "thread": [0, 9], "three": [3, 23], "through": [14, 16, 19], "thrown": 7, "thu": 3, "tild": 0, "time": [0, 10, 26], "timeout": [0, 3, 18, 23], "timezon": 26, "token": [1, 6], "toml": [0, 1], "too": 24, "tool": [3, 7], "top": 7, "total": [3, 23], "trace": [0, 7, 20], "track": 26, "transport": 4, "trashcan": [3, 23], "tree": 3, "trigger": 10, "true": [3, 6, 10, 12, 19, 20, 22, 23, 24, 26], "truncat": [3, 23], "tupl": [17, 26], "turn": 19, "two": 7, "type": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26], "type_": 10, "typeerror": [10, 17], "typehint": 17, "typevar": [12, 17, 26], "u": [0, 3, 23], "ui": 18, "unavail": 3, "unawait": 26, "under": 7, "underli": 19, "union": 10, "uniqu": 26, "unknown": 9, "unqualifi": [0, 2, 3, 7], "unschedul": 26, "unsupport": 24, "unti": [3, 23], "until": [0, 3, 19, 25], "up": [0, 1, 3, 23], "updat": [0, 17], "update_wrapper_glob": [3, 7, 17], "upload": [0, 24], "upon": 0, "url": [0, 3, 6, 23, 24], "urllib": 25, "us": [0, 1, 3, 4, 6, 7, 9, 10, 12, 17, 19, 20, 21, 23, 24, 25, 26], "usag": 0, "user": [0, 3, 10, 12, 18, 22, 23], "user_has_access": [0, 3, 7, 18], "utc": 26, "util": [0, 1, 2, 3, 8, 17, 18, 20], "v1": [0, 3, 23, 24], "valid": 0, "valu": [12, 17, 19, 20], "valueerror": [6, 17, 24], "vari": 1, "variabl": 1, "variou": [0, 9], "verifi": 10, "version": [0, 11], "view": [0, 18], "viewwithuserandrolecheck": [0, 3, 7, 18], "wa": [0, 9, 10, 26], "wait": [0, 3, 7, 19, 26], "wait_until_guild_avail": [2, 3], "want": 1, "warn": [0, 26], "wasn": 11, "we": [20, 21], "websocket": 0, "were": 3, "what": 1, "when": [0, 3, 4, 6, 7, 8, 10, 12, 17, 19, 23, 24, 26], "where": 10, "whether": [0, 3, 6, 9, 10, 14, 15, 18, 23], "which": [0, 1, 3, 7, 10, 12, 17, 19, 23, 26], "while": [3, 12, 19, 23], "whitelist": 10, "whitespac": [0, 25], "who": [0, 18], "whom": [3, 23], "within": [0, 3], "without": [0, 10], "won": 17, "word": [3, 23], "work": [0, 1], "worker": 7, "workflow": 0, "would": [3, 23], "wrap": [8, 17, 26], "wrapper": [0, 6, 12, 17, 26], "write": [0, 1], "wrong": 0, "www": 0, "x": 0, "you": [0, 1, 9, 25], "your": 1}, "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Pydis Core", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "checks", "commands", "cooldown", "error_handling package", "commands package", "abc", "manager", "function", "interactions", "lock", "logging", "members", "messages", "pagination", "paste_service", "regex", "scheduling"], "titleterms": {"1": 1, "2": 1, "abc": 15, "async_stat": 4, "bot": 2, "cach": 8, "changelog": 0, "channel": 9, "check": 10, "command": [11, 14], "cooldown": 12, "core": [2, 3], "develop": 1, "document": 2, "error_handl": 13, "ext": 5, "extra": 2, "function": 17, "interact": 18, "local": 1, "lock": 19, "log": 20, "manag": 16, "member": 21, "messag": 22, "modul": 2, "option": 1, "packag": [13, 14], "pagin": 23, "paste_servic": 24, "project": 2, "pydi": 3, "refer": 2, "regex": 25, "schedul": 26, "site_api": 6, "submodul": [3, 7, 14], "subpackag": [3, 7, 13], "test": 1, "util": 7}}) \ No newline at end of file diff --git a/main/versions.html b/main/versions.html index 2647b576..030b4ef1 100644 --- a/main/versions.html +++ b/main/versions.html @@ -5,7 +5,7 @@ - Versions - Pydis Core Latest (11.1.0) + Versions - Pydis Core Latest (11.2.0) @@ -182,7 +182,7 @@
    -
    Pydis Core Latest (11.1.0)
     +
    Pydis Core Latest (11.2.0)
    @@ -209,7 +209,7 @@
    - Pydis Core Latest (11.1.0) + Pydis Core Latest (11.2.0) @@ -660,7 +660,7 @@
    - + diff --git a/v10.0.0/.buildinfo b/v10.0.0/.buildinfo index 6c869359..c06a4a15 100644 --- a/v10.0.0/.buildinfo +++ b/v10.0.0/.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: 9c254839cbd3254457f43acb3ae38940 +config: 6b0e0eed202b7d0e7f96a910fd190027 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v10.0.0/_static/pygments.css b/v10.0.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v10.0.0/_static/pygments.css +++ b/v10.0.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v10.0.0/changelog.html b/v10.0.0/changelog.html index b9505bd8..7bbebf27 100644 --- a/v10.0.0/changelog.html +++ b/v10.0.0/changelog.html @@ -447,7 +447,7 @@

    10.0.0 14th July 2023

    diff --git a/v10.0.0/output/pydis_core.html b/v10.0.0/output/pydis_core.html index a4c40115..726f1da6 100644 --- a/v10.0.0/output/pydis_core.html +++ b/v10.0.0/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -580,7 +580,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v10.0.0/output/pydis_core.utils.channel.html b/v10.0.0/output/pydis_core.utils.channel.html index 42c916e5..8a127b60 100644 --- a/v10.0.0/output/pydis_core.utils.channel.html +++ b/v10.0.0/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v10.0.0/output/pydis_core.utils.commands.html b/v10.0.0/output/pydis_core.utils.commands.html index 60aecbe7..3cea060a 100644 --- a/v10.0.0/output/pydis_core.utils.commands.html +++ b/v10.0.0/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v10.0.0/output/pydis_core.utils.cooldown.html b/v10.0.0/output/pydis_core.utils.cooldown.html index a1762c21..f7f9b468 100644 --- a/v10.0.0/output/pydis_core.utils.cooldown.html +++ b/v10.0.0/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v10.0.0/output/pydis_core.utils.error_handling.html b/v10.0.0/output/pydis_core.utils.error_handling.html index 4fac8dad..c32bb254 100644 --- a/v10.0.0/output/pydis_core.utils.error_handling.html +++ b/v10.0.0/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v10.0.0/output/pydis_core.utils.html b/v10.0.0/output/pydis_core.utils.html index 1e220972..f658ee7c 100644 --- a/v10.0.0/output/pydis_core.utils.html +++ b/v10.0.0/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v10.0.0/output/pydis_core.utils.interactions.html b/v10.0.0/output/pydis_core.utils.interactions.html index d1ceb3c5..ba3781a8 100644 --- a/v10.0.0/output/pydis_core.utils.interactions.html +++ b/v10.0.0/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v10.0.0/output/pydis_core.utils.members.html b/v10.0.0/output/pydis_core.utils.members.html index 173f7323..9de2a96d 100644 --- a/v10.0.0/output/pydis_core.utils.members.html +++ b/v10.0.0/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v10.1.0/.buildinfo b/v10.1.0/.buildinfo index d34b153a..629beeef 100644 --- a/v10.1.0/.buildinfo +++ b/v10.1.0/.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: a0d98a8e3f8ea3d440d75b150af86912 +config: 35665a1bb343262893b36ff1e80214f6 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v10.1.0/_static/pygments.css b/v10.1.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v10.1.0/_static/pygments.css +++ b/v10.1.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v10.1.0/changelog.html b/v10.1.0/changelog.html index 40d9a77f..334b51d9 100644 --- a/v10.1.0/changelog.html +++ b/v10.1.0/changelog.html @@ -445,14 +445,14 @@

    Changelog¶

    10.1.0 25th July 2023

    10.0.0 14th July 2023

    diff --git a/v10.1.0/output/pydis_core.html b/v10.1.0/output/pydis_core.html index 5abe2931..c3ee527a 100644 --- a/v10.1.0/output/pydis_core.html +++ b/v10.1.0/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -592,7 +592,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v10.1.0/output/pydis_core.utils.channel.html b/v10.1.0/output/pydis_core.utils.channel.html index 8bc44ab8..adda7a3d 100644 --- a/v10.1.0/output/pydis_core.utils.channel.html +++ b/v10.1.0/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v10.1.0/output/pydis_core.utils.commands.html b/v10.1.0/output/pydis_core.utils.commands.html index c6e0e39e..c763d5af 100644 --- a/v10.1.0/output/pydis_core.utils.commands.html +++ b/v10.1.0/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v10.1.0/output/pydis_core.utils.cooldown.html b/v10.1.0/output/pydis_core.utils.cooldown.html index 809205e3..a7954878 100644 --- a/v10.1.0/output/pydis_core.utils.cooldown.html +++ b/v10.1.0/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v10.1.0/output/pydis_core.utils.error_handling.html b/v10.1.0/output/pydis_core.utils.error_handling.html index f73bf3b5..afc305dd 100644 --- a/v10.1.0/output/pydis_core.utils.error_handling.html +++ b/v10.1.0/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v10.1.0/output/pydis_core.utils.html b/v10.1.0/output/pydis_core.utils.html index 6f37fcbd..27aa7938 100644 --- a/v10.1.0/output/pydis_core.utils.html +++ b/v10.1.0/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v10.1.0/output/pydis_core.utils.interactions.html b/v10.1.0/output/pydis_core.utils.interactions.html index 4bf512a4..36542bc6 100644 --- a/v10.1.0/output/pydis_core.utils.interactions.html +++ b/v10.1.0/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v10.1.0/output/pydis_core.utils.members.html b/v10.1.0/output/pydis_core.utils.members.html index 80c65867..c1b434f0 100644 --- a/v10.1.0/output/pydis_core.utils.members.html +++ b/v10.1.0/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v10.2.0/.buildinfo b/v10.2.0/.buildinfo index 524b761e..bb8034c0 100644 --- a/v10.2.0/.buildinfo +++ b/v10.2.0/.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: bb7f4a367c2e3e78c53a35a3ab42acb0 +config: ef7b24dce75e647b3cda2c66b7a1d162 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v10.2.0/_static/pygments.css b/v10.2.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v10.2.0/_static/pygments.css +++ b/v10.2.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v10.2.0/changelog.html b/v10.2.0/changelog.html index c97fbe17..68f17756 100644 --- a/v10.2.0/changelog.html +++ b/v10.2.0/changelog.html @@ -450,14 +450,14 @@

    10.1.0 25th July 2023

    10.0.0 14th July 2023

    diff --git a/v10.2.0/output/pydis_core.html b/v10.2.0/output/pydis_core.html index 2af18caf..1b79d1dd 100644 --- a/v10.2.0/output/pydis_core.html +++ b/v10.2.0/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -592,7 +592,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v10.2.0/output/pydis_core.utils.channel.html b/v10.2.0/output/pydis_core.utils.channel.html index 353799df..a6beeb52 100644 --- a/v10.2.0/output/pydis_core.utils.channel.html +++ b/v10.2.0/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v10.2.0/output/pydis_core.utils.commands.html b/v10.2.0/output/pydis_core.utils.commands.html index ba5c80ba..126a5621 100644 --- a/v10.2.0/output/pydis_core.utils.commands.html +++ b/v10.2.0/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v10.2.0/output/pydis_core.utils.cooldown.html b/v10.2.0/output/pydis_core.utils.cooldown.html index a2ea4a2f..e221cb42 100644 --- a/v10.2.0/output/pydis_core.utils.cooldown.html +++ b/v10.2.0/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v10.2.0/output/pydis_core.utils.error_handling.html b/v10.2.0/output/pydis_core.utils.error_handling.html index 1c8127aa..9e150873 100644 --- a/v10.2.0/output/pydis_core.utils.error_handling.html +++ b/v10.2.0/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v10.2.0/output/pydis_core.utils.html b/v10.2.0/output/pydis_core.utils.html index a08f384b..cc55d40f 100644 --- a/v10.2.0/output/pydis_core.utils.html +++ b/v10.2.0/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v10.2.0/output/pydis_core.utils.interactions.html b/v10.2.0/output/pydis_core.utils.interactions.html index 085c5100..e3ac2cc1 100644 --- a/v10.2.0/output/pydis_core.utils.interactions.html +++ b/v10.2.0/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v10.2.0/output/pydis_core.utils.members.html b/v10.2.0/output/pydis_core.utils.members.html index 9f6ea2f7..8e8eaebc 100644 --- a/v10.2.0/output/pydis_core.utils.members.html +++ b/v10.2.0/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v10.3.0/.buildinfo b/v10.3.0/.buildinfo index f1168884..d9a4c4c0 100644 --- a/v10.3.0/.buildinfo +++ b/v10.3.0/.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: b4e1e5a6d54460418d6458fb9ba23a10 +config: a27cf85598abbdc95305eae41e0d38db tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v10.3.0/_static/pygments.css b/v10.3.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v10.3.0/_static/pygments.css +++ b/v10.3.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v10.3.0/changelog.html b/v10.3.0/changelog.html index 53a28927..942fa2ef 100644 --- a/v10.3.0/changelog.html +++ b/v10.3.0/changelog.html @@ -456,14 +456,14 @@

    10.1.0 25th July 2023

    10.0.0 14th July 2023

    diff --git a/v10.3.0/output/pydis_core.html b/v10.3.0/output/pydis_core.html index c82a981c..4a1276a7 100644 --- a/v10.3.0/output/pydis_core.html +++ b/v10.3.0/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -592,7 +592,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v10.3.0/output/pydis_core.utils.channel.html b/v10.3.0/output/pydis_core.utils.channel.html index ed0876dd..3beb6953 100644 --- a/v10.3.0/output/pydis_core.utils.channel.html +++ b/v10.3.0/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v10.3.0/output/pydis_core.utils.commands.html b/v10.3.0/output/pydis_core.utils.commands.html index f0018a53..dfdebe77 100644 --- a/v10.3.0/output/pydis_core.utils.commands.html +++ b/v10.3.0/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v10.3.0/output/pydis_core.utils.cooldown.html b/v10.3.0/output/pydis_core.utils.cooldown.html index 328fe81d..cc73d297 100644 --- a/v10.3.0/output/pydis_core.utils.cooldown.html +++ b/v10.3.0/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v10.3.0/output/pydis_core.utils.error_handling.html b/v10.3.0/output/pydis_core.utils.error_handling.html index b11d502a..6a1d7a0a 100644 --- a/v10.3.0/output/pydis_core.utils.error_handling.html +++ b/v10.3.0/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v10.3.0/output/pydis_core.utils.html b/v10.3.0/output/pydis_core.utils.html index 9e044486..7f9d3692 100644 --- a/v10.3.0/output/pydis_core.utils.html +++ b/v10.3.0/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v10.3.0/output/pydis_core.utils.interactions.html b/v10.3.0/output/pydis_core.utils.interactions.html index 6e7ded8a..363a32c6 100644 --- a/v10.3.0/output/pydis_core.utils.interactions.html +++ b/v10.3.0/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v10.3.0/output/pydis_core.utils.members.html b/v10.3.0/output/pydis_core.utils.members.html index 000e3ec4..d5466062 100644 --- a/v10.3.0/output/pydis_core.utils.members.html +++ b/v10.3.0/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v10.4.0/.buildinfo b/v10.4.0/.buildinfo index 19a110d2..315e6eeb 100644 --- a/v10.4.0/.buildinfo +++ b/v10.4.0/.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: c519e31d7b0000950e438496bde627b7 +config: f9d4a8a34aea70db355bc1303e8cc010 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v10.4.0/_static/pygments.css b/v10.4.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v10.4.0/_static/pygments.css +++ b/v10.4.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v10.4.0/changelog.html b/v10.4.0/changelog.html index c11fb922..fb5d9dc6 100644 --- a/v10.4.0/changelog.html +++ b/v10.4.0/changelog.html @@ -462,14 +462,14 @@

    10.1.0 25th July 2023

    10.0.0 14th July 2023

    diff --git a/v10.4.0/output/pydis_core.html b/v10.4.0/output/pydis_core.html index ea88f879..78adceb6 100644 --- a/v10.4.0/output/pydis_core.html +++ b/v10.4.0/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -592,7 +592,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v10.4.0/output/pydis_core.utils.channel.html b/v10.4.0/output/pydis_core.utils.channel.html index 31569530..76af86c2 100644 --- a/v10.4.0/output/pydis_core.utils.channel.html +++ b/v10.4.0/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v10.4.0/output/pydis_core.utils.commands.html b/v10.4.0/output/pydis_core.utils.commands.html index 1a0b8542..d9fc72e2 100644 --- a/v10.4.0/output/pydis_core.utils.commands.html +++ b/v10.4.0/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v10.4.0/output/pydis_core.utils.cooldown.html b/v10.4.0/output/pydis_core.utils.cooldown.html index 702288d6..4d18335d 100644 --- a/v10.4.0/output/pydis_core.utils.cooldown.html +++ b/v10.4.0/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v10.4.0/output/pydis_core.utils.error_handling.html b/v10.4.0/output/pydis_core.utils.error_handling.html index b05c89ab..ad922388 100644 --- a/v10.4.0/output/pydis_core.utils.error_handling.html +++ b/v10.4.0/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v10.4.0/output/pydis_core.utils.html b/v10.4.0/output/pydis_core.utils.html index 683e8171..84c97a89 100644 --- a/v10.4.0/output/pydis_core.utils.html +++ b/v10.4.0/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v10.4.0/output/pydis_core.utils.interactions.html b/v10.4.0/output/pydis_core.utils.interactions.html index 3a32a098..fcf3826b 100644 --- a/v10.4.0/output/pydis_core.utils.interactions.html +++ b/v10.4.0/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v10.4.0/output/pydis_core.utils.members.html b/v10.4.0/output/pydis_core.utils.members.html index 2cf63996..d47c693c 100644 --- a/v10.4.0/output/pydis_core.utils.members.html +++ b/v10.4.0/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v10.5.0/.buildinfo b/v10.5.0/.buildinfo index 67687d73..b84b8584 100644 --- a/v10.5.0/.buildinfo +++ b/v10.5.0/.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: 569863968293e7573b6cd264ec79c0f7 +config: 1dbeb03c6aeb38886bcb457339bd17c9 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v10.5.0/_static/pygments.css b/v10.5.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v10.5.0/_static/pygments.css +++ b/v10.5.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v10.5.0/changelog.html b/v10.5.0/changelog.html index b41142f7..c5bf6699 100644 --- a/v10.5.0/changelog.html +++ b/v10.5.0/changelog.html @@ -467,14 +467,14 @@

    10.1.0 25th July 2023

    10.0.0 14th July 2023

    diff --git a/v10.5.0/output/pydis_core.html b/v10.5.0/output/pydis_core.html index 882b81d7..fc45561b 100644 --- a/v10.5.0/output/pydis_core.html +++ b/v10.5.0/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -592,7 +592,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v10.5.0/output/pydis_core.utils.channel.html b/v10.5.0/output/pydis_core.utils.channel.html index 7ef25133..2eea0433 100644 --- a/v10.5.0/output/pydis_core.utils.channel.html +++ b/v10.5.0/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v10.5.0/output/pydis_core.utils.commands.html b/v10.5.0/output/pydis_core.utils.commands.html index b6522e96..40ede432 100644 --- a/v10.5.0/output/pydis_core.utils.commands.html +++ b/v10.5.0/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v10.5.0/output/pydis_core.utils.cooldown.html b/v10.5.0/output/pydis_core.utils.cooldown.html index 06243d7e..0d607867 100644 --- a/v10.5.0/output/pydis_core.utils.cooldown.html +++ b/v10.5.0/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v10.5.0/output/pydis_core.utils.error_handling.html b/v10.5.0/output/pydis_core.utils.error_handling.html index 5298962f..c35e0436 100644 --- a/v10.5.0/output/pydis_core.utils.error_handling.html +++ b/v10.5.0/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v10.5.0/output/pydis_core.utils.html b/v10.5.0/output/pydis_core.utils.html index bec0c9c2..ce720789 100644 --- a/v10.5.0/output/pydis_core.utils.html +++ b/v10.5.0/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v10.5.0/output/pydis_core.utils.interactions.html b/v10.5.0/output/pydis_core.utils.interactions.html index 20b698f3..ad4e3b2e 100644 --- a/v10.5.0/output/pydis_core.utils.interactions.html +++ b/v10.5.0/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v10.5.0/output/pydis_core.utils.members.html b/v10.5.0/output/pydis_core.utils.members.html index 841a19ba..1be6366e 100644 --- a/v10.5.0/output/pydis_core.utils.members.html +++ b/v10.5.0/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v10.5.1/.buildinfo b/v10.5.1/.buildinfo index eb9e2ae8..e4f799f8 100644 --- a/v10.5.1/.buildinfo +++ b/v10.5.1/.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: 7e9da2c5f131b2a9e0ca70ce3666ae8a +config: 15a5cf55e8d46f19befc7e6488c5f41b tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v10.5.1/_static/pygments.css b/v10.5.1/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v10.5.1/_static/pygments.css +++ b/v10.5.1/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v10.5.1/changelog.html b/v10.5.1/changelog.html index c3133ca1..ed3e6515 100644 --- a/v10.5.1/changelog.html +++ b/v10.5.1/changelog.html @@ -472,14 +472,14 @@

    10.1.0 25th July 2023

    10.0.0 14th July 2023

    diff --git a/v10.5.1/output/pydis_core.html b/v10.5.1/output/pydis_core.html index 5f35957e..56e6c2d3 100644 --- a/v10.5.1/output/pydis_core.html +++ b/v10.5.1/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -592,7 +592,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v10.5.1/output/pydis_core.utils.channel.html b/v10.5.1/output/pydis_core.utils.channel.html index f21ecfb3..4ea7b3cc 100644 --- a/v10.5.1/output/pydis_core.utils.channel.html +++ b/v10.5.1/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v10.5.1/output/pydis_core.utils.commands.html b/v10.5.1/output/pydis_core.utils.commands.html index 268ba0d5..934bd75a 100644 --- a/v10.5.1/output/pydis_core.utils.commands.html +++ b/v10.5.1/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v10.5.1/output/pydis_core.utils.cooldown.html b/v10.5.1/output/pydis_core.utils.cooldown.html index 92f53655..e66d15b9 100644 --- a/v10.5.1/output/pydis_core.utils.cooldown.html +++ b/v10.5.1/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v10.5.1/output/pydis_core.utils.error_handling.html b/v10.5.1/output/pydis_core.utils.error_handling.html index bf0ac7e5..2266bf4b 100644 --- a/v10.5.1/output/pydis_core.utils.error_handling.html +++ b/v10.5.1/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v10.5.1/output/pydis_core.utils.html b/v10.5.1/output/pydis_core.utils.html index c66f2896..404d3d24 100644 --- a/v10.5.1/output/pydis_core.utils.html +++ b/v10.5.1/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v10.5.1/output/pydis_core.utils.interactions.html b/v10.5.1/output/pydis_core.utils.interactions.html index 07894851..d99d6886 100644 --- a/v10.5.1/output/pydis_core.utils.interactions.html +++ b/v10.5.1/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v10.5.1/output/pydis_core.utils.members.html b/v10.5.1/output/pydis_core.utils.members.html index f55f297e..d93bfd5b 100644 --- a/v10.5.1/output/pydis_core.utils.members.html +++ b/v10.5.1/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v10.6.0/.buildinfo b/v10.6.0/.buildinfo index 53f8223c..f3a0974a 100644 --- a/v10.6.0/.buildinfo +++ b/v10.6.0/.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: fa82e6868e6c51f883ec36d522cef334 +config: 2a00fc8abca949bea03bd909e9b0d695 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v10.6.0/_static/pygments.css b/v10.6.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v10.6.0/_static/pygments.css +++ b/v10.6.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v10.6.0/changelog.html b/v10.6.0/changelog.html index 0bc2dc16..0ced18ee 100644 --- a/v10.6.0/changelog.html +++ b/v10.6.0/changelog.html @@ -482,14 +482,14 @@

    10.1.0 25th July 2023

    10.0.0 14th July 2023

    diff --git a/v10.6.0/output/pydis_core.html b/v10.6.0/output/pydis_core.html index 1a6b9491..36937683 100644 --- a/v10.6.0/output/pydis_core.html +++ b/v10.6.0/output/pydis_core.html @@ -450,7 +450,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -595,7 +595,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    @@ -639,7 +639,7 @@ gateway event before giving up and thus not populating the cache for unavailable
    class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    -

    Bases: Paginator

    +

    Bases: Paginator

    A class that aids in paginating code blocks for Discord messages.

    Parameters:
    @@ -703,15 +703,15 @@ to any user with a moderation role.

    • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

    • lines (list[str]) – A list of lines to be added to the paginated content.

      • -

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • -

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • +

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • prefix (str) – The prefix inserted to every page. e.g. three backticks.

    • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

    • max_lines (int) – The maximum amount of lines allowed in a page.

    • max_size (int) – The maximum amount of codepoints allowed in a page.

    • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

    • empty (bool) – Indicates whether an empty line should be added to each provided line.

      • -

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

      • +

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • timeout (int) – The timeout after which users cannot change pages anymore.

    • footer_text (str) – Text to be added as a footer for each page.

    • url (str) – The url to be set for the pagination embed.

      • @@ -721,7 +721,7 @@ to any user with a moderation role.

    Return type:
    -

    Message | None

    +

    Message | None

    Example: diff --git a/v10.6.0/output/pydis_core.utils.channel.html b/v10.6.0/output/pydis_core.utils.channel.html index d3892743..e8791826 100644 --- a/v10.6.0/output/pydis_core.utils.channel.html +++ b/v10.6.0/output/pydis_core.utils.channel.html @@ -454,20 +454,20 @@

    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -482,7 +482,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v10.6.0/output/pydis_core.utils.checks.html b/v10.6.0/output/pydis_core.utils.checks.html index db1fe9f9..228232af 100644 --- a/v10.6.0/output/pydis_core.utils.checks.html +++ b/v10.6.0/output/pydis_core.utils.checks.html @@ -449,7 +449,7 @@
    exception ContextCheckFailure(redirect_channel)[source]¶
    -

    Bases: CheckFailure

    +

    Bases: CheckFailure

    Raised when a context-specific check fails.

    @@ -475,7 +475,7 @@

    • rate (int) – Number of times a command can be used before triggering a cooldown.

    • per (float) – The duration (in seconds) for how long the cooldown lasts.

      • -

    • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

      • +

    • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

    • bypass_roles (Iterable[int]) – An iterable of role IDs that bypass the cooldown.

    @@ -499,7 +499,7 @@
    Parameters:
    @@ -520,7 +520,7 @@
    Parameters:
    @@ -540,7 +540,7 @@
    Parameters:
      -

    • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

    • redirect (int | None) – The channel ID to redirect the user to, if any.

    • channels (Container[int]) – Whitelisted channel IDs. Defaults to ().

    • categories (Container[int]) – Whitelisted category IDs. Defaults to ().

      • diff --git a/v10.6.0/output/pydis_core.utils.commands.html b/v10.6.0/output/pydis_core.utils.commands.html index d454cb46..a50a7688 100644 --- a/v10.6.0/output/pydis_core.utils.commands.html +++ b/v10.6.0/output/pydis_core.utils.commands.html @@ -453,12 +453,12 @@
      Parameters:
        -

      • ctx (Context) – The command’s context

        • +

      • ctx (Context) – The command’s context

      • text (str | None) – The provided text argument of the command (if given)

      Raises:
      -

      discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

      +

      discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

      Return type:

      str

      diff --git a/v10.6.0/output/pydis_core.utils.cooldown.html b/v10.6.0/output/pydis_core.utils.cooldown.html index aae99238..c87a6728 100644 --- a/v10.6.0/output/pydis_core.utils.cooldown.html +++ b/v10.6.0/output/pydis_core.utils.cooldown.html @@ -450,7 +450,7 @@
      exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
      -

      Bases: CommandError, Generic[P, R]

      +

      Bases: CommandError, Generic[P, R]

      Raised when a command is invoked while on cooldown.

      diff --git a/v10.6.0/output/pydis_core.utils.error_handling.html b/v10.6.0/output/pydis_core.utils.error_handling.html index 17a5f25d..42390b17 100644 --- a/v10.6.0/output/pydis_core.utils.error_handling.html +++ b/v10.6.0/output/pydis_core.utils.error_handling.html @@ -453,8 +453,8 @@
      Parameters:
        -

      • error (Forbidden) – The raised discord.Forbidden to check.

        • -

      • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

        • +

      • error (Forbidden) – The raised discord.Forbidden to check.

        • +

      • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      Return type:
      diff --git a/v10.6.0/output/pydis_core.utils.html b/v10.6.0/output/pydis_core.utils.html index e6094fd1..959b4f7f 100644 --- a/v10.6.0/output/pydis_core.utils.html +++ b/v10.6.0/output/pydis_core.utils.html @@ -457,7 +457,7 @@
      -
      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 +

      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

      diff --git a/v10.6.0/output/pydis_core.utils.interactions.html b/v10.6.0/output/pydis_core.utils.interactions.html index 9369966a..1e4642cc 100644 --- a/v10.6.0/output/pydis_core.utils.interactions.html +++ b/v10.6.0/output/pydis_core.utils.interactions.html @@ -449,7 +449,7 @@
      class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
      -

      Bases: Button

      +

      Bases: Button

      A button that can be added to a view to delete the message containing the view on click.

      This button itself carries out no interaction checks, these should be done by the parent view.

      See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

      @@ -482,7 +482,7 @@
      class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
      -

      Bases: View

      +

      Bases: View

      A view that allows the original invoker and moderators to interact with it.

      Parameters:
      @@ -491,7 +491,7 @@

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

    • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

      • -

    • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

    • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    @@ -507,7 +507,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v10.6.0/output/pydis_core.utils.members.html b/v10.6.0/output/pydis_core.utils.members.html index 03ea50e7..1891f8fc 100644 --- a/v10.6.0/output/pydis_core.utils.members.html +++ b/v10.6.0/output/pydis_core.utils.members.html @@ -446,17 +446,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -466,13 +466,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v10.6.0/output/pydis_core.utils.pagination.html b/v10.6.0/output/pydis_core.utils.pagination.html index 0da58388..441512ef 100644 --- a/v10.6.0/output/pydis_core.utils.pagination.html +++ b/v10.6.0/output/pydis_core.utils.pagination.html @@ -456,7 +456,7 @@
    class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    -

    Bases: Paginator

    +

    Bases: Paginator

    A class that aids in paginating code blocks for Discord messages.

    Parameters:
    @@ -520,15 +520,15 @@ to any user with a moderation role.

    • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

    • lines (list[str]) – A list of lines to be added to the paginated content.

      • -

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • -

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • +

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • prefix (str) – The prefix inserted to every page. e.g. three backticks.

    • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

    • max_lines (int) – The maximum amount of lines allowed in a page.

    • max_size (int) – The maximum amount of codepoints allowed in a page.

    • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

    • empty (bool) – Indicates whether an empty line should be added to each provided line.

      • -

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

      • +

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • timeout (int) – The timeout after which users cannot change pages anymore.

    • footer_text (str) – Text to be added as a footer for each page.

    • url (str) – The url to be set for the pagination embed.

      • @@ -538,7 +538,7 @@ to any user with a moderation role.

    Return type:
    -

    Message | None

    +

    Message | None

    Example: diff --git a/v10.7.0/.buildinfo b/v10.7.0/.buildinfo index 22a68a86..6772a5e8 100644 --- a/v10.7.0/.buildinfo +++ b/v10.7.0/.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: 36ed483a88ae18c4a691599371fae5e3 +config: 897dacf3fc437d4d89cc7988b2d15640 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v10.7.0/_static/pygments.css b/v10.7.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v10.7.0/_static/pygments.css +++ b/v10.7.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v10.7.0/changelog.html b/v10.7.0/changelog.html index 4244b2ea..b68d22ed 100644 --- a/v10.7.0/changelog.html +++ b/v10.7.0/changelog.html @@ -490,14 +490,14 @@

    10.1.0 25th July 2023

    10.0.0 14th July 2023

    diff --git a/v10.7.0/output/pydis_core.html b/v10.7.0/output/pydis_core.html index 9dfb507e..e27397e9 100644 --- a/v10.7.0/output/pydis_core.html +++ b/v10.7.0/output/pydis_core.html @@ -451,7 +451,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -596,7 +596,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    @@ -640,7 +640,7 @@ gateway event before giving up and thus not populating the cache for unavailable
    class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    -

    Bases: Paginator

    +

    Bases: Paginator

    A class that aids in paginating code blocks for Discord messages.

    Parameters:
    @@ -704,15 +704,15 @@ to any user with a moderation role.

    • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

    • lines (list[str]) – A list of lines to be added to the paginated content.

      • -

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • -

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • +

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • prefix (str) – The prefix inserted to every page. e.g. three backticks.

    • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

    • max_lines (int) – The maximum amount of lines allowed in a page.

    • max_size (int) – The maximum amount of codepoints allowed in a page.

    • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

    • empty (bool) – Indicates whether an empty line should be added to each provided line.

      • -

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

      • +

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • timeout (int) – The timeout after which users cannot change pages anymore.

    • footer_text (str) – Text to be added as a footer for each page.

    • url (str) – The url to be set for the pagination embed.

      • @@ -722,7 +722,7 @@ to any user with a moderation role.

    Return type:
    -

    Message | None

    +

    Message | None

    Example: diff --git a/v10.7.0/output/pydis_core.utils.channel.html b/v10.7.0/output/pydis_core.utils.channel.html index ab4555df..7bc3bd29 100644 --- a/v10.7.0/output/pydis_core.utils.channel.html +++ b/v10.7.0/output/pydis_core.utils.channel.html @@ -455,20 +455,20 @@

    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -483,7 +483,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v10.7.0/output/pydis_core.utils.checks.html b/v10.7.0/output/pydis_core.utils.checks.html index 58d7beed..83526605 100644 --- a/v10.7.0/output/pydis_core.utils.checks.html +++ b/v10.7.0/output/pydis_core.utils.checks.html @@ -450,7 +450,7 @@
    exception ContextCheckFailure(redirect_channel)[source]¶
    -

    Bases: CheckFailure

    +

    Bases: CheckFailure

    Raised when a context-specific check fails.

    @@ -476,7 +476,7 @@

    • rate (int) – Number of times a command can be used before triggering a cooldown.

    • per (float) – The duration (in seconds) for how long the cooldown lasts.

      • -

    • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

      • +

    • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

    • bypass_roles (Iterable[int]) – An iterable of role IDs that bypass the cooldown.

    @@ -500,7 +500,7 @@
    Parameters:
    @@ -521,7 +521,7 @@
    Parameters:
    @@ -541,7 +541,7 @@
    Parameters:
      -

    • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

    • redirect (int | None) – The channel ID to redirect the user to, if any.

    • channels (Container[int]) – Whitelisted channel IDs. Defaults to ().

    • categories (Container[int]) – Whitelisted category IDs. Defaults to ().

      • diff --git a/v10.7.0/output/pydis_core.utils.commands.html b/v10.7.0/output/pydis_core.utils.commands.html index d74bb9ef..389371ec 100644 --- a/v10.7.0/output/pydis_core.utils.commands.html +++ b/v10.7.0/output/pydis_core.utils.commands.html @@ -454,12 +454,12 @@
      Parameters:
        -

      • ctx (Context) – The command’s context

        • +

      • ctx (Context) – The command’s context

      • text (str | None) – The provided text argument of the command (if given)

      Raises:
      -

      discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

      +

      discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

      Return type:

      str

      diff --git a/v10.7.0/output/pydis_core.utils.cooldown.html b/v10.7.0/output/pydis_core.utils.cooldown.html index f22ffba0..2e1ac03f 100644 --- a/v10.7.0/output/pydis_core.utils.cooldown.html +++ b/v10.7.0/output/pydis_core.utils.cooldown.html @@ -451,7 +451,7 @@
      exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
      -

      Bases: CommandError, Generic[P, R]

      +

      Bases: CommandError, Generic[P, R]

      Raised when a command is invoked while on cooldown.

      diff --git a/v10.7.0/output/pydis_core.utils.error_handling.html b/v10.7.0/output/pydis_core.utils.error_handling.html index 4775ce4b..9e293354 100644 --- a/v10.7.0/output/pydis_core.utils.error_handling.html +++ b/v10.7.0/output/pydis_core.utils.error_handling.html @@ -454,8 +454,8 @@
      Parameters:
        -

      • error (Forbidden) – The raised discord.Forbidden to check.

        • -

      • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

        • +

      • error (Forbidden) – The raised discord.Forbidden to check.

        • +

      • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      Return type:
      diff --git a/v10.7.0/output/pydis_core.utils.html b/v10.7.0/output/pydis_core.utils.html index aeb10354..e4d1ba63 100644 --- a/v10.7.0/output/pydis_core.utils.html +++ b/v10.7.0/output/pydis_core.utils.html @@ -458,7 +458,7 @@
      -
      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 +

      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

      diff --git a/v10.7.0/output/pydis_core.utils.interactions.html b/v10.7.0/output/pydis_core.utils.interactions.html index f0e0f43e..9da9dd07 100644 --- a/v10.7.0/output/pydis_core.utils.interactions.html +++ b/v10.7.0/output/pydis_core.utils.interactions.html @@ -450,7 +450,7 @@
      class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
      -

      Bases: Button

      +

      Bases: Button

      A button that can be added to a view to delete the message containing the view on click.

      This button itself carries out no interaction checks, these should be done by the parent view.

      See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

      @@ -483,7 +483,7 @@
      class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
      -

      Bases: View

      +

      Bases: View

      A view that allows the original invoker and moderators to interact with it.

      Parameters:
      @@ -492,7 +492,7 @@

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

    • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

      • -

    • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

    • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    @@ -508,7 +508,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    @@ -547,7 +547,7 @@ If None
    Parameters:
      -

    • user (User | Member) – The user to check

      • +

    • user (User | Member) – The user to check

    • allowed_users (Sequence[int]) – A sequence of user ids that are allowed access

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed access

    diff --git a/v10.7.0/output/pydis_core.utils.members.html b/v10.7.0/output/pydis_core.utils.members.html index 0d9b54f2..59e783c0 100644 --- a/v10.7.0/output/pydis_core.utils.members.html +++ b/v10.7.0/output/pydis_core.utils.members.html @@ -447,17 +447,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -467,13 +467,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v10.7.0/output/pydis_core.utils.pagination.html b/v10.7.0/output/pydis_core.utils.pagination.html index 6c836c12..af469285 100644 --- a/v10.7.0/output/pydis_core.utils.pagination.html +++ b/v10.7.0/output/pydis_core.utils.pagination.html @@ -457,7 +457,7 @@
    class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    -

    Bases: Paginator

    +

    Bases: Paginator

    A class that aids in paginating code blocks for Discord messages.

    Parameters:
    @@ -521,15 +521,15 @@ to any user with a moderation role.

    • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

    • lines (list[str]) – A list of lines to be added to the paginated content.

      • -

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • -

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • +

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • prefix (str) – The prefix inserted to every page. e.g. three backticks.

    • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

    • max_lines (int) – The maximum amount of lines allowed in a page.

    • max_size (int) – The maximum amount of codepoints allowed in a page.

    • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

    • empty (bool) – Indicates whether an empty line should be added to each provided line.

      • -

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

      • +

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • timeout (int) – The timeout after which users cannot change pages anymore.

    • footer_text (str) – Text to be added as a footer for each page.

    • url (str) – The url to be set for the pagination embed.

      • @@ -539,7 +539,7 @@ to any user with a moderation role.

    Return type:
    -

    Message | None

    +

    Message | None

    Example: diff --git a/v11.0.0/.buildinfo b/v11.0.0/.buildinfo index 6cd702f8..a5dbf140 100644 --- a/v11.0.0/.buildinfo +++ b/v11.0.0/.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: 91cd4ad417882b671db38c6728d00fe0 +config: 7488b03904f563e61a9f87d0ef998e9f tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v11.0.0/_static/pygments.css b/v11.0.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v11.0.0/_static/pygments.css +++ b/v11.0.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v11.0.0/changelog.html b/v11.0.0/changelog.html index f18ac7e3..9605f65c 100644 --- a/v11.0.0/changelog.html +++ b/v11.0.0/changelog.html @@ -510,14 +510,14 @@

    10.1.0 25th July 2023

    10.0.0 14th July 2023

    diff --git a/v11.0.0/output/pydis_core.html b/v11.0.0/output/pydis_core.html index ce140ea2..62c3e3ca 100644 --- a/v11.0.0/output/pydis_core.html +++ b/v11.0.0/output/pydis_core.html @@ -458,7 +458,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -694,7 +694,7 @@ So registration needs to happen once the bot instance has been created.

    To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    @@ -738,7 +738,7 @@ gateway event before giving up and thus not populating the cache for unavailable
    class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    -

    Bases: Paginator

    +

    Bases: Paginator

    A class that aids in paginating code blocks for Discord messages.

    Parameters:
    @@ -802,15 +802,15 @@ to any user with a moderation role.

    • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

    • lines (list[str]) – A list of lines to be added to the paginated content.

      • -

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • -

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • +

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • prefix (str) – The prefix inserted to every page. e.g. three backticks.

    • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

    • max_lines (int) – The maximum amount of lines allowed in a page.

    • max_size (int) – The maximum amount of codepoints allowed in a page.

    • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

    • empty (bool) – Indicates whether an empty line should be added to each provided line.

      • -

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

      • +

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • timeout (int) – The timeout after which users cannot change pages anymore.

    • footer_text (str) – Text to be added as a footer for each page.

    • url (str) – The url to be set for the pagination embed.

      • @@ -820,7 +820,7 @@ to any user with a moderation role.

    Return type:
    -

    Message | None

    +

    Message | None

    Example: diff --git a/v11.0.0/output/pydis_core.utils.channel.html b/v11.0.0/output/pydis_core.utils.channel.html index e2f65c27..7514eab8 100644 --- a/v11.0.0/output/pydis_core.utils.channel.html +++ b/v11.0.0/output/pydis_core.utils.channel.html @@ -462,20 +462,20 @@

    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -490,7 +490,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v11.0.0/output/pydis_core.utils.checks.html b/v11.0.0/output/pydis_core.utils.checks.html index a86eecb5..57458343 100644 --- a/v11.0.0/output/pydis_core.utils.checks.html +++ b/v11.0.0/output/pydis_core.utils.checks.html @@ -457,7 +457,7 @@
    exception ContextCheckFailure(redirect_channel)[source]¶
    -

    Bases: CheckFailure

    +

    Bases: CheckFailure

    Raised when a context-specific check fails.

    @@ -483,7 +483,7 @@

    • rate (int) – Number of times a command can be used before triggering a cooldown.

    • per (float) – The duration (in seconds) for how long the cooldown lasts.

      • -

    • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

      • +

    • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

    • bypass_roles (Iterable[int]) – An iterable of role IDs that bypass the cooldown.

    @@ -507,7 +507,7 @@
    Parameters:
    @@ -528,7 +528,7 @@
    Parameters:
    @@ -548,7 +548,7 @@
    Parameters:
      -

    • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

    • redirect (int | None) – The channel ID to redirect the user to, if any.

    • channels (Container[int]) – Whitelisted channel IDs. Defaults to ().

    • categories (Container[int]) – Whitelisted category IDs. Defaults to ().

      • diff --git a/v11.0.0/output/pydis_core.utils.commands.html b/v11.0.0/output/pydis_core.utils.commands.html index 789892b3..6a7fb04a 100644 --- a/v11.0.0/output/pydis_core.utils.commands.html +++ b/v11.0.0/output/pydis_core.utils.commands.html @@ -461,12 +461,12 @@
      Parameters:
        -

      • ctx (Context) – The command’s context

        • +

      • ctx (Context) – The command’s context

      • text (str | None) – The provided text argument of the command (if given)

      Raises:
      -

      discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

      +

      discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

      Return type:

      str

      diff --git a/v11.0.0/output/pydis_core.utils.cooldown.html b/v11.0.0/output/pydis_core.utils.cooldown.html index 607a8fbe..0171d7b0 100644 --- a/v11.0.0/output/pydis_core.utils.cooldown.html +++ b/v11.0.0/output/pydis_core.utils.cooldown.html @@ -458,7 +458,7 @@
      exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
      -

      Bases: CommandError, Generic[P, R]

      +

      Bases: CommandError, Generic[P, R]

      Raised when a command is invoked while on cooldown.

      diff --git a/v11.0.0/output/pydis_core.utils.error_handling.html b/v11.0.0/output/pydis_core.utils.error_handling.html index 88fef77a..1e154bb2 100644 --- a/v11.0.0/output/pydis_core.utils.error_handling.html +++ b/v11.0.0/output/pydis_core.utils.error_handling.html @@ -461,8 +461,8 @@
      Parameters:
        -

      • error (Forbidden) – The raised discord.Forbidden to check.

        • -

      • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

        • +

      • error (Forbidden) – The raised discord.Forbidden to check.

        • +

      • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      Return type:
      diff --git a/v11.0.0/output/pydis_core.utils.html b/v11.0.0/output/pydis_core.utils.html index 29b23f70..4b8f04b7 100644 --- a/v11.0.0/output/pydis_core.utils.html +++ b/v11.0.0/output/pydis_core.utils.html @@ -465,7 +465,7 @@
      -
      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 +

      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

      diff --git a/v11.0.0/output/pydis_core.utils.interactions.html b/v11.0.0/output/pydis_core.utils.interactions.html index 275d3b34..d18dde7e 100644 --- a/v11.0.0/output/pydis_core.utils.interactions.html +++ b/v11.0.0/output/pydis_core.utils.interactions.html @@ -457,7 +457,7 @@
      class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
      -

      Bases: Button

      +

      Bases: Button

      A button that can be added to a view to delete the message containing the view on click.

      This button itself carries out no interaction checks, these should be done by the parent view.

      See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

      @@ -490,7 +490,7 @@
      class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
      -

      Bases: View

      +

      Bases: View

      A view that allows the original invoker and moderators to interact with it.

      Parameters:
      @@ -499,7 +499,7 @@

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

    • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

      • -

    • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

    • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    @@ -515,7 +515,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    @@ -554,7 +554,7 @@ If None
    Parameters:
      -

    • user (User | Member) – The user to check

      • +

    • user (User | Member) – The user to check

    • allowed_users (Sequence[int]) – A sequence of user ids that are allowed access

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed access

    diff --git a/v11.0.0/output/pydis_core.utils.members.html b/v11.0.0/output/pydis_core.utils.members.html index 0df88cf8..c1af0d95 100644 --- a/v11.0.0/output/pydis_core.utils.members.html +++ b/v11.0.0/output/pydis_core.utils.members.html @@ -454,17 +454,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -474,13 +474,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v11.0.0/output/pydis_core.utils.pagination.html b/v11.0.0/output/pydis_core.utils.pagination.html index d86fed9f..3601b3ed 100644 --- a/v11.0.0/output/pydis_core.utils.pagination.html +++ b/v11.0.0/output/pydis_core.utils.pagination.html @@ -464,7 +464,7 @@
    class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    -

    Bases: Paginator

    +

    Bases: Paginator

    A class that aids in paginating code blocks for Discord messages.

    Parameters:
    @@ -528,15 +528,15 @@ to any user with a moderation role.

    • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

    • lines (list[str]) – A list of lines to be added to the paginated content.

      • -

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • -

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • +

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • prefix (str) – The prefix inserted to every page. e.g. three backticks.

    • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

    • max_lines (int) – The maximum amount of lines allowed in a page.

    • max_size (int) – The maximum amount of codepoints allowed in a page.

    • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

    • empty (bool) – Indicates whether an empty line should be added to each provided line.

      • -

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

      • +

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • timeout (int) – The timeout after which users cannot change pages anymore.

    • footer_text (str) – Text to be added as a footer for each page.

    • url (str) – The url to be set for the pagination embed.

      • @@ -546,7 +546,7 @@ to any user with a moderation role.

    Return type:
    -

    Message | None

    +

    Message | None

    Example: diff --git a/v11.0.1/.buildinfo b/v11.0.1/.buildinfo index 6e3c3dd2..c4cc9723 100644 --- a/v11.0.1/.buildinfo +++ b/v11.0.1/.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: 2aefbdfa8f6a1674d8da448a17b2d057 +config: bb541a4ade3412407beb8e5bbd7790b0 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v11.0.1/_static/pygments.css b/v11.0.1/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v11.0.1/_static/pygments.css +++ b/v11.0.1/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v11.0.1/changelog.html b/v11.0.1/changelog.html index 5c089145..3cc71b09 100644 --- a/v11.0.1/changelog.html +++ b/v11.0.1/changelog.html @@ -456,7 +456,7 @@

    Changelog¶

    11.0.1 20th March 2024

    @@ -515,14 +515,14 @@

    10.1.0 25th July 2023

    10.0.0 14th July 2023

    diff --git a/v11.0.1/output/pydis_core.html b/v11.0.1/output/pydis_core.html index d75df6ca..f60d4cb6 100644 --- a/v11.0.1/output/pydis_core.html +++ b/v11.0.1/output/pydis_core.html @@ -458,7 +458,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -694,7 +694,7 @@ So registration needs to happen once the bot instance has been created.

    To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    @@ -738,7 +738,7 @@ gateway event before giving up and thus not populating the cache for unavailable
    class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    -

    Bases: Paginator

    +

    Bases: Paginator

    A class that aids in paginating code blocks for Discord messages.

    Parameters:
    @@ -802,15 +802,15 @@ to any user with a moderation role.

    • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

    • lines (list[str]) – A list of lines to be added to the paginated content.

      • -

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • -

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • +

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • prefix (str) – The prefix inserted to every page. e.g. three backticks.

    • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

    • max_lines (int) – The maximum amount of lines allowed in a page.

    • max_size (int) – The maximum amount of codepoints allowed in a page.

    • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

    • empty (bool) – Indicates whether an empty line should be added to each provided line.

      • -

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

      • +

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • timeout (int) – The timeout after which users cannot change pages anymore.

    • footer_text (str) – Text to be added as a footer for each page.

    • url (str) – The url to be set for the pagination embed.

      • @@ -820,7 +820,7 @@ to any user with a moderation role.

    Return type:
    -

    Message | None

    +

    Message | None

    Example: diff --git a/v11.0.1/output/pydis_core.utils.channel.html b/v11.0.1/output/pydis_core.utils.channel.html index bf6dd269..9e6b61a5 100644 --- a/v11.0.1/output/pydis_core.utils.channel.html +++ b/v11.0.1/output/pydis_core.utils.channel.html @@ -462,20 +462,20 @@

    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -490,7 +490,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v11.0.1/output/pydis_core.utils.checks.html b/v11.0.1/output/pydis_core.utils.checks.html index 81006f5b..7f116efb 100644 --- a/v11.0.1/output/pydis_core.utils.checks.html +++ b/v11.0.1/output/pydis_core.utils.checks.html @@ -457,7 +457,7 @@
    exception ContextCheckFailure(redirect_channel)[source]¶
    -

    Bases: CheckFailure

    +

    Bases: CheckFailure

    Raised when a context-specific check fails.

    @@ -483,7 +483,7 @@

    • rate (int) – Number of times a command can be used before triggering a cooldown.

    • per (float) – The duration (in seconds) for how long the cooldown lasts.

      • -

    • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

      • +

    • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

    • bypass_roles (Iterable[int]) – An iterable of role IDs that bypass the cooldown.

    @@ -507,7 +507,7 @@
    Parameters:
    @@ -528,7 +528,7 @@
    Parameters:
    @@ -548,7 +548,7 @@
    Parameters:
      -

    • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

    • redirect (int | None) – The channel ID to redirect the user to, if any.

    • channels (Container[int]) – Whitelisted channel IDs. Defaults to ().

    • categories (Container[int]) – Whitelisted category IDs. Defaults to ().

      • diff --git a/v11.0.1/output/pydis_core.utils.commands.html b/v11.0.1/output/pydis_core.utils.commands.html index dce537ca..26694ec3 100644 --- a/v11.0.1/output/pydis_core.utils.commands.html +++ b/v11.0.1/output/pydis_core.utils.commands.html @@ -461,12 +461,12 @@
      Parameters:
        -

      • ctx (Context) – The command’s context

        • +

      • ctx (Context) – The command’s context

      • text (str | None) – The provided text argument of the command (if given)

      Raises:
      -

      discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

      +

      discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

      Return type:

      str

      diff --git a/v11.0.1/output/pydis_core.utils.cooldown.html b/v11.0.1/output/pydis_core.utils.cooldown.html index dda27700..3f430e9e 100644 --- a/v11.0.1/output/pydis_core.utils.cooldown.html +++ b/v11.0.1/output/pydis_core.utils.cooldown.html @@ -458,7 +458,7 @@
      exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
      -

      Bases: CommandError, Generic[P, R]

      +

      Bases: CommandError, Generic[P, R]

      Raised when a command is invoked while on cooldown.

      diff --git a/v11.0.1/output/pydis_core.utils.error_handling.html b/v11.0.1/output/pydis_core.utils.error_handling.html index 5b690b76..63bdee81 100644 --- a/v11.0.1/output/pydis_core.utils.error_handling.html +++ b/v11.0.1/output/pydis_core.utils.error_handling.html @@ -461,8 +461,8 @@
      Parameters:
        -

      • error (Forbidden) – The raised discord.Forbidden to check.

        • -

      • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

        • +

      • error (Forbidden) – The raised discord.Forbidden to check.

        • +

      • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      Return type:
      diff --git a/v11.0.1/output/pydis_core.utils.html b/v11.0.1/output/pydis_core.utils.html index b2311e66..5e34bc8f 100644 --- a/v11.0.1/output/pydis_core.utils.html +++ b/v11.0.1/output/pydis_core.utils.html @@ -465,7 +465,7 @@
      -
      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 +

      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

      diff --git a/v11.0.1/output/pydis_core.utils.interactions.html b/v11.0.1/output/pydis_core.utils.interactions.html index 49f926b1..59450129 100644 --- a/v11.0.1/output/pydis_core.utils.interactions.html +++ b/v11.0.1/output/pydis_core.utils.interactions.html @@ -457,7 +457,7 @@
      class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
      -

      Bases: Button

      +

      Bases: Button

      A button that can be added to a view to delete the message containing the view on click.

      This button itself carries out no interaction checks, these should be done by the parent view.

      See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

      @@ -490,7 +490,7 @@
      class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
      -

      Bases: View

      +

      Bases: View

      A view that allows the original invoker and moderators to interact with it.

      Parameters:
      @@ -499,7 +499,7 @@

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

    • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

      • -

    • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

    • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    @@ -515,7 +515,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    @@ -554,7 +554,7 @@ If None
    Parameters:
      -

    • user (User | Member) – The user to check

      • +

    • user (User | Member) – The user to check

    • allowed_users (Sequence[int]) – A sequence of user ids that are allowed access

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed access

    diff --git a/v11.0.1/output/pydis_core.utils.members.html b/v11.0.1/output/pydis_core.utils.members.html index 60ef6a5d..46fbc050 100644 --- a/v11.0.1/output/pydis_core.utils.members.html +++ b/v11.0.1/output/pydis_core.utils.members.html @@ -454,17 +454,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -474,13 +474,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v11.0.1/output/pydis_core.utils.pagination.html b/v11.0.1/output/pydis_core.utils.pagination.html index c9bea13b..0172bb6d 100644 --- a/v11.0.1/output/pydis_core.utils.pagination.html +++ b/v11.0.1/output/pydis_core.utils.pagination.html @@ -464,7 +464,7 @@
    class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    -

    Bases: Paginator

    +

    Bases: Paginator

    A class that aids in paginating code blocks for Discord messages.

    Parameters:
    @@ -528,15 +528,15 @@ to any user with a moderation role.

    • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

    • lines (list[str]) – A list of lines to be added to the paginated content.

      • -

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • -

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • +

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • prefix (str) – The prefix inserted to every page. e.g. three backticks.

    • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

    • max_lines (int) – The maximum amount of lines allowed in a page.

    • max_size (int) – The maximum amount of codepoints allowed in a page.

    • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

    • empty (bool) – Indicates whether an empty line should be added to each provided line.

      • -

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

      • +

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • timeout (int) – The timeout after which users cannot change pages anymore.

    • footer_text (str) – Text to be added as a footer for each page.

    • url (str) – The url to be set for the pagination embed.

      • @@ -546,7 +546,7 @@ to any user with a moderation role.

    Return type:
    -

    Message | None

    +

    Message | None

    Example: diff --git a/v11.1.0/.buildinfo b/v11.1.0/.buildinfo index a6e0544b..6cbd4bec 100644 --- a/v11.1.0/.buildinfo +++ b/v11.1.0/.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: df6a2276850fa75f69335d64320ce258 +config: b6edd41cffb3f869cb40664d74d5950a tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v11.1.0/_static/pygments.css b/v11.1.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v11.1.0/_static/pygments.css +++ b/v11.1.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v11.1.0/changelog.html b/v11.1.0/changelog.html index a7d03045..68c888bd 100644 --- a/v11.1.0/changelog.html +++ b/v11.1.0/changelog.html @@ -461,7 +461,7 @@

    11.0.1 20th March 2024

    @@ -520,14 +520,14 @@

    10.1.0 25th July 2023

    10.0.0 14th July 2023

    diff --git a/v11.1.0/output/pydis_core.html b/v11.1.0/output/pydis_core.html index b6e2b1d4..e667aa4e 100644 --- a/v11.1.0/output/pydis_core.html +++ b/v11.1.0/output/pydis_core.html @@ -458,7 +458,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -694,7 +694,7 @@ So registration needs to happen once the bot instance has been created.

    To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    @@ -738,7 +738,7 @@ gateway event before giving up and thus not populating the cache for unavailable
    class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    -

    Bases: Paginator

    +

    Bases: Paginator

    A class that aids in paginating code blocks for Discord messages.

    Parameters:
    @@ -802,15 +802,15 @@ to any user with a moderation role.

    • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

    • lines (list[str]) – A list of lines to be added to the paginated content.

      • -

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • -

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • +

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • prefix (str) – The prefix inserted to every page. e.g. three backticks.

    • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

    • max_lines (int) – The maximum amount of lines allowed in a page.

    • max_size (int) – The maximum amount of codepoints allowed in a page.

    • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

    • empty (bool) – Indicates whether an empty line should be added to each provided line.

      • -

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

      • +

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • timeout (int) – The timeout after which users cannot change pages anymore.

    • footer_text (str) – Text to be added as a footer for each page.

    • url (str) – The url to be set for the pagination embed.

      • @@ -820,7 +820,7 @@ to any user with a moderation role.

    Return type:
    -

    Message | None

    +

    Message | None

    Example: diff --git a/v11.1.0/output/pydis_core.utils.channel.html b/v11.1.0/output/pydis_core.utils.channel.html index d25c12a6..7734a89f 100644 --- a/v11.1.0/output/pydis_core.utils.channel.html +++ b/v11.1.0/output/pydis_core.utils.channel.html @@ -462,20 +462,20 @@

    Parameters:
    Raises:
    Return type:
    -

    GuildChannel | PrivateChannel | Thread

    +

    GuildChannel | PrivateChannel | Thread

    Returns:

    The channel from the ID.

    @@ -490,7 +490,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v11.1.0/output/pydis_core.utils.checks.html b/v11.1.0/output/pydis_core.utils.checks.html index d2e58a9b..4eb4c325 100644 --- a/v11.1.0/output/pydis_core.utils.checks.html +++ b/v11.1.0/output/pydis_core.utils.checks.html @@ -457,7 +457,7 @@
    exception ContextCheckFailure(redirect_channel)[source]¶
    -

    Bases: CheckFailure

    +

    Bases: CheckFailure

    Raised when a context-specific check fails.

    @@ -483,7 +483,7 @@

    • rate (int) – Number of times a command can be used before triggering a cooldown.

    • per (float) – The duration (in seconds) for how long the cooldown lasts.

      • -

    • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

      • +

    • type (discord.ext.commands.BucketType) – The type of cooldown (per user, per channel, per guild, etc.).

    • bypass_roles (Iterable[int]) – An iterable of role IDs that bypass the cooldown.

    @@ -507,7 +507,7 @@
    Parameters:
    @@ -528,7 +528,7 @@
    Parameters:
    @@ -548,7 +548,7 @@
    Parameters:
      -

    • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the command is being invoked.

    • redirect (int | None) – The channel ID to redirect the user to, if any.

    • channels (Container[int]) – Whitelisted channel IDs. Defaults to ().

    • categories (Container[int]) – Whitelisted category IDs. Defaults to ().

      • diff --git a/v11.1.0/output/pydis_core.utils.commands.html b/v11.1.0/output/pydis_core.utils.commands.html index 32c7f12a..d2516871 100644 --- a/v11.1.0/output/pydis_core.utils.commands.html +++ b/v11.1.0/output/pydis_core.utils.commands.html @@ -461,12 +461,12 @@
      Parameters:
        -

      • ctx (Context) – The command’s context

        • +

      • ctx (Context) – The command’s context

      • text (str | None) – The provided text argument of the command (if given)

      Raises:
      -

      discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

      +

      discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

      Return type:

      str

      diff --git a/v11.1.0/output/pydis_core.utils.cooldown.html b/v11.1.0/output/pydis_core.utils.cooldown.html index 48d6bbe6..6893e60b 100644 --- a/v11.1.0/output/pydis_core.utils.cooldown.html +++ b/v11.1.0/output/pydis_core.utils.cooldown.html @@ -458,7 +458,7 @@
      exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
      -

      Bases: CommandError, Generic[P, R]

      +

      Bases: CommandError, Generic[P, R]

      Raised when a command is invoked while on cooldown.

      diff --git a/v11.1.0/output/pydis_core.utils.error_handling.html b/v11.1.0/output/pydis_core.utils.error_handling.html index 0df06b01..f431751e 100644 --- a/v11.1.0/output/pydis_core.utils.error_handling.html +++ b/v11.1.0/output/pydis_core.utils.error_handling.html @@ -461,8 +461,8 @@
      Parameters:
        -

      • error (Forbidden) – The raised discord.Forbidden to check.

        • -

      • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

        • +

      • error (Forbidden) – The raised discord.Forbidden to check.

        • +

      • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      Return type:
      diff --git a/v11.1.0/output/pydis_core.utils.html b/v11.1.0/output/pydis_core.utils.html index 4617be91..7879bc53 100644 --- a/v11.1.0/output/pydis_core.utils.html +++ b/v11.1.0/output/pydis_core.utils.html @@ -465,7 +465,7 @@
      -
      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 +

      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

      diff --git a/v11.1.0/output/pydis_core.utils.interactions.html b/v11.1.0/output/pydis_core.utils.interactions.html index f6a53e57..8c63983c 100644 --- a/v11.1.0/output/pydis_core.utils.interactions.html +++ b/v11.1.0/output/pydis_core.utils.interactions.html @@ -457,7 +457,7 @@
      class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
      -

      Bases: Button

      +

      Bases: Button

      A button that can be added to a view to delete the message containing the view on click.

      This button itself carries out no interaction checks, these should be done by the parent view.

      See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

      @@ -490,7 +490,7 @@
      class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
      -

      Bases: View

      +

      Bases: View

      A view that allows the original invoker and moderators to interact with it.

      Parameters:
      @@ -499,7 +499,7 @@

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

    • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

      • -

    • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

    • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    @@ -515,7 +515,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    @@ -554,7 +554,7 @@ If None
    Parameters:
      -

    • user (User | Member) – The user to check

      • +

    • user (User | Member) – The user to check

    • allowed_users (Sequence[int]) – A sequence of user ids that are allowed access

    • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed access

    diff --git a/v11.1.0/output/pydis_core.utils.members.html b/v11.1.0/output/pydis_core.utils.members.html index f69ddfb6..bba3e856 100644 --- a/v11.1.0/output/pydis_core.utils.members.html +++ b/v11.1.0/output/pydis_core.utils.members.html @@ -454,17 +454,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -474,13 +474,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v11.1.0/output/pydis_core.utils.pagination.html b/v11.1.0/output/pydis_core.utils.pagination.html index ad5549c0..b293d6e1 100644 --- a/v11.1.0/output/pydis_core.utils.pagination.html +++ b/v11.1.0/output/pydis_core.utils.pagination.html @@ -464,7 +464,7 @@
    class LinePaginator(prefix='```', suffix='```', max_size=4000, scale_to_size=4000, max_lines=None, linesep='\\n')[source]¶
    -

    Bases: Paginator

    +

    Bases: Paginator

    A class that aids in paginating code blocks for Discord messages.

    Parameters:
    @@ -528,15 +528,15 @@ to any user with a moderation role.

    • pagination_emojis (PaginationEmojis) – The emojis used to navigate pages.

    • lines (list[str]) – A list of lines to be added to the paginated content.

      • -

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • -

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

      • +

    • ctx (discord.ext.commands.Context) – The context in which the pagination is needed.

      • +

    • embed (discord.Embed) – The embed that holds the content, it serves as the page.

    • prefix (str) – The prefix inserted to every page. e.g. three backticks.

    • suffix (str) – The suffix appended at the end of every page. e.g. three backticks.

    • max_lines (int) – The maximum amount of lines allowed in a page.

    • max_size (int) – The maximum amount of codepoints allowed in a page.

    • scale_to_size (int) – The maximum amount of characters a single line can scale up to.

    • empty (bool) – Indicates whether an empty line should be added to each provided line.

      • -

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

      • +

    • restrict_to_user (discord.User) – The user to whom interaction with the pages should be restricted.

    • timeout (int) – The timeout after which users cannot change pages anymore.

    • footer_text (str) – Text to be added as a footer for each page.

    • url (str) – The url to be set for the pagination embed.

      • @@ -546,7 +546,7 @@ to any user with a moderation role.

    Return type:
    -

    Message | None

    +

    Message | None

    Example: diff --git a/v9.0.0/.buildinfo b/v9.0.0/.buildinfo index 7a737ccc..493185e2 100644 --- a/v9.0.0/.buildinfo +++ b/v9.0.0/.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: 9d086995c5518d085b782e06384010d9 +config: f5c35143c13b1df19f429d8fbbc5febc tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.0.0/_static/pygments.css b/v9.0.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.0.0/_static/pygments.css +++ b/v9.0.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.0.0/output/pydis_core.html b/v9.0.0/output/pydis_core.html index d61f3fcb..19b5604f 100644 --- a/v9.0.0/output/pydis_core.html +++ b/v9.0.0/output/pydis_core.html @@ -445,7 +445,7 @@

    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -576,7 +576,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Optional[Command]

    +

    Optional[Command]

    diff --git a/v9.0.0/output/pydis_core.utils.channel.html b/v9.0.0/output/pydis_core.utils.channel.html index 3310c30a..a72287ce 100644 --- a/v9.0.0/output/pydis_core.utils.channel.html +++ b/v9.0.0/output/pydis_core.utils.channel.html @@ -449,20 +449,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -477,7 +477,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.0.0/output/pydis_core.utils.commands.html b/v9.0.0/output/pydis_core.utils.commands.html index 40879f7b..ce47eada 100644 --- a/v9.0.0/output/pydis_core.utils.commands.html +++ b/v9.0.0/output/pydis_core.utils.commands.html @@ -448,12 +448,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (Optional[str]) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.0.0/output/pydis_core.utils.cooldown.html b/v9.0.0/output/pydis_core.utils.cooldown.html index fa3782ab..dff6c4c4 100644 --- a/v9.0.0/output/pydis_core.utils.cooldown.html +++ b/v9.0.0/output/pydis_core.utils.cooldown.html @@ -445,7 +445,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.0.0/output/pydis_core.utils.html b/v9.0.0/output/pydis_core.utils.html index 8f25224d..073e6baf 100644 --- a/v9.0.0/output/pydis_core.utils.html +++ b/v9.0.0/output/pydis_core.utils.html @@ -452,7 +452,7 @@
    -
    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 +

    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

    diff --git a/v9.0.0/output/pydis_core.utils.interactions.html b/v9.0.0/output/pydis_core.utils.interactions.html index ebe83b81..e978aaaa 100644 --- a/v9.0.0/output/pydis_core.utils.interactions.html +++ b/v9.0.0/output/pydis_core.utils.interactions.html @@ -444,7 +444,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -477,7 +477,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -486,7 +486,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with +

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -502,7 +502,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.0.0/output/pydis_core.utils.members.html b/v9.0.0/output/pydis_core.utils.members.html index e3ca6742..8b6def53 100644 --- a/v9.0.0/output/pydis_core.utils.members.html +++ b/v9.0.0/output/pydis_core.utils.members.html @@ -441,17 +441,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    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 discord.Member or None to indicate the member could not be found.

    +

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

    @@ -461,13 +461,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.1.1/.buildinfo b/v9.1.1/.buildinfo index 7f75efb2..8d1f0136 100644 --- a/v9.1.1/.buildinfo +++ b/v9.1.1/.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: a2a22f279cc6250d200b2a5c018604dd +config: 93806ffadab1e61141eb1136bdfc05ca tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.1.1/_static/pygments.css b/v9.1.1/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.1.1/_static/pygments.css +++ b/v9.1.1/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.1.1/output/pydis_core.html b/v9.1.1/output/pydis_core.html index afb8cecd..e61cd276 100644 --- a/v9.1.1/output/pydis_core.html +++ b/v9.1.1/output/pydis_core.html @@ -445,7 +445,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -576,7 +576,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Optional[Command]

    +

    Optional[Command]

    diff --git a/v9.1.1/output/pydis_core.utils.channel.html b/v9.1.1/output/pydis_core.utils.channel.html index bde3a13c..28f7c7ab 100644 --- a/v9.1.1/output/pydis_core.utils.channel.html +++ b/v9.1.1/output/pydis_core.utils.channel.html @@ -449,20 +449,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -477,7 +477,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.1.1/output/pydis_core.utils.commands.html b/v9.1.1/output/pydis_core.utils.commands.html index 6375bf9a..0307bc38 100644 --- a/v9.1.1/output/pydis_core.utils.commands.html +++ b/v9.1.1/output/pydis_core.utils.commands.html @@ -448,12 +448,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (Optional[str]) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.1.1/output/pydis_core.utils.cooldown.html b/v9.1.1/output/pydis_core.utils.cooldown.html index 2bc594eb..44eed9c4 100644 --- a/v9.1.1/output/pydis_core.utils.cooldown.html +++ b/v9.1.1/output/pydis_core.utils.cooldown.html @@ -445,7 +445,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.1.1/output/pydis_core.utils.html b/v9.1.1/output/pydis_core.utils.html index f6b5b737..4f6c8b6d 100644 --- a/v9.1.1/output/pydis_core.utils.html +++ b/v9.1.1/output/pydis_core.utils.html @@ -452,7 +452,7 @@
    -
    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 +

    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

    diff --git a/v9.1.1/output/pydis_core.utils.interactions.html b/v9.1.1/output/pydis_core.utils.interactions.html index ba8d0218..47c681e2 100644 --- a/v9.1.1/output/pydis_core.utils.interactions.html +++ b/v9.1.1/output/pydis_core.utils.interactions.html @@ -444,7 +444,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -477,7 +477,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -486,7 +486,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with +

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -502,7 +502,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.1.1/output/pydis_core.utils.members.html b/v9.1.1/output/pydis_core.utils.members.html index c3667e83..84378327 100644 --- a/v9.1.1/output/pydis_core.utils.members.html +++ b/v9.1.1/output/pydis_core.utils.members.html @@ -441,17 +441,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    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 discord.Member or None to indicate the member could not be found.

    +

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

    @@ -461,13 +461,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.10.0-alpha.1/.buildinfo b/v9.10.0-alpha.1/.buildinfo index 3f6e3621..263b12c0 100644 --- a/v9.10.0-alpha.1/.buildinfo +++ b/v9.10.0-alpha.1/.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: 53d9177f36687a056dbf62df4ddc975a +config: 46b11a7884bb514f41041f1ffce0a4c5 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.10.0-alpha.1/_static/pygments.css b/v9.10.0-alpha.1/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.10.0-alpha.1/_static/pygments.css +++ b/v9.10.0-alpha.1/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.10.0-alpha.1/output/pydis_core.html b/v9.10.0-alpha.1/output/pydis_core.html index 1e1e8023..f83594a1 100644 --- a/v9.10.0-alpha.1/output/pydis_core.html +++ b/v9.10.0-alpha.1/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -580,7 +580,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v9.10.0-alpha.1/output/pydis_core.utils.channel.html b/v9.10.0-alpha.1/output/pydis_core.utils.channel.html index 2ede750d..b88b4ebf 100644 --- a/v9.10.0-alpha.1/output/pydis_core.utils.channel.html +++ b/v9.10.0-alpha.1/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.10.0-alpha.1/output/pydis_core.utils.commands.html b/v9.10.0-alpha.1/output/pydis_core.utils.commands.html index e4d215d8..343caafd 100644 --- a/v9.10.0-alpha.1/output/pydis_core.utils.commands.html +++ b/v9.10.0-alpha.1/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.10.0-alpha.1/output/pydis_core.utils.cooldown.html b/v9.10.0-alpha.1/output/pydis_core.utils.cooldown.html index 4ad0bc08..cde5f8c7 100644 --- a/v9.10.0-alpha.1/output/pydis_core.utils.cooldown.html +++ b/v9.10.0-alpha.1/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.10.0-alpha.1/output/pydis_core.utils.error_handling.html b/v9.10.0-alpha.1/output/pydis_core.utils.error_handling.html index e37a29b0..8fc7c0d2 100644 --- a/v9.10.0-alpha.1/output/pydis_core.utils.error_handling.html +++ b/v9.10.0-alpha.1/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v9.10.0-alpha.1/output/pydis_core.utils.html b/v9.10.0-alpha.1/output/pydis_core.utils.html index 100f39c0..377f2992 100644 --- a/v9.10.0-alpha.1/output/pydis_core.utils.html +++ b/v9.10.0-alpha.1/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v9.10.0-alpha.1/output/pydis_core.utils.interactions.html b/v9.10.0-alpha.1/output/pydis_core.utils.interactions.html index f7b0601d..481b15a7 100644 --- a/v9.10.0-alpha.1/output/pydis_core.utils.interactions.html +++ b/v9.10.0-alpha.1/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.10.0-alpha.1/output/pydis_core.utils.members.html b/v9.10.0-alpha.1/output/pydis_core.utils.members.html index 7b8db46d..cc1b559b 100644 --- a/v9.10.0-alpha.1/output/pydis_core.utils.members.html +++ b/v9.10.0-alpha.1/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.10.0-alpha.2/.buildinfo b/v9.10.0-alpha.2/.buildinfo index b5485b44..c12158e8 100644 --- a/v9.10.0-alpha.2/.buildinfo +++ b/v9.10.0-alpha.2/.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: 3825a59f11eab929f444dd08020fd292 +config: e675b35f25a476290700cc74a2e91340 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.10.0-alpha.2/_static/pygments.css b/v9.10.0-alpha.2/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.10.0-alpha.2/_static/pygments.css +++ b/v9.10.0-alpha.2/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.10.0-alpha.2/output/pydis_core.html b/v9.10.0-alpha.2/output/pydis_core.html index 8ab6ab08..53ba2f2d 100644 --- a/v9.10.0-alpha.2/output/pydis_core.html +++ b/v9.10.0-alpha.2/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -580,7 +580,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v9.10.0-alpha.2/output/pydis_core.utils.channel.html b/v9.10.0-alpha.2/output/pydis_core.utils.channel.html index 8afecac8..771057c2 100644 --- a/v9.10.0-alpha.2/output/pydis_core.utils.channel.html +++ b/v9.10.0-alpha.2/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.10.0-alpha.2/output/pydis_core.utils.commands.html b/v9.10.0-alpha.2/output/pydis_core.utils.commands.html index ce6e7a98..6be08f3d 100644 --- a/v9.10.0-alpha.2/output/pydis_core.utils.commands.html +++ b/v9.10.0-alpha.2/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.10.0-alpha.2/output/pydis_core.utils.cooldown.html b/v9.10.0-alpha.2/output/pydis_core.utils.cooldown.html index 48af8e25..3831e8a3 100644 --- a/v9.10.0-alpha.2/output/pydis_core.utils.cooldown.html +++ b/v9.10.0-alpha.2/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.10.0-alpha.2/output/pydis_core.utils.error_handling.html b/v9.10.0-alpha.2/output/pydis_core.utils.error_handling.html index f62314a6..907de024 100644 --- a/v9.10.0-alpha.2/output/pydis_core.utils.error_handling.html +++ b/v9.10.0-alpha.2/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v9.10.0-alpha.2/output/pydis_core.utils.html b/v9.10.0-alpha.2/output/pydis_core.utils.html index 1920f9e5..3a4a65d7 100644 --- a/v9.10.0-alpha.2/output/pydis_core.utils.html +++ b/v9.10.0-alpha.2/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v9.10.0-alpha.2/output/pydis_core.utils.interactions.html b/v9.10.0-alpha.2/output/pydis_core.utils.interactions.html index 838745c1..c2ef035d 100644 --- a/v9.10.0-alpha.2/output/pydis_core.utils.interactions.html +++ b/v9.10.0-alpha.2/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.10.0-alpha.2/output/pydis_core.utils.members.html b/v9.10.0-alpha.2/output/pydis_core.utils.members.html index 487f65bf..76fbdf7c 100644 --- a/v9.10.0-alpha.2/output/pydis_core.utils.members.html +++ b/v9.10.0-alpha.2/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.2.0/.buildinfo b/v9.2.0/.buildinfo index e1f78de1..7fec6d46 100644 --- a/v9.2.0/.buildinfo +++ b/v9.2.0/.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: 9a1bc2435559603cc11ce7265dcf52b0 +config: 7a14f4efead1e52fea6972c651001fce tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.2.0/_static/pygments.css b/v9.2.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.2.0/_static/pygments.css +++ b/v9.2.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.2.0/output/pydis_core.html b/v9.2.0/output/pydis_core.html index f964d495..b7aa4807 100644 --- a/v9.2.0/output/pydis_core.html +++ b/v9.2.0/output/pydis_core.html @@ -445,7 +445,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -576,7 +576,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Optional[Command]

    +

    Optional[Command]

    diff --git a/v9.2.0/output/pydis_core.utils.channel.html b/v9.2.0/output/pydis_core.utils.channel.html index 7970c80f..6d65fef7 100644 --- a/v9.2.0/output/pydis_core.utils.channel.html +++ b/v9.2.0/output/pydis_core.utils.channel.html @@ -449,20 +449,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -477,7 +477,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.2.0/output/pydis_core.utils.commands.html b/v9.2.0/output/pydis_core.utils.commands.html index 564bf4c5..78907021 100644 --- a/v9.2.0/output/pydis_core.utils.commands.html +++ b/v9.2.0/output/pydis_core.utils.commands.html @@ -448,12 +448,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (Optional[str]) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.2.0/output/pydis_core.utils.cooldown.html b/v9.2.0/output/pydis_core.utils.cooldown.html index 2bc6ea02..95040f4e 100644 --- a/v9.2.0/output/pydis_core.utils.cooldown.html +++ b/v9.2.0/output/pydis_core.utils.cooldown.html @@ -445,7 +445,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.2.0/output/pydis_core.utils.html b/v9.2.0/output/pydis_core.utils.html index 027e8780..452c6548 100644 --- a/v9.2.0/output/pydis_core.utils.html +++ b/v9.2.0/output/pydis_core.utils.html @@ -452,7 +452,7 @@
    -
    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 +

    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

    diff --git a/v9.2.0/output/pydis_core.utils.interactions.html b/v9.2.0/output/pydis_core.utils.interactions.html index 552bce90..aa1e63c4 100644 --- a/v9.2.0/output/pydis_core.utils.interactions.html +++ b/v9.2.0/output/pydis_core.utils.interactions.html @@ -444,7 +444,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -477,7 +477,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -486,7 +486,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with +

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -502,7 +502,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.2.0/output/pydis_core.utils.members.html b/v9.2.0/output/pydis_core.utils.members.html index 9b296b43..15242c1f 100644 --- a/v9.2.0/output/pydis_core.utils.members.html +++ b/v9.2.0/output/pydis_core.utils.members.html @@ -441,17 +441,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    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 discord.Member or None to indicate the member could not be found.

    +

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

    @@ -461,13 +461,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.3.0/.buildinfo b/v9.3.0/.buildinfo index c8810961..06f57bc4 100644 --- a/v9.3.0/.buildinfo +++ b/v9.3.0/.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: e9c0e2978d6cb0424b4fd89aa5cc457f +config: 781dac7f1a015c8ecc990136ebe4cb3d tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.3.0/_static/pygments.css b/v9.3.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.3.0/_static/pygments.css +++ b/v9.3.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.3.0/output/pydis_core.html b/v9.3.0/output/pydis_core.html index 585dd5a3..dde77351 100644 --- a/v9.3.0/output/pydis_core.html +++ b/v9.3.0/output/pydis_core.html @@ -445,7 +445,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -576,7 +576,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Optional[Command]

    +

    Optional[Command]

    diff --git a/v9.3.0/output/pydis_core.utils.channel.html b/v9.3.0/output/pydis_core.utils.channel.html index ac81cc93..74ba99bc 100644 --- a/v9.3.0/output/pydis_core.utils.channel.html +++ b/v9.3.0/output/pydis_core.utils.channel.html @@ -449,20 +449,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -477,7 +477,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.3.0/output/pydis_core.utils.commands.html b/v9.3.0/output/pydis_core.utils.commands.html index 3841e33c..2f09705e 100644 --- a/v9.3.0/output/pydis_core.utils.commands.html +++ b/v9.3.0/output/pydis_core.utils.commands.html @@ -448,12 +448,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (Optional[str]) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.3.0/output/pydis_core.utils.cooldown.html b/v9.3.0/output/pydis_core.utils.cooldown.html index 6a55c006..ac9266f9 100644 --- a/v9.3.0/output/pydis_core.utils.cooldown.html +++ b/v9.3.0/output/pydis_core.utils.cooldown.html @@ -445,7 +445,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.3.0/output/pydis_core.utils.html b/v9.3.0/output/pydis_core.utils.html index 46276a48..e6b55694 100644 --- a/v9.3.0/output/pydis_core.utils.html +++ b/v9.3.0/output/pydis_core.utils.html @@ -452,7 +452,7 @@
    -
    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 +

    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

    diff --git a/v9.3.0/output/pydis_core.utils.interactions.html b/v9.3.0/output/pydis_core.utils.interactions.html index 8da5b926..71476771 100644 --- a/v9.3.0/output/pydis_core.utils.interactions.html +++ b/v9.3.0/output/pydis_core.utils.interactions.html @@ -444,7 +444,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -477,7 +477,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -486,7 +486,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with +

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -502,7 +502,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.3.0/output/pydis_core.utils.members.html b/v9.3.0/output/pydis_core.utils.members.html index 1fa1740f..d5d32ac7 100644 --- a/v9.3.0/output/pydis_core.utils.members.html +++ b/v9.3.0/output/pydis_core.utils.members.html @@ -441,17 +441,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    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 discord.Member or None to indicate the member could not be found.

    +

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

    @@ -461,13 +461,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.4.0/.buildinfo b/v9.4.0/.buildinfo index 7e6ec394..9b32227e 100644 --- a/v9.4.0/.buildinfo +++ b/v9.4.0/.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: 5f5b56d386e2b833f1b6b3971be6fd74 +config: 65a758e56d1462e49ea3c79d6db6af02 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.4.0/_static/pygments.css b/v9.4.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.4.0/_static/pygments.css +++ b/v9.4.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.4.0/output/pydis_core.html b/v9.4.0/output/pydis_core.html index 6d11c1f7..f4fa96a6 100644 --- a/v9.4.0/output/pydis_core.html +++ b/v9.4.0/output/pydis_core.html @@ -445,7 +445,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -578,7 +578,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Optional[Command]

    +

    Optional[Command]

    diff --git a/v9.4.0/output/pydis_core.utils.channel.html b/v9.4.0/output/pydis_core.utils.channel.html index af3d51e6..380458e2 100644 --- a/v9.4.0/output/pydis_core.utils.channel.html +++ b/v9.4.0/output/pydis_core.utils.channel.html @@ -449,20 +449,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -477,7 +477,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.4.0/output/pydis_core.utils.commands.html b/v9.4.0/output/pydis_core.utils.commands.html index ba2f0a63..47c32b8d 100644 --- a/v9.4.0/output/pydis_core.utils.commands.html +++ b/v9.4.0/output/pydis_core.utils.commands.html @@ -448,12 +448,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (Optional[str]) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.4.0/output/pydis_core.utils.cooldown.html b/v9.4.0/output/pydis_core.utils.cooldown.html index 2671a7f2..4ef41f69 100644 --- a/v9.4.0/output/pydis_core.utils.cooldown.html +++ b/v9.4.0/output/pydis_core.utils.cooldown.html @@ -445,7 +445,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.4.0/output/pydis_core.utils.html b/v9.4.0/output/pydis_core.utils.html index 4eed3642..0956046b 100644 --- a/v9.4.0/output/pydis_core.utils.html +++ b/v9.4.0/output/pydis_core.utils.html @@ -452,7 +452,7 @@
    -
    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 +

    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

    diff --git a/v9.4.0/output/pydis_core.utils.interactions.html b/v9.4.0/output/pydis_core.utils.interactions.html index 736549ce..c5c5d265 100644 --- a/v9.4.0/output/pydis_core.utils.interactions.html +++ b/v9.4.0/output/pydis_core.utils.interactions.html @@ -444,7 +444,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -477,7 +477,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -486,7 +486,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with +

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -502,7 +502,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.4.0/output/pydis_core.utils.members.html b/v9.4.0/output/pydis_core.utils.members.html index 6583ace3..e239bdbd 100644 --- a/v9.4.0/output/pydis_core.utils.members.html +++ b/v9.4.0/output/pydis_core.utils.members.html @@ -441,17 +441,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    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 discord.Member or None to indicate the member could not be found.

    +

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

    @@ -461,13 +461,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.4.1/.buildinfo b/v9.4.1/.buildinfo index 59ba16d9..85f062d3 100644 --- a/v9.4.1/.buildinfo +++ b/v9.4.1/.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: d797420063674d54a8d5acd38a2c79da +config: 61dd40e145b5e41d84346bb4ba110584 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.4.1/_static/pygments.css b/v9.4.1/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.4.1/_static/pygments.css +++ b/v9.4.1/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.4.1/output/pydis_core.html b/v9.4.1/output/pydis_core.html index 55ddda7f..3633991d 100644 --- a/v9.4.1/output/pydis_core.html +++ b/v9.4.1/output/pydis_core.html @@ -445,7 +445,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -578,7 +578,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Optional[Command]

    +

    Optional[Command]

    diff --git a/v9.4.1/output/pydis_core.utils.channel.html b/v9.4.1/output/pydis_core.utils.channel.html index 873ca9b4..3edc3e98 100644 --- a/v9.4.1/output/pydis_core.utils.channel.html +++ b/v9.4.1/output/pydis_core.utils.channel.html @@ -449,20 +449,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -477,7 +477,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.4.1/output/pydis_core.utils.commands.html b/v9.4.1/output/pydis_core.utils.commands.html index a803c959..6b9ef95c 100644 --- a/v9.4.1/output/pydis_core.utils.commands.html +++ b/v9.4.1/output/pydis_core.utils.commands.html @@ -448,12 +448,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (Optional[str]) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.4.1/output/pydis_core.utils.cooldown.html b/v9.4.1/output/pydis_core.utils.cooldown.html index a7c95d0b..b63fe1e0 100644 --- a/v9.4.1/output/pydis_core.utils.cooldown.html +++ b/v9.4.1/output/pydis_core.utils.cooldown.html @@ -445,7 +445,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.4.1/output/pydis_core.utils.html b/v9.4.1/output/pydis_core.utils.html index eabb98d0..c8939b05 100644 --- a/v9.4.1/output/pydis_core.utils.html +++ b/v9.4.1/output/pydis_core.utils.html @@ -452,7 +452,7 @@
    -
    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 +

    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

    diff --git a/v9.4.1/output/pydis_core.utils.interactions.html b/v9.4.1/output/pydis_core.utils.interactions.html index 42248b2e..50bb869f 100644 --- a/v9.4.1/output/pydis_core.utils.interactions.html +++ b/v9.4.1/output/pydis_core.utils.interactions.html @@ -444,7 +444,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -477,7 +477,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -486,7 +486,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with +

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -502,7 +502,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.4.1/output/pydis_core.utils.members.html b/v9.4.1/output/pydis_core.utils.members.html index f807c143..5af48b36 100644 --- a/v9.4.1/output/pydis_core.utils.members.html +++ b/v9.4.1/output/pydis_core.utils.members.html @@ -441,17 +441,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    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 discord.Member or None to indicate the member could not be found.

    +

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

    @@ -461,13 +461,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.5.0/.buildinfo b/v9.5.0/.buildinfo index ccf6465d..95dae0f0 100644 --- a/v9.5.0/.buildinfo +++ b/v9.5.0/.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: 45316896577285b9a0131cd69b290dec +config: ad300041b8dfe06c37844132998b9af2 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.5.0/_static/pygments.css b/v9.5.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.5.0/_static/pygments.css +++ b/v9.5.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.5.0/output/pydis_core.html b/v9.5.0/output/pydis_core.html index b4446fbd..e786e9e9 100644 --- a/v9.5.0/output/pydis_core.html +++ b/v9.5.0/output/pydis_core.html @@ -445,7 +445,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -578,7 +578,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Optional[Command]

    +

    Optional[Command]

    diff --git a/v9.5.0/output/pydis_core.utils.channel.html b/v9.5.0/output/pydis_core.utils.channel.html index daccaf65..970fb95c 100644 --- a/v9.5.0/output/pydis_core.utils.channel.html +++ b/v9.5.0/output/pydis_core.utils.channel.html @@ -449,20 +449,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -477,7 +477,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.5.0/output/pydis_core.utils.commands.html b/v9.5.0/output/pydis_core.utils.commands.html index 2517be0e..911e6f92 100644 --- a/v9.5.0/output/pydis_core.utils.commands.html +++ b/v9.5.0/output/pydis_core.utils.commands.html @@ -448,12 +448,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (Optional[str]) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.5.0/output/pydis_core.utils.cooldown.html b/v9.5.0/output/pydis_core.utils.cooldown.html index 3634159f..e6fa4372 100644 --- a/v9.5.0/output/pydis_core.utils.cooldown.html +++ b/v9.5.0/output/pydis_core.utils.cooldown.html @@ -445,7 +445,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.5.0/output/pydis_core.utils.html b/v9.5.0/output/pydis_core.utils.html index 88c004c2..e14f3e92 100644 --- a/v9.5.0/output/pydis_core.utils.html +++ b/v9.5.0/output/pydis_core.utils.html @@ -452,7 +452,7 @@
    -
    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 +

    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

    diff --git a/v9.5.0/output/pydis_core.utils.interactions.html b/v9.5.0/output/pydis_core.utils.interactions.html index c3c3f37e..8d0a1df3 100644 --- a/v9.5.0/output/pydis_core.utils.interactions.html +++ b/v9.5.0/output/pydis_core.utils.interactions.html @@ -444,7 +444,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -477,7 +477,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -486,7 +486,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with +

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -502,7 +502,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.5.0/output/pydis_core.utils.members.html b/v9.5.0/output/pydis_core.utils.members.html index d9fc43cd..62520a11 100644 --- a/v9.5.0/output/pydis_core.utils.members.html +++ b/v9.5.0/output/pydis_core.utils.members.html @@ -441,17 +441,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    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 discord.Member or None to indicate the member could not be found.

    +

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

    @@ -461,13 +461,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.5.1/.buildinfo b/v9.5.1/.buildinfo index 1d6e3f43..812c18b9 100644 --- a/v9.5.1/.buildinfo +++ b/v9.5.1/.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: 492958f9aaf26da2be5ba303226dab6b +config: 666bc6af650440b084de9a5a5e8847b3 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.5.1/_static/pygments.css b/v9.5.1/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.5.1/_static/pygments.css +++ b/v9.5.1/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.5.1/output/pydis_core.html b/v9.5.1/output/pydis_core.html index 1b07f27a..58a96d06 100644 --- a/v9.5.1/output/pydis_core.html +++ b/v9.5.1/output/pydis_core.html @@ -445,7 +445,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -578,7 +578,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Optional[Command]

    +

    Optional[Command]

    diff --git a/v9.5.1/output/pydis_core.utils.channel.html b/v9.5.1/output/pydis_core.utils.channel.html index 7bee02c7..4ad5f562 100644 --- a/v9.5.1/output/pydis_core.utils.channel.html +++ b/v9.5.1/output/pydis_core.utils.channel.html @@ -449,20 +449,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -477,7 +477,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.5.1/output/pydis_core.utils.commands.html b/v9.5.1/output/pydis_core.utils.commands.html index 2fb8f02d..d7c91796 100644 --- a/v9.5.1/output/pydis_core.utils.commands.html +++ b/v9.5.1/output/pydis_core.utils.commands.html @@ -448,12 +448,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (Optional[str]) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.5.1/output/pydis_core.utils.cooldown.html b/v9.5.1/output/pydis_core.utils.cooldown.html index b97b8821..ddddcd35 100644 --- a/v9.5.1/output/pydis_core.utils.cooldown.html +++ b/v9.5.1/output/pydis_core.utils.cooldown.html @@ -445,7 +445,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.5.1/output/pydis_core.utils.html b/v9.5.1/output/pydis_core.utils.html index 41e9f923..03257be7 100644 --- a/v9.5.1/output/pydis_core.utils.html +++ b/v9.5.1/output/pydis_core.utils.html @@ -452,7 +452,7 @@
    -
    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 +

    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

    diff --git a/v9.5.1/output/pydis_core.utils.interactions.html b/v9.5.1/output/pydis_core.utils.interactions.html index 2965481b..fa188dda 100644 --- a/v9.5.1/output/pydis_core.utils.interactions.html +++ b/v9.5.1/output/pydis_core.utils.interactions.html @@ -444,7 +444,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -477,7 +477,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -486,7 +486,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with +

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -502,7 +502,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.5.1/output/pydis_core.utils.members.html b/v9.5.1/output/pydis_core.utils.members.html index 19307cc3..2a70c66f 100644 --- a/v9.5.1/output/pydis_core.utils.members.html +++ b/v9.5.1/output/pydis_core.utils.members.html @@ -441,17 +441,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    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 discord.Member or None to indicate the member could not be found.

    +

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

    @@ -461,13 +461,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.6.0/.buildinfo b/v9.6.0/.buildinfo index 06868e1a..bf58504e 100644 --- a/v9.6.0/.buildinfo +++ b/v9.6.0/.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: 30172ec9c95d3310a345a78fceb01e39 +config: b487288d312d60cfa5af0a12b29f5758 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.6.0/_static/pygments.css b/v9.6.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.6.0/_static/pygments.css +++ b/v9.6.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.6.0/output/pydis_core.html b/v9.6.0/output/pydis_core.html index 9b056501..9db35d62 100644 --- a/v9.6.0/output/pydis_core.html +++ b/v9.6.0/output/pydis_core.html @@ -445,7 +445,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -578,7 +578,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Optional[Command]

    +

    Optional[Command]

    diff --git a/v9.6.0/output/pydis_core.utils.channel.html b/v9.6.0/output/pydis_core.utils.channel.html index e23bf5f9..c13af2e1 100644 --- a/v9.6.0/output/pydis_core.utils.channel.html +++ b/v9.6.0/output/pydis_core.utils.channel.html @@ -449,20 +449,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -477,7 +477,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.6.0/output/pydis_core.utils.commands.html b/v9.6.0/output/pydis_core.utils.commands.html index f21f942e..fc5c29f1 100644 --- a/v9.6.0/output/pydis_core.utils.commands.html +++ b/v9.6.0/output/pydis_core.utils.commands.html @@ -448,12 +448,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (Optional[str]) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.6.0/output/pydis_core.utils.cooldown.html b/v9.6.0/output/pydis_core.utils.cooldown.html index bfc17b22..bb0a5ef1 100644 --- a/v9.6.0/output/pydis_core.utils.cooldown.html +++ b/v9.6.0/output/pydis_core.utils.cooldown.html @@ -445,7 +445,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.6.0/output/pydis_core.utils.html b/v9.6.0/output/pydis_core.utils.html index 6a7ec93e..3ad9bf8e 100644 --- a/v9.6.0/output/pydis_core.utils.html +++ b/v9.6.0/output/pydis_core.utils.html @@ -452,7 +452,7 @@
    -
    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 +

    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

    diff --git a/v9.6.0/output/pydis_core.utils.interactions.html b/v9.6.0/output/pydis_core.utils.interactions.html index 6977c4e3..ac588667 100644 --- a/v9.6.0/output/pydis_core.utils.interactions.html +++ b/v9.6.0/output/pydis_core.utils.interactions.html @@ -444,7 +444,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -477,7 +477,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -486,7 +486,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (Optional[float]) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with +

  • message (Optional[Message]) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -502,7 +502,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.6.0/output/pydis_core.utils.members.html b/v9.6.0/output/pydis_core.utils.members.html index e5d87dd7..b2de36c9 100644 --- a/v9.6.0/output/pydis_core.utils.members.html +++ b/v9.6.0/output/pydis_core.utils.members.html @@ -441,17 +441,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    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 discord.Member or None to indicate the member could not be found.

    +

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

    @@ -461,13 +461,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.7.0/.buildinfo b/v9.7.0/.buildinfo index 7ab3f947..af08e6cc 100644 --- a/v9.7.0/.buildinfo +++ b/v9.7.0/.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: d76bc221e87da12cb8870eb3c02b43d8 +config: 75de059259a3d6b3a621b2c8f71c45ad tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.7.0/_static/pygments.css b/v9.7.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.7.0/_static/pygments.css +++ b/v9.7.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.7.0/output/pydis_core.html b/v9.7.0/output/pydis_core.html index 1fc3ae89..df19bf8a 100644 --- a/v9.7.0/output/pydis_core.html +++ b/v9.7.0/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -580,7 +580,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v9.7.0/output/pydis_core.utils.channel.html b/v9.7.0/output/pydis_core.utils.channel.html index 18d6bc9c..786f6789 100644 --- a/v9.7.0/output/pydis_core.utils.channel.html +++ b/v9.7.0/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.7.0/output/pydis_core.utils.commands.html b/v9.7.0/output/pydis_core.utils.commands.html index cb04c3fe..e30d9287 100644 --- a/v9.7.0/output/pydis_core.utils.commands.html +++ b/v9.7.0/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.7.0/output/pydis_core.utils.cooldown.html b/v9.7.0/output/pydis_core.utils.cooldown.html index 507f0a17..a7b31d5b 100644 --- a/v9.7.0/output/pydis_core.utils.cooldown.html +++ b/v9.7.0/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.7.0/output/pydis_core.utils.error_handling.html b/v9.7.0/output/pydis_core.utils.error_handling.html index b27002bf..1acb3112 100644 --- a/v9.7.0/output/pydis_core.utils.error_handling.html +++ b/v9.7.0/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v9.7.0/output/pydis_core.utils.html b/v9.7.0/output/pydis_core.utils.html index 1ebe6b2e..405cac1b 100644 --- a/v9.7.0/output/pydis_core.utils.html +++ b/v9.7.0/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v9.7.0/output/pydis_core.utils.interactions.html b/v9.7.0/output/pydis_core.utils.interactions.html index 5bbc503c..9f8b0003 100644 --- a/v9.7.0/output/pydis_core.utils.interactions.html +++ b/v9.7.0/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.7.0/output/pydis_core.utils.members.html b/v9.7.0/output/pydis_core.utils.members.html index 0943fdf0..ebf7b941 100644 --- a/v9.7.0/output/pydis_core.utils.members.html +++ b/v9.7.0/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.8.0/.buildinfo b/v9.8.0/.buildinfo index b4c2bafe..ddafc3f3 100644 --- a/v9.8.0/.buildinfo +++ b/v9.8.0/.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: 64e8c956dd12ccae2528d21e2e7ea572 +config: 5f5ce43ab0b01405192f4d0dd5cc5e07 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.8.0/_static/pygments.css b/v9.8.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.8.0/_static/pygments.css +++ b/v9.8.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.8.0/output/pydis_core.html b/v9.8.0/output/pydis_core.html index a5dea916..3e15fc9f 100644 --- a/v9.8.0/output/pydis_core.html +++ b/v9.8.0/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -580,7 +580,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v9.8.0/output/pydis_core.utils.channel.html b/v9.8.0/output/pydis_core.utils.channel.html index f1238b68..7b4b4715 100644 --- a/v9.8.0/output/pydis_core.utils.channel.html +++ b/v9.8.0/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.8.0/output/pydis_core.utils.commands.html b/v9.8.0/output/pydis_core.utils.commands.html index e9de2a75..4b15f3e7 100644 --- a/v9.8.0/output/pydis_core.utils.commands.html +++ b/v9.8.0/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.8.0/output/pydis_core.utils.cooldown.html b/v9.8.0/output/pydis_core.utils.cooldown.html index 89a58adf..a706ba8d 100644 --- a/v9.8.0/output/pydis_core.utils.cooldown.html +++ b/v9.8.0/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.8.0/output/pydis_core.utils.error_handling.html b/v9.8.0/output/pydis_core.utils.error_handling.html index 41225796..ead9513f 100644 --- a/v9.8.0/output/pydis_core.utils.error_handling.html +++ b/v9.8.0/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v9.8.0/output/pydis_core.utils.html b/v9.8.0/output/pydis_core.utils.html index 9a0d93d7..999c3233 100644 --- a/v9.8.0/output/pydis_core.utils.html +++ b/v9.8.0/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v9.8.0/output/pydis_core.utils.interactions.html b/v9.8.0/output/pydis_core.utils.interactions.html index 73b1c3cb..16e414c2 100644 --- a/v9.8.0/output/pydis_core.utils.interactions.html +++ b/v9.8.0/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.8.0/output/pydis_core.utils.members.html b/v9.8.0/output/pydis_core.utils.members.html index fd722550..c0f601e2 100644 --- a/v9.8.0/output/pydis_core.utils.members.html +++ b/v9.8.0/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.9.0/.buildinfo b/v9.9.0/.buildinfo index 6217fd88..ec3ec2b9 100644 --- a/v9.9.0/.buildinfo +++ b/v9.9.0/.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: 0b4a95b24837d9514e2f82ea725e8702 +config: d51838a2cf2c78fec50c1ecbeedc2cfe tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.9.0/_static/pygments.css b/v9.9.0/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.9.0/_static/pygments.css +++ b/v9.9.0/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.9.0/output/pydis_core.html b/v9.9.0/output/pydis_core.html index 440b6b22..ba811a3e 100644 --- a/v9.9.0/output/pydis_core.html +++ b/v9.9.0/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -580,7 +580,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v9.9.0/output/pydis_core.utils.channel.html b/v9.9.0/output/pydis_core.utils.channel.html index 635ffb72..8219d815 100644 --- a/v9.9.0/output/pydis_core.utils.channel.html +++ b/v9.9.0/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.9.0/output/pydis_core.utils.commands.html b/v9.9.0/output/pydis_core.utils.commands.html index 9ac3e86d..3cc58bd0 100644 --- a/v9.9.0/output/pydis_core.utils.commands.html +++ b/v9.9.0/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.9.0/output/pydis_core.utils.cooldown.html b/v9.9.0/output/pydis_core.utils.cooldown.html index 1253cc98..00e00ee9 100644 --- a/v9.9.0/output/pydis_core.utils.cooldown.html +++ b/v9.9.0/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.9.0/output/pydis_core.utils.error_handling.html b/v9.9.0/output/pydis_core.utils.error_handling.html index 5712bc3c..fe6c4d9f 100644 --- a/v9.9.0/output/pydis_core.utils.error_handling.html +++ b/v9.9.0/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v9.9.0/output/pydis_core.utils.html b/v9.9.0/output/pydis_core.utils.html index 27548506..61033707 100644 --- a/v9.9.0/output/pydis_core.utils.html +++ b/v9.9.0/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v9.9.0/output/pydis_core.utils.interactions.html b/v9.9.0/output/pydis_core.utils.interactions.html index 676561bb..004075be 100644 --- a/v9.9.0/output/pydis_core.utils.interactions.html +++ b/v9.9.0/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.9.0/output/pydis_core.utils.members.html b/v9.9.0/output/pydis_core.utils.members.html index 13367450..484fcdf1 100644 --- a/v9.9.0/output/pydis_core.utils.members.html +++ b/v9.9.0/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.9.1/.buildinfo b/v9.9.1/.buildinfo index df921a7e..8e3fa3db 100644 --- a/v9.9.1/.buildinfo +++ b/v9.9.1/.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: 4b45a4d90f971652cf20945264fce1e0 +config: 905b67ea08a3a3911011d4955d356000 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.9.1/_static/pygments.css b/v9.9.1/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.9.1/_static/pygments.css +++ b/v9.9.1/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.9.1/output/pydis_core.html b/v9.9.1/output/pydis_core.html index 1647d081..37858890 100644 --- a/v9.9.1/output/pydis_core.html +++ b/v9.9.1/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -580,7 +580,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v9.9.1/output/pydis_core.utils.channel.html b/v9.9.1/output/pydis_core.utils.channel.html index 8fe6ec5b..0fac184b 100644 --- a/v9.9.1/output/pydis_core.utils.channel.html +++ b/v9.9.1/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.9.1/output/pydis_core.utils.commands.html b/v9.9.1/output/pydis_core.utils.commands.html index 644913ee..701b3f74 100644 --- a/v9.9.1/output/pydis_core.utils.commands.html +++ b/v9.9.1/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.9.1/output/pydis_core.utils.cooldown.html b/v9.9.1/output/pydis_core.utils.cooldown.html index 31602caf..53d5a90f 100644 --- a/v9.9.1/output/pydis_core.utils.cooldown.html +++ b/v9.9.1/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.9.1/output/pydis_core.utils.error_handling.html b/v9.9.1/output/pydis_core.utils.error_handling.html index ed170437..19c5a948 100644 --- a/v9.9.1/output/pydis_core.utils.error_handling.html +++ b/v9.9.1/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v9.9.1/output/pydis_core.utils.html b/v9.9.1/output/pydis_core.utils.html index 4f5c09d8..981cce24 100644 --- a/v9.9.1/output/pydis_core.utils.html +++ b/v9.9.1/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v9.9.1/output/pydis_core.utils.interactions.html b/v9.9.1/output/pydis_core.utils.interactions.html index 8b2228f6..a07e954e 100644 --- a/v9.9.1/output/pydis_core.utils.interactions.html +++ b/v9.9.1/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.9.1/output/pydis_core.utils.members.html b/v9.9.1/output/pydis_core.utils.members.html index 1a519a39..c9604862 100644 --- a/v9.9.1/output/pydis_core.utils.members.html +++ b/v9.9.1/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    diff --git a/v9.9.2/.buildinfo b/v9.9.2/.buildinfo index dc8aa2ac..dd62431a 100644 --- a/v9.9.2/.buildinfo +++ b/v9.9.2/.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: 62e44495cdeb5df003f8266f2fbf8313 +config: 34b4fcf86fb363b6bea6616c7809d8c7 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v9.9.2/_static/pygments.css b/v9.9.2/_static/pygments.css index c2e07c71..02b4b128 100644 --- a/v9.9.2/_static/pygments.css +++ b/v9.9.2/_static/pygments.css @@ -106,17 +106,17 @@ body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body[data-theme="dark"] .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ +body[data-theme="dark"] .highlight .gr { color: #ff3a3a } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ body[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */ body[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body[data-theme="dark"] .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body[data-theme="dark"] .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body[data-theme="dark"] .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body[data-theme="dark"] .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ @@ -192,17 +192,17 @@ body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bol body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ -body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ +body:not([data-theme="light"]) .highlight .gd { color: #ff3a3a } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ +body:not([data-theme="light"]) .highlight .gr { color: #ff3a3a } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ body:not([data-theme="light"]) .highlight .go { color: #cccccc } /* Generic.Output */ body:not([data-theme="light"]) .highlight .gp { color: #aaaaaa } /* Generic.Prompt */ body:not([data-theme="light"]) .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */ body:not([data-theme="light"]) .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */ -body:not([data-theme="light"]) .highlight .gt { color: #d22323 } /* Generic.Traceback */ +body:not([data-theme="light"]) .highlight .gt { color: #ff3a3a } /* Generic.Traceback */ body:not([data-theme="light"]) .highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */ body:not([data-theme="light"]) .highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */ body:not([data-theme="light"]) .highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */ diff --git a/v9.9.2/output/pydis_core.html b/v9.9.2/output/pydis_core.html index 9017cdb7..c689aec8 100644 --- a/v9.9.2/output/pydis_core.html +++ b/v9.9.2/output/pydis_core.html @@ -447,7 +447,7 @@
    class BotBase(*args, guild_id, allowed_roles, http_session, redis_session=None, api_client=None, statsd_url=None, **kwargs)[source]¶
    -

    Bases: Bot

    +

    Bases: Bot

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

    @@ -580,7 +580,7 @@ will not be set and guild_available_but_cache_empty event will be e To remove them, either remove the entire command or manually edit bot.all_commands.

    Return type:
    -

    Command | None

    +

    Command | None

    diff --git a/v9.9.2/output/pydis_core.utils.channel.html b/v9.9.2/output/pydis_core.utils.channel.html index c72b45a6..33e30651 100644 --- a/v9.9.2/output/pydis_core.utils.channel.html +++ b/v9.9.2/output/pydis_core.utils.channel.html @@ -451,20 +451,20 @@
    Parameters:
    Raises:
    Return type:
    -

    GuildChannel

    +

    GuildChannel

    Returns:

    The channel from the ID.

    @@ -479,7 +479,7 @@
    Parameters:
      -

    • channel (TextChannel) – The channel to check.

      • +

    • channel (TextChannel) – The channel to check.

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

    diff --git a/v9.9.2/output/pydis_core.utils.commands.html b/v9.9.2/output/pydis_core.utils.commands.html index 64ce3e80..d45c235d 100644 --- a/v9.9.2/output/pydis_core.utils.commands.html +++ b/v9.9.2/output/pydis_core.utils.commands.html @@ -450,12 +450,12 @@
    Parameters:
      -

    • ctx (Context) – The command’s context

      • +

    • ctx (Context) – The command’s context

    • text (str | None) – The provided text argument of the command (if given)

    Raises:
    -

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    +

    discord.ext.commands.BadArgument – text wasn’t provided and there’s no reply message / reply message content.

    Return type:

    str

    diff --git a/v9.9.2/output/pydis_core.utils.cooldown.html b/v9.9.2/output/pydis_core.utils.cooldown.html index 395b7236..d45fd9e8 100644 --- a/v9.9.2/output/pydis_core.utils.cooldown.html +++ b/v9.9.2/output/pydis_core.utils.cooldown.html @@ -447,7 +447,7 @@
    exception CommandOnCooldown(message, function, /, *args, **kwargs)[source]¶
    -

    Bases: CommandError, Generic[P, R]

    +

    Bases: CommandError, Generic[P, R]

    Raised when a command is invoked while on cooldown.

    diff --git a/v9.9.2/output/pydis_core.utils.error_handling.html b/v9.9.2/output/pydis_core.utils.error_handling.html index a0f75410..462e697c 100644 --- a/v9.9.2/output/pydis_core.utils.error_handling.html +++ b/v9.9.2/output/pydis_core.utils.error_handling.html @@ -450,8 +450,8 @@
    Parameters:
      -

    • error (Forbidden) – The raised discord.Forbidden to check.

      • -

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

      • +

    • error (Forbidden) – The raised discord.Forbidden to check.

      • +

    • message (Message | None) – The message to reply to and include in logs, if error is 90001 and message is provided.

    Return type:
    diff --git a/v9.9.2/output/pydis_core.utils.html b/v9.9.2/output/pydis_core.utils.html index efe15a28..b22364b3 100644 --- a/v9.9.2/output/pydis_core.utils.html +++ b/v9.9.2/output/pydis_core.utils.html @@ -454,7 +454,7 @@
    -
    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 +

    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

    diff --git a/v9.9.2/output/pydis_core.utils.interactions.html b/v9.9.2/output/pydis_core.utils.interactions.html index 0bf3b605..77e9f33c 100644 --- a/v9.9.2/output/pydis_core.utils.interactions.html +++ b/v9.9.2/output/pydis_core.utils.interactions.html @@ -446,7 +446,7 @@
    class DeleteMessageButton(*, style=('secondary', 2), label='Delete', **kwargs)[source]¶
    -

    Bases: Button

    +

    Bases: Button

    A button that can be added to a view to delete the message containing the view on click.

    This button itself carries out no interaction checks, these should be done by the parent view.

    See pydis_core.utils.interactions.ViewWithUserAndRoleCheck for a view that implements basic checks.

    @@ -479,7 +479,7 @@
    class ViewWithUserAndRoleCheck(*, allowed_users, allowed_roles, timeout=180.0, message=None)[source]¶
    -

    Bases: View

    +

    Bases: View

    A view that allows the original invoker and moderators to interact with it.

    Parameters:
    @@ -488,7 +488,7 @@

  • allowed_roles (Sequence[int]) – A sequence of role ids that are allowed to interact with the view.

  • timeout (float | None) – Timeout in seconds from last interaction with the UI before no longer accepting input. If None then there is no timeout.

    • -

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with +

  • message (Message | None) – The message to remove the view from on timeout. This can also be set with view.message = await ctx.send( ... )` , or similar, after the view is instantiated.

    • @@ -504,7 +504,7 @@ If None

    Ensure the user clicking the button is the view invoker, or a moderator.

    Parameters:
    -

    interaction (Interaction) – The interaction that occurred.

    +

    interaction (Interaction) – The interaction that occurred.

    Return type:

    bool

    diff --git a/v9.9.2/output/pydis_core.utils.members.html b/v9.9.2/output/pydis_core.utils.members.html index 39421c44..3c5810b4 100644 --- a/v9.9.2/output/pydis_core.utils.members.html +++ b/v9.9.2/output/pydis_core.utils.members.html @@ -443,17 +443,17 @@

    members¶

    -

    Useful helper functions for interactin with discord.Member objects.

    +

    Useful helper functions for interactin with discord.Member objects.

    async get_or_fetch_member(guild, member_id)[source]¶

    Attempt to get a member from cache; on failure fetch from the API.

    Return type:
    -

    Member | None

    +

    Member | None

    Returns:
    -

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

    +

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

    @@ -463,13 +463,13 @@ async handle_role_change(member, coro, role)[source]¶

    Await the given coro with role as the sole argument.

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

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

    Parameters:
    Return type:
    -- cgit v1.2.3