From a04595198ded086fa2f39201ca5f9afa2f696d4a Mon Sep 17 00:00:00 2001 From: ChrisLovering Date: Sat, 5 Nov 2022 14:20:05 +0000 Subject: Deploying to docs from @ python-discord/bot-core@3f55e7149a3197b7fa41fcf7dc7df47a3a209cfd 🚀 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _static/basic.css | 47 +- _static/debug.css | 2 +- _static/documentation_options.js | 2 +- _static/pygments.css | 1 + _static/skeleton.css | 44 +- index.html | 2 +- main/.buildinfo | 2 +- main/_static/basic.css | 47 +- main/_static/debug.css | 2 +- main/_static/documentation_options.js | 2 +- main/_static/pygments.css | 3 + main/_static/skeleton.css | 44 +- main/changelog.html | 65 +- main/development.html | 48 +- main/genindex.html | 424 ++++++------ main/index.html | 102 +-- main/index_redirect.html | 2 +- main/objects.inv | Bin 1442 -> 1455 bytes main/output/botcore.async_stats.html | 469 ------------- main/output/botcore.exts.html | 411 ------------ main/output/botcore.html | 734 --------------------- main/output/botcore.site_api.html | 617 ----------------- main/output/botcore.utils.caching.html | 483 -------------- main/output/botcore.utils.channel.html | 479 -------------- main/output/botcore.utils.commands.html | 452 ------------- main/output/botcore.utils.cooldown.html | 502 -------------- main/output/botcore.utils.function.html | 493 -------------- main/output/botcore.utils.html | 557 ---------------- main/output/botcore.utils.interactions.html | 521 --------------- main/output/botcore.utils.logging.html | 480 -------------- main/output/botcore.utils.members.html | 465 ------------- main/output/botcore.utils.regex.html | 462 ------------- main/output/botcore.utils.scheduling.html | 595 ----------------- main/output/pydis_core.async_stats.html | 469 +++++++++++++ main/output/pydis_core.exts.html | 411 ++++++++++++ main/output/pydis_core.html | 734 +++++++++++++++++++++ main/output/pydis_core.site_api.html | 617 +++++++++++++++++ main/output/pydis_core.utils.caching.html | 483 ++++++++++++++ main/output/pydis_core.utils.channel.html | 479 ++++++++++++++ main/output/pydis_core.utils.commands.html | 452 +++++++++++++ main/output/pydis_core.utils.cooldown.html | 502 ++++++++++++++ main/output/pydis_core.utils.function.html | 493 ++++++++++++++ main/output/pydis_core.utils.html | 557 ++++++++++++++++ main/output/pydis_core.utils.interactions.html | 521 +++++++++++++++ main/output/pydis_core.utils.logging.html | 480 ++++++++++++++ main/output/pydis_core.utils.members.html | 465 +++++++++++++ main/output/pydis_core.utils.regex.html | 462 +++++++++++++ main/output/pydis_core.utils.scheduling.html | 595 +++++++++++++++++ main/py-modindex.html | 72 +- main/search.html | 36 +- main/searchindex.js | 2 +- main/versions.html | 36 +- v7.1.1/.buildinfo | 2 +- v7.1.1/_static/basic.css | 47 +- v7.1.1/_static/debug.css | 2 +- v7.1.1/_static/pygments.css | 3 + v7.1.1/_static/skeleton.css | 44 +- v7.1.1/changelog.html | 2 +- v7.1.1/index.html | 2 +- v7.1.1/output/botcore.async_stats.html | 22 +- v7.1.1/output/botcore.exts.html | 4 +- v7.1.1/output/botcore.html | 66 +- v7.1.1/output/botcore.site_api.html | 76 +-- v7.1.1/output/botcore.utils.caching.html | 24 +- v7.1.1/output/botcore.utils.channel.html | 24 +- v7.1.1/output/botcore.utils.html | 18 +- v7.1.1/output/botcore.utils.logging.html | 24 +- v7.1.1/output/botcore.utils.members.html | 20 +- v7.1.1/output/botcore.utils.regex.html | 6 +- v7.1.1/output/botcore.utils.scheduling.html | 88 +-- v7.1.1/searchindex.js | 2 +- v7.1.2/.buildinfo | 2 +- v7.1.2/_static/basic.css | 47 +- v7.1.2/_static/debug.css | 2 +- v7.1.2/_static/pygments.css | 3 + v7.1.2/_static/skeleton.css | 44 +- v7.1.2/changelog.html | 2 +- v7.1.2/index.html | 2 +- v7.1.2/output/botcore.async_stats.html | 22 +- v7.1.2/output/botcore.exts.html | 4 +- v7.1.2/output/botcore.html | 66 +- v7.1.2/output/botcore.site_api.html | 76 +-- v7.1.2/output/botcore.utils.caching.html | 24 +- v7.1.2/output/botcore.utils.channel.html | 24 +- v7.1.2/output/botcore.utils.html | 18 +- v7.1.2/output/botcore.utils.logging.html | 24 +- v7.1.2/output/botcore.utils.members.html | 20 +- v7.1.2/output/botcore.utils.regex.html | 6 +- v7.1.2/output/botcore.utils.scheduling.html | 88 +-- v7.1.2/searchindex.js | 2 +- v7.1.3/.buildinfo | 2 +- v7.1.3/_static/basic.css | 47 +- v7.1.3/_static/debug.css | 2 +- v7.1.3/_static/pygments.css | 3 + v7.1.3/_static/skeleton.css | 44 +- v7.1.3/changelog.html | 2 +- v7.1.3/index.html | 2 +- v7.1.3/output/botcore.async_stats.html | 22 +- v7.1.3/output/botcore.exts.html | 4 +- v7.1.3/output/botcore.html | 66 +- v7.1.3/output/botcore.site_api.html | 76 +-- v7.1.3/output/botcore.utils.caching.html | 24 +- v7.1.3/output/botcore.utils.channel.html | 24 +- v7.1.3/output/botcore.utils.html | 18 +- v7.1.3/output/botcore.utils.logging.html | 24 +- v7.1.3/output/botcore.utils.members.html | 20 +- v7.1.3/output/botcore.utils.regex.html | 6 +- v7.1.3/output/botcore.utils.scheduling.html | 88 +-- v7.1.3/searchindex.js | 2 +- v7.2.0/.buildinfo | 2 +- v7.2.0/_static/basic.css | 47 +- v7.2.0/_static/debug.css | 2 +- v7.2.0/_static/pygments.css | 3 + v7.2.0/_static/skeleton.css | 44 +- v7.2.0/changelog.html | 2 +- v7.2.0/index.html | 2 +- v7.2.0/output/botcore.async_stats.html | 22 +- v7.2.0/output/botcore.exts.html | 4 +- v7.2.0/output/botcore.html | 66 +- v7.2.0/output/botcore.site_api.html | 76 +-- v7.2.0/output/botcore.utils.caching.html | 24 +- v7.2.0/output/botcore.utils.channel.html | 24 +- v7.2.0/output/botcore.utils.html | 18 +- v7.2.0/output/botcore.utils.logging.html | 24 +- v7.2.0/output/botcore.utils.members.html | 20 +- v7.2.0/output/botcore.utils.regex.html | 6 +- v7.2.0/output/botcore.utils.scheduling.html | 88 +-- v7.2.0/searchindex.js | 2 +- v7.2.1/.buildinfo | 2 +- v7.2.1/_static/basic.css | 47 +- v7.2.1/_static/debug.css | 2 +- v7.2.1/_static/pygments.css | 3 + v7.2.1/_static/skeleton.css | 44 +- v7.2.1/changelog.html | 2 +- v7.2.1/index.html | 2 +- v7.2.1/output/botcore.async_stats.html | 22 +- v7.2.1/output/botcore.exts.html | 4 +- v7.2.1/output/botcore.html | 66 +- v7.2.1/output/botcore.site_api.html | 78 +-- v7.2.1/output/botcore.utils.caching.html | 24 +- v7.2.1/output/botcore.utils.channel.html | 24 +- v7.2.1/output/botcore.utils.html | 18 +- v7.2.1/output/botcore.utils.logging.html | 24 +- v7.2.1/output/botcore.utils.members.html | 20 +- v7.2.1/output/botcore.utils.regex.html | 6 +- v7.2.1/output/botcore.utils.scheduling.html | 88 +-- v7.2.1/searchindex.js | 2 +- v7.2.2/.buildinfo | 2 +- v7.2.2/_static/basic.css | 47 +- v7.2.2/_static/debug.css | 2 +- v7.2.2/_static/pygments.css | 3 + v7.2.2/_static/skeleton.css | 44 +- v7.2.2/changelog.html | 2 +- v7.2.2/index.html | 2 +- v7.2.2/output/botcore.async_stats.html | 22 +- v7.2.2/output/botcore.exts.html | 4 +- v7.2.2/output/botcore.html | 66 +- v7.2.2/output/botcore.site_api.html | 78 +-- v7.2.2/output/botcore.utils.caching.html | 24 +- v7.2.2/output/botcore.utils.channel.html | 24 +- v7.2.2/output/botcore.utils.html | 18 +- v7.2.2/output/botcore.utils.logging.html | 24 +- v7.2.2/output/botcore.utils.members.html | 20 +- v7.2.2/output/botcore.utils.regex.html | 6 +- v7.2.2/output/botcore.utils.scheduling.html | 88 +-- v7.2.2/searchindex.js | 2 +- v7.3.0/.buildinfo | 2 +- v7.3.0/_static/basic.css | 47 +- v7.3.0/_static/debug.css | 2 +- v7.3.0/_static/pygments.css | 3 + v7.3.0/_static/skeleton.css | 44 +- v7.3.0/changelog.html | 2 +- v7.3.0/index.html | 2 +- v7.3.0/output/botcore.async_stats.html | 22 +- v7.3.0/output/botcore.exts.html | 4 +- v7.3.0/output/botcore.html | 66 +- v7.3.0/output/botcore.site_api.html | 78 +-- v7.3.0/output/botcore.utils.caching.html | 24 +- v7.3.0/output/botcore.utils.channel.html | 24 +- v7.3.0/output/botcore.utils.html | 18 +- v7.3.0/output/botcore.utils.interactions.html | 26 +- v7.3.0/output/botcore.utils.logging.html | 24 +- v7.3.0/output/botcore.utils.members.html | 20 +- v7.3.0/output/botcore.utils.regex.html | 6 +- v7.3.0/output/botcore.utils.scheduling.html | 88 +-- v7.3.0/searchindex.js | 2 +- v7.3.1/.buildinfo | 2 +- v7.3.1/_static/basic.css | 47 +- v7.3.1/_static/debug.css | 2 +- v7.3.1/_static/pygments.css | 3 + v7.3.1/_static/skeleton.css | 44 +- v7.3.1/changelog.html | 2 +- v7.3.1/index.html | 2 +- v7.3.1/output/botcore.async_stats.html | 22 +- v7.3.1/output/botcore.exts.html | 4 +- v7.3.1/output/botcore.html | 66 +- v7.3.1/output/botcore.site_api.html | 78 +-- v7.3.1/output/botcore.utils.caching.html | 24 +- v7.3.1/output/botcore.utils.channel.html | 24 +- v7.3.1/output/botcore.utils.html | 18 +- v7.3.1/output/botcore.utils.interactions.html | 26 +- v7.3.1/output/botcore.utils.logging.html | 24 +- v7.3.1/output/botcore.utils.members.html | 20 +- v7.3.1/output/botcore.utils.regex.html | 6 +- v7.3.1/output/botcore.utils.scheduling.html | 88 +-- v7.3.1/searchindex.js | 2 +- v7.4.0-beta1/.buildinfo | 2 +- v7.4.0-beta1/_static/basic.css | 47 +- v7.4.0-beta1/_static/debug.css | 2 +- v7.4.0-beta1/_static/pygments.css | 3 + v7.4.0-beta1/_static/skeleton.css | 44 +- v7.4.0-beta1/changelog.html | 2 +- v7.4.0-beta1/index.html | 2 +- v7.4.0-beta1/output/botcore.async_stats.html | 22 +- v7.4.0-beta1/output/botcore.exts.html | 4 +- v7.4.0-beta1/output/botcore.html | 66 +- v7.4.0-beta1/output/botcore.site_api.html | 78 +-- v7.4.0-beta1/output/botcore.utils.caching.html | 24 +- v7.4.0-beta1/output/botcore.utils.channel.html | 24 +- v7.4.0-beta1/output/botcore.utils.html | 18 +- .../output/botcore.utils.interactions.html | 32 +- v7.4.0-beta1/output/botcore.utils.logging.html | 24 +- v7.4.0-beta1/output/botcore.utils.members.html | 20 +- v7.4.0-beta1/output/botcore.utils.regex.html | 6 +- v7.4.0-beta1/output/botcore.utils.scheduling.html | 88 +-- v7.4.0-beta1/searchindex.js | 2 +- v7.4.0/.buildinfo | 2 +- v7.4.0/_static/basic.css | 47 +- v7.4.0/_static/debug.css | 2 +- v7.4.0/_static/pygments.css | 3 + v7.4.0/_static/skeleton.css | 44 +- v7.4.0/changelog.html | 2 +- v7.4.0/index.html | 2 +- v7.4.0/output/botcore.async_stats.html | 22 +- v7.4.0/output/botcore.exts.html | 4 +- v7.4.0/output/botcore.html | 66 +- v7.4.0/output/botcore.site_api.html | 78 +-- v7.4.0/output/botcore.utils.caching.html | 24 +- v7.4.0/output/botcore.utils.channel.html | 24 +- v7.4.0/output/botcore.utils.html | 18 +- v7.4.0/output/botcore.utils.interactions.html | 32 +- v7.4.0/output/botcore.utils.logging.html | 24 +- v7.4.0/output/botcore.utils.members.html | 20 +- v7.4.0/output/botcore.utils.regex.html | 6 +- v7.4.0/output/botcore.utils.scheduling.html | 88 +-- v7.4.0/searchindex.js | 2 +- v7.5.0/.buildinfo | 2 +- v7.5.0/_static/basic.css | 47 +- v7.5.0/_static/debug.css | 2 +- v7.5.0/_static/pygments.css | 3 + v7.5.0/_static/skeleton.css | 44 +- v7.5.0/changelog.html | 2 +- v7.5.0/index.html | 2 +- v7.5.0/output/botcore.async_stats.html | 22 +- v7.5.0/output/botcore.exts.html | 4 +- v7.5.0/output/botcore.html | 66 +- v7.5.0/output/botcore.site_api.html | 78 +-- v7.5.0/output/botcore.utils.caching.html | 24 +- v7.5.0/output/botcore.utils.channel.html | 24 +- v7.5.0/output/botcore.utils.commands.html | 16 +- v7.5.0/output/botcore.utils.html | 18 +- v7.5.0/output/botcore.utils.interactions.html | 32 +- v7.5.0/output/botcore.utils.logging.html | 24 +- v7.5.0/output/botcore.utils.members.html | 20 +- v7.5.0/output/botcore.utils.regex.html | 6 +- v7.5.0/output/botcore.utils.scheduling.html | 88 +-- v7.5.0/searchindex.js | 2 +- v8.0.0-beta.1/.buildinfo | 2 +- v8.0.0-beta.1/_static/basic.css | 47 +- v8.0.0-beta.1/_static/debug.css | 2 +- v8.0.0-beta.1/_static/pygments.css | 3 + v8.0.0-beta.1/_static/skeleton.css | 44 +- v8.0.0-beta.1/changelog.html | 2 +- v8.0.0-beta.1/development.html | 2 +- v8.0.0-beta.1/index.html | 2 +- v8.0.0-beta.1/output/botcore.async_stats.html | 22 +- v8.0.0-beta.1/output/botcore.exts.html | 4 +- v8.0.0-beta.1/output/botcore.html | 66 +- v8.0.0-beta.1/output/botcore.site_api.html | 78 +-- v8.0.0-beta.1/output/botcore.utils.caching.html | 24 +- v8.0.0-beta.1/output/botcore.utils.channel.html | 24 +- v8.0.0-beta.1/output/botcore.utils.commands.html | 16 +- v8.0.0-beta.1/output/botcore.utils.html | 18 +- .../output/botcore.utils.interactions.html | 32 +- v8.0.0-beta.1/output/botcore.utils.logging.html | 24 +- v8.0.0-beta.1/output/botcore.utils.members.html | 20 +- v8.0.0-beta.1/output/botcore.utils.regex.html | 6 +- v8.0.0-beta.1/output/botcore.utils.scheduling.html | 88 +-- v8.0.0-beta.1/searchindex.js | 2 +- v8.0.0-beta.2/.buildinfo | 2 +- v8.0.0-beta.2/_static/basic.css | 47 +- v8.0.0-beta.2/_static/debug.css | 2 +- v8.0.0-beta.2/_static/pygments.css | 3 + v8.0.0-beta.2/_static/skeleton.css | 44 +- v8.0.0-beta.2/changelog.html | 2 +- v8.0.0-beta.2/development.html | 2 +- v8.0.0-beta.2/index.html | 2 +- v8.0.0-beta.2/output/botcore.async_stats.html | 22 +- v8.0.0-beta.2/output/botcore.exts.html | 4 +- v8.0.0-beta.2/output/botcore.html | 66 +- v8.0.0-beta.2/output/botcore.site_api.html | 78 +-- v8.0.0-beta.2/output/botcore.utils.caching.html | 24 +- v8.0.0-beta.2/output/botcore.utils.channel.html | 24 +- v8.0.0-beta.2/output/botcore.utils.commands.html | 16 +- v8.0.0-beta.2/output/botcore.utils.html | 18 +- .../output/botcore.utils.interactions.html | 32 +- v8.0.0-beta.2/output/botcore.utils.logging.html | 24 +- v8.0.0-beta.2/output/botcore.utils.members.html | 20 +- v8.0.0-beta.2/output/botcore.utils.regex.html | 6 +- v8.0.0-beta.2/output/botcore.utils.scheduling.html | 88 +-- v8.0.0-beta.2/searchindex.js | 2 +- v8.0.0-beta.3/.buildinfo | 2 +- v8.0.0-beta.3/_static/basic.css | 47 +- v8.0.0-beta.3/_static/debug.css | 2 +- v8.0.0-beta.3/_static/pygments.css | 3 + v8.0.0-beta.3/_static/skeleton.css | 44 +- v8.0.0-beta.3/changelog.html | 2 +- v8.0.0-beta.3/development.html | 2 +- v8.0.0-beta.3/index.html | 2 +- v8.0.0-beta.3/output/botcore.async_stats.html | 22 +- v8.0.0-beta.3/output/botcore.exts.html | 4 +- v8.0.0-beta.3/output/botcore.html | 66 +- v8.0.0-beta.3/output/botcore.site_api.html | 78 +-- v8.0.0-beta.3/output/botcore.utils.caching.html | 24 +- v8.0.0-beta.3/output/botcore.utils.channel.html | 24 +- v8.0.0-beta.3/output/botcore.utils.commands.html | 16 +- v8.0.0-beta.3/output/botcore.utils.html | 18 +- .../output/botcore.utils.interactions.html | 32 +- v8.0.0-beta.3/output/botcore.utils.logging.html | 24 +- v8.0.0-beta.3/output/botcore.utils.members.html | 20 +- v8.0.0-beta.3/output/botcore.utils.regex.html | 6 +- v8.0.0-beta.3/output/botcore.utils.scheduling.html | 88 +-- v8.0.0-beta.3/searchindex.js | 2 +- v8.0.0-beta.4/.buildinfo | 2 +- v8.0.0-beta.4/_static/basic.css | 47 +- v8.0.0-beta.4/_static/debug.css | 2 +- v8.0.0-beta.4/_static/pygments.css | 3 + v8.0.0-beta.4/_static/skeleton.css | 44 +- v8.0.0-beta.4/changelog.html | 2 +- v8.0.0-beta.4/development.html | 2 +- v8.0.0-beta.4/index.html | 2 +- v8.0.0-beta.4/output/botcore.async_stats.html | 22 +- v8.0.0-beta.4/output/botcore.exts.html | 4 +- v8.0.0-beta.4/output/botcore.html | 66 +- v8.0.0-beta.4/output/botcore.site_api.html | 78 +-- v8.0.0-beta.4/output/botcore.utils.caching.html | 24 +- v8.0.0-beta.4/output/botcore.utils.channel.html | 24 +- v8.0.0-beta.4/output/botcore.utils.commands.html | 16 +- v8.0.0-beta.4/output/botcore.utils.html | 18 +- .../output/botcore.utils.interactions.html | 32 +- v8.0.0-beta.4/output/botcore.utils.logging.html | 24 +- v8.0.0-beta.4/output/botcore.utils.members.html | 20 +- v8.0.0-beta.4/output/botcore.utils.regex.html | 6 +- v8.0.0-beta.4/output/botcore.utils.scheduling.html | 88 +-- v8.0.0-beta.4/searchindex.js | 2 +- v8.0.0/.buildinfo | 2 +- v8.0.0/_static/basic.css | 47 +- v8.0.0/_static/debug.css | 2 +- v8.0.0/_static/pygments.css | 3 + v8.0.0/_static/skeleton.css | 44 +- v8.0.0/changelog.html | 2 +- v8.0.0/development.html | 2 +- v8.0.0/index.html | 2 +- v8.0.0/output/botcore.async_stats.html | 22 +- v8.0.0/output/botcore.exts.html | 4 +- v8.0.0/output/botcore.html | 66 +- v8.0.0/output/botcore.site_api.html | 78 +-- v8.0.0/output/botcore.utils.caching.html | 24 +- v8.0.0/output/botcore.utils.channel.html | 24 +- v8.0.0/output/botcore.utils.commands.html | 16 +- v8.0.0/output/botcore.utils.html | 18 +- v8.0.0/output/botcore.utils.interactions.html | 32 +- v8.0.0/output/botcore.utils.logging.html | 24 +- v8.0.0/output/botcore.utils.members.html | 20 +- v8.0.0/output/botcore.utils.regex.html | 6 +- v8.0.0/output/botcore.utils.scheduling.html | 88 +-- v8.0.0/searchindex.js | 2 +- v8.1.0/.buildinfo | 2 +- v8.1.0/_static/basic.css | 47 +- v8.1.0/_static/debug.css | 2 +- v8.1.0/_static/pygments.css | 3 + v8.1.0/_static/skeleton.css | 44 +- v8.1.0/changelog.html | 2 +- v8.1.0/development.html | 2 +- v8.1.0/index.html | 2 +- v8.1.0/output/botcore.async_stats.html | 22 +- v8.1.0/output/botcore.exts.html | 4 +- v8.1.0/output/botcore.html | 66 +- v8.1.0/output/botcore.site_api.html | 78 +-- v8.1.0/output/botcore.utils.caching.html | 24 +- v8.1.0/output/botcore.utils.channel.html | 24 +- v8.1.0/output/botcore.utils.commands.html | 16 +- v8.1.0/output/botcore.utils.html | 18 +- v8.1.0/output/botcore.utils.interactions.html | 32 +- v8.1.0/output/botcore.utils.logging.html | 24 +- v8.1.0/output/botcore.utils.members.html | 20 +- v8.1.0/output/botcore.utils.regex.html | 6 +- v8.1.0/output/botcore.utils.scheduling.html | 88 +-- v8.1.0/searchindex.js | 2 +- v8.2.0/.buildinfo | 2 +- v8.2.0/_static/basic.css | 47 +- v8.2.0/_static/debug.css | 2 +- v8.2.0/_static/pygments.css | 3 + v8.2.0/_static/skeleton.css | 44 +- v8.2.0/changelog.html | 2 +- v8.2.0/development.html | 2 +- v8.2.0/index.html | 2 +- v8.2.0/output/botcore.async_stats.html | 22 +- v8.2.0/output/botcore.exts.html | 4 +- v8.2.0/output/botcore.html | 66 +- v8.2.0/output/botcore.site_api.html | 78 +-- v8.2.0/output/botcore.utils.caching.html | 24 +- v8.2.0/output/botcore.utils.channel.html | 24 +- v8.2.0/output/botcore.utils.commands.html | 16 +- v8.2.0/output/botcore.utils.html | 18 +- v8.2.0/output/botcore.utils.interactions.html | 32 +- v8.2.0/output/botcore.utils.logging.html | 24 +- v8.2.0/output/botcore.utils.members.html | 20 +- v8.2.0/output/botcore.utils.regex.html | 6 +- v8.2.0/output/botcore.utils.scheduling.html | 88 +-- v8.2.0/searchindex.js | 2 +- v8.2.1/.buildinfo | 2 +- v8.2.1/_static/basic.css | 47 +- v8.2.1/_static/debug.css | 2 +- v8.2.1/_static/pygments.css | 3 + v8.2.1/_static/skeleton.css | 44 +- v8.2.1/changelog.html | 2 +- v8.2.1/development.html | 2 +- v8.2.1/index.html | 2 +- v8.2.1/output/botcore.async_stats.html | 22 +- v8.2.1/output/botcore.exts.html | 4 +- v8.2.1/output/botcore.html | 66 +- v8.2.1/output/botcore.site_api.html | 78 +-- v8.2.1/output/botcore.utils.caching.html | 24 +- v8.2.1/output/botcore.utils.channel.html | 24 +- v8.2.1/output/botcore.utils.commands.html | 16 +- v8.2.1/output/botcore.utils.html | 18 +- v8.2.1/output/botcore.utils.interactions.html | 32 +- v8.2.1/output/botcore.utils.logging.html | 24 +- v8.2.1/output/botcore.utils.members.html | 20 +- v8.2.1/output/botcore.utils.regex.html | 6 +- v8.2.1/output/botcore.utils.scheduling.html | 88 +-- v8.2.1/searchindex.js | 2 +- v8.3.0-beta/.buildinfo | 2 +- v8.3.0-beta/_static/basic.css | 47 +- v8.3.0-beta/_static/debug.css | 2 +- v8.3.0-beta/_static/pygments.css | 3 + v8.3.0-beta/_static/skeleton.css | 44 +- v8.3.0-beta/changelog.html | 2 +- v8.3.0-beta/development.html | 2 +- v8.3.0-beta/index.html | 2 +- v8.3.0-beta/output/botcore.async_stats.html | 22 +- v8.3.0-beta/output/botcore.exts.html | 4 +- v8.3.0-beta/output/botcore.html | 66 +- v8.3.0-beta/output/botcore.site_api.html | 78 +-- v8.3.0-beta/output/botcore.utils.caching.html | 24 +- v8.3.0-beta/output/botcore.utils.channel.html | 24 +- v8.3.0-beta/output/botcore.utils.commands.html | 16 +- v8.3.0-beta/output/botcore.utils.cooldown.html | 26 +- v8.3.0-beta/output/botcore.utils.function.html | 38 +- v8.3.0-beta/output/botcore.utils.html | 18 +- v8.3.0-beta/output/botcore.utils.interactions.html | 32 +- v8.3.0-beta/output/botcore.utils.logging.html | 24 +- v8.3.0-beta/output/botcore.utils.members.html | 20 +- v8.3.0-beta/output/botcore.utils.regex.html | 6 +- v8.3.0-beta/output/botcore.utils.scheduling.html | 88 +-- v8.3.0-beta/searchindex.js | 2 +- 467 files changed, 13373 insertions(+), 13282 deletions(-) delete mode 100644 main/output/botcore.async_stats.html delete mode 100644 main/output/botcore.exts.html delete mode 100644 main/output/botcore.html delete mode 100644 main/output/botcore.site_api.html delete mode 100644 main/output/botcore.utils.caching.html delete mode 100644 main/output/botcore.utils.channel.html delete mode 100644 main/output/botcore.utils.commands.html delete mode 100644 main/output/botcore.utils.cooldown.html delete mode 100644 main/output/botcore.utils.function.html delete mode 100644 main/output/botcore.utils.html delete mode 100644 main/output/botcore.utils.interactions.html delete mode 100644 main/output/botcore.utils.logging.html delete mode 100644 main/output/botcore.utils.members.html delete mode 100644 main/output/botcore.utils.regex.html delete mode 100644 main/output/botcore.utils.scheduling.html create mode 100644 main/output/pydis_core.async_stats.html create mode 100644 main/output/pydis_core.exts.html create mode 100644 main/output/pydis_core.html create mode 100644 main/output/pydis_core.site_api.html create mode 100644 main/output/pydis_core.utils.caching.html create mode 100644 main/output/pydis_core.utils.channel.html create mode 100644 main/output/pydis_core.utils.commands.html create mode 100644 main/output/pydis_core.utils.cooldown.html create mode 100644 main/output/pydis_core.utils.function.html create mode 100644 main/output/pydis_core.utils.html create mode 100644 main/output/pydis_core.utils.interactions.html create mode 100644 main/output/pydis_core.utils.logging.html create mode 100644 main/output/pydis_core.utils.members.html create mode 100644 main/output/pydis_core.utils.regex.html create mode 100644 main/output/pydis_core.utils.scheduling.html diff --git a/_static/basic.css b/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/_static/basic.css +++ b/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/_static/debug.css b/_static/debug.css index 3264805c..74d4aec3 100644 --- a/_static/debug.css +++ b/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/_static/documentation_options.js b/_static/documentation_options.js index 36ca838e..2d9f8d2e 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '8.2.1', + VERSION: '9.0.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/_static/pygments.css b/_static/pygments.css index c5d3a660..f227e5c6 100644 --- a/_static/pygments.css +++ b/_static/pygments.css @@ -54,6 +54,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ diff --git a/_static/skeleton.css b/_static/skeleton.css index 01231167..467c878c 100644 --- a/_static/skeleton.css +++ b/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/index.html b/index.html index 2fe06325..fe108a50 100644 --- a/index.html +++ b/index.html @@ -9,7 +9,7 @@ - Bot Core Latest (8.2.1) + Bot Core Latest (9.0.0) diff --git a/main/.buildinfo b/main/.buildinfo index b5309e68..485f662d 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: 4008e062b179c5c83ee1b295380e1bcc +config: 5b75bd61164bb04da56bf743c1b830a3 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/_static/basic.css b/main/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/main/_static/basic.css +++ b/main/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/main/_static/debug.css b/main/_static/debug.css index 3264805c..74d4aec3 100644 --- a/main/_static/debug.css +++ b/main/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js index 36ca838e..2d9f8d2e 100644 --- a/main/_static/documentation_options.js +++ b/main/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '8.2.1', + VERSION: '9.0.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/main/_static/pygments.css b/main/_static/pygments.css index 053cfd3d..75471509 100644 --- a/main/_static/pygments.css +++ b/main/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/main/_static/skeleton.css b/main/_static/skeleton.css index 01231167..467c878c 100644 --- a/main/_static/skeleton.css +++ b/main/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/main/changelog.html b/main/changelog.html index af73debb..54c553ae 100644 --- a/main/changelog.html +++ b/main/changelog.html @@ -2,11 +2,11 @@ - + - Changelog - Bot Core Latest (8.2.1) + Changelog - Bot Core Latest (9.0.0) @@ -127,7 +127,7 @@
-
Bot Core Latest (8.2.1)
 +
Bot Core Latest (9.0.0)
@@ -153,7 +153,7 @@
- Bot Core Latest (8.2.1) + Bot Core Latest (9.0.0)
-
Parameters
+
Parameters:
    -

  • msg (str) – The message to be logged.

    • +

  • msg (str) – The message to be logged.

  • args – Passed to the base log function as is.

  • kwargs – Passed to the base log function as is.

-
Return type
-

None

+
Return type:
+

None

@@ -375,13 +375,13 @@ get_logger(name=None)[source]#

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

-
Parameters
-

name (Optional[str]) – The name given to the logger.

+
Parameters:
+

name (Optional[str]) – The name given to the logger.

-
Return type
+
Return type:

CustomLogger

-
Returns
+
Returns:

An instance of the CustomLogger class.

diff --git a/v7.2.2/output/botcore.utils.members.html b/v7.2.2/output/botcore.utils.members.html index db2834c9..b2bfb7d1 100644 --- a/v7.2.2/output/botcore.utils.members.html +++ b/v7.2.2/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -201,7 +201,7 @@
diff --git a/v7.2.2/output/botcore.utils.regex.html b/v7.2.2/output/botcore.utils.regex.html index beadcdc2..ad4097f8 100644 --- a/v7.2.2/output/botcore.utils.regex.html +++ b/v7.2.2/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -201,7 +201,7 @@
  • - main + main
  • @@ -349,7 +349,7 @@

    Warning

    This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

    +such as urllib.parse.quote().

diff --git a/v7.2.2/output/botcore.utils.scheduling.html b/v7.2.2/output/botcore.utils.scheduling.html index 163890e3..4b777706 100644 --- a/v7.2.2/output/botcore.utils.scheduling.html +++ b/v7.2.2/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -201,7 +201,7 @@
  • - main + main
  • @@ -344,7 +344,7 @@
    class Scheduler(name)[source]#
    -

    Bases: object

    +

    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 instance’s log messages from other instances. Using the name of the class or module containing @@ -358,16 +358,16 @@ the same ID used to schedule it.

    __contains__(task_id)[source]#
    -

    Return True if a task with the given task_id is currently scheduled.

    +

    Return True if a task with the given task_id is currently scheduled.

    -
    Parameters
    -

    task_id (Hashable) – The task to look for.

    +
    Parameters:
    +

    task_id (Hashable) – The task to look for.

    -
    Return type
    -

    bool

    +
    Return type:
    +

    bool

    -
    Returns
    -

    True if the task was found.

    +
    Returns:
    +

    True if the task was found.

    @@ -377,8 +377,8 @@ the same ID used to schedule it.

    __init__(name)[source]#

    Initialize a new Scheduler instance.

    -
    Parameters
    -

    name (str) – The name of the Scheduler. Used in logging, and namespacing.

    +
    Parameters:
    +

    name (str) – The name of the Scheduler. Used in logging, and namespacing.

    @@ -388,11 +388,11 @@ the same ID used to schedule it.

    cancel(task_id)[source]#

    Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

    -
    Parameters
    -

    task_id (Hashable) – The task’s unique ID.

    +
    Parameters:
    +

    task_id (Hashable) – The task’s unique ID.

    -
    Return type
    -

    None

    +
    Return type:
    +

    None

    @@ -402,8 +402,8 @@ the same ID used to schedule it.

    cancel_all()[source]#

    Unschedule all known tasks.

    -
    Return type
    -

    None

    +
    Return type:
    +

    None

    @@ -415,14 +415,14 @@ the same ID used to schedule it.

    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.

    -
    Parameters
    +
    Parameters:
      -

    • task_id (Hashable) – A unique ID to create the task with.

      • -

    • coroutine (Coroutine) – The function to be called.

      • +

    • task_id (Hashable) – A unique ID to create the task with.

      • +

    • coroutine (Coroutine) – The function to be called.

    -
    Return type
    -

    None

    +
    Return type:
    +

    None

    @@ -437,15 +437,15 @@ If timeIf 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.

    -
    Parameters
    +
    Parameters:
      -

    • time (datetime) – The time to start the task.

      • -

    • task_id (Hashable) – A unique ID to create the task with.

      • -

    • coroutine (Coroutine) – The function to be called.

      • +

    • time (datetime) – The time to start the task.

      • +

    • task_id (Hashable) – A unique ID to create the task with.

      • +

    • coroutine (Coroutine) – The function to be called.

    -
    Return type
    -

    None

    +
    Return type:
    +

    None

    @@ -457,15 +457,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

    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.

    -
    Parameters
    +
    Parameters:
      -

    • delay (Union[int, float]) – How long to wait before starting the task.

      • -

    • task_id (Hashable) – A unique ID to create the task with.

      • -

    • coroutine (Coroutine) – The function to be called.

      • +

    • delay (Union[int, float]) – How long to wait before starting the task.

      • +

    • task_id (Hashable) – A unique ID to create the task with.

      • +

    • coroutine (Coroutine) – The function to be called.

    -
    Return type
    -

    None

    +
    Return type:
    +

    None

    @@ -475,23 +475,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
    create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
    -

    Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

    +

    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.

    -
    Parameters
    +
    Parameters:
    -
    Returns
    +
    Returns:

    The wrapped task.

    -
    Return type
    -

    asyncio.Task

    +
    Return type:
    +

    asyncio.Task

    diff --git a/v7.2.2/searchindex.js b/v7.2.2/searchindex.js index 32a3bdc2..ea4fb088 100644 --- a/v7.2.2/searchindex.js +++ b/v7.2.2/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "2": [0, 2], "9th": 0, "juli": 0, "2022": 0, "bug": 0, "98": 0, "onli": [0, 2], "close": [0, 1, 2, 5, 12], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 12], "creat": [0, 2, 3, 7, 12], "1": [0, 9], "30th": 0, "june": 0, "91": 0, "add": [0, 2], "miss": 0, "await": [0, 10], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 9, 10, 12], "self": [0, 2], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 12], "fix": 0, "incorrect": 0, "docstr": 0, "botcor": [0, 1], "util": [0, 1, 2, 7, 9], "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 10], "96": 0, "attempt": [0, 2, 8, 10], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 12], "i": [0, 2, 5, 6, 8, 9, 10, 12], "none": [0, 2, 3, 5, 6, 7, 9, 10, 12], "0": [0, 7, 9], "28th": 0, "support": [0, 3, 6, 12], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 10, 11], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 12], "new": [0, 3, 5, 7, 12], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "3": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 9], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "featur": [0, 2], "78": 0, "4cbe8f5": 0, "thi": [0, 2, 6, 8, 10, 11, 12], "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 12], "out": 0, "10th": 0, "break": 0, "75": 0, "invit": [0, 11], "regex": [0, 2, 6], "longer": 0, "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 12], "url": [0, 2, 5], "safe": 0, "result": [0, 12], "refer": 0, "document": 0, "handl": [0, 10, 12], "captur": [0, 11], "all": [0, 2, 3, 6, 12], "charact": 0, "up": [0, 2], "whitespac": [0, 11], "6": 0, "4": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "timeout": 0, "guild": [0, 2, 10], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 12], "number": 0, "so": [0, 6], "should": [0, 2, 5], "actual": 0, "work": 0, "now": [0, 12], "25th": 0, "69": 0, "us": [0, 2, 3, 5, 6, 8, 9, 10, 11, 12], "get": [0, 2, 5, 8, 10], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 12], "t": [0, 12], "load": [0, 2, 6], "modul": [0, 2, 6, 12], "start": [0, 2, 12], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "": [0, 6, 7, 9, 11, 12], "own": 0, "task": [0, 2, 12], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 12], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 9], "pagin": 0, "also": [0, 6], "basic": 0, "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "allow": [0, 2], "an": [0, 2, 3, 5, 6, 7, 8, 9, 12], "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 12], "specifi": 0, "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 9, 12], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 12], "event": [0, 2, 3, 12], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 12], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 10], "42": 0, "remov": [0, 2], "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 9, 12], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 10, 12], "trace": [0, 6, 9], "import": 0, "can": [0, 12], "function": [0, 2, 7, 8, 9, 10, 12], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 10], "wrapper": [0, 5, 12], "from": [0, 2, 3, 5, 6, 8, 10, 12], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 9, 11], "cach": [0, 2, 6, 8, 10], "logger": [0, 9], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 11], "block": [0, 11], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "17th": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 9], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 9], "guild_id": 2, "allowed_rol": 2, "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 12], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12], "A": [2, 5, 6, 7, 8, 12], "implement": [2, 3, 7, 9], "python": [2, 12], "initialis": [2, 7], "int": [2, 3, 7, 8, 12], "The": [2, 3, 5, 6, 7, 8, 9, 10, 12], "id": [2, 8, 12], "list": 2, "role": [2, 10], "mention": 2, "clientsess": [2, 5], "option": [2, 3, 5, 7, 9, 10], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 12], "server": [2, 11], "If": [2, 5, 12], "given": [2, 3, 6, 8, 9, 10, 12], "oper": [2, 12], "type": [2, 3, 5, 6, 7, 8, 9, 10, 12], "normal": 2, "its": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 12], "instanti": [2, 12], "instead": [2, 12], "connector": 2, "resolv": 2, "save": 2, "them": [2, 12], "all_extens": 2, "ran": 2, "loop": [2, 3, 12], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 12], "messag": [2, 9, 12], "dev": 2, "set": 2, "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 12], "servic": 2, "ensur": [2, 11], "thei": 2, "ar": [2, 7, 11], "name": [2, 6, 9, 12], "alia": [2, 6], "individu": 2, "To": [2, 9], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "gener": [2, 12], "create_socket": [2, 3], "wait": [2, 12], "until": [2, 11], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 12], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 9, 12], "error": [2, 5, 6, 10], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 9], "get_logg": [2, 6, 9], "get_or_fetch_memb": [2, 6, 10], "discord_invit": [2, 6, 11], "formatted_code_regex": [2, 6, 11], "raw_code_regex": [2, 6, 11], "create_task": [2, 6, 12], "delet": [2, 5, 7], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 11], "__str__": [2, 5], "transport": 3, "method": [3, 5, 6, 9], "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 12], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 10, 12], "django": 5, "initi": [5, 12], "token": 5, "authent": 5, "keyword": [5, 6, 9], "argument": [5, 6, 7, 9, 10], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 9, 12], "send": 5, "json": 5, "respons": 5, "bool": [5, 8, 12], "whether": [5, 8], "rais": [5, 8, 10, 12], "ok": 5, "ani": [5, 11, 12], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 12], "http": [5, 11], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 11], "root_alias": 6, "two": 6, "sequenc": 6, "act": 6, "top": 6, "level": [6, 9], "rather": 6, "than": 6, "being": [6, 10], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "ha": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "__contains__": [6, 12], "cancel": [6, 12], "cancel_al": [6, 12], "schedule_at": [6, 12], "schedule_lat": [6, 12], "relat": [7, 9], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 10, 12], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 12], "offset": 7, "provid": [7, 12], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 10], "wrap": [7, 12], "target": 7, "how": [7, 12], "item": 7, "helper": [8, 10], "interact": 8, "variou": 8, "channel_id": 8, "fetch": [8, 10], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 11], "do": 8, "have": [8, 9], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "msg": 9, "sever": 9, "exc_info": 9, "valu": 9, "houston": 9, "we": [9, 10], "interest": 9, "problem": 9, "mypi": 9, "recognis": 9, "interactin": 10, "member_id": 10, "failur": 10, "indic": 10, "could": 10, "found": [10, 12], "coro": [10, 12], "sole": 10, "expect": 10, "add_rol": 10, "remove_rol": 10, "modifi": 10, "purpos": 10, "intend": 10, "regular": 11, "express": 11, "pattern": 11, "similar": 11, "pleas": 11, "sanitis": 11, "output": 11, "someth": 11, "urllib": 11, "pars": 11, "quot": 11, "format": 11, "raw": 11, "execut": 12, "keep": 12, "track": 12, "must": 12, "distinguish": 12, "other": 12, "contain": 12, "suggest": 12, "immedi": 12, "futur": 12, "uniqu": 12, "prematur": 12, "same": 12, "current": 12, "done": 12, "task_id": 12, "hashabl": 12, "look": 12, "unschedul": 12, "identifi": 12, "warn": 12, "doesn": 12, "exist": 12, "known": 12, "alreadi": 12, "prevent": 12, "unawait": 12, "ll": 12, "elsewher": 12, "timezon": 12, "awar": 12, "calcul": 12, "subtract": 12, "na\u00efv": 12, "utc": 12, "past": 12, "datetim": 12, "delai": 12, "after": 12, "union": 12, "float": 12, "long": 12, "suppressed_except": 12, "event_loop": 12, "otherwis": 12, "run": 12, "typevar": 12, "task_return": 12, "tupl": 12}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "logging"], [10, 0, 0, "-", "members"], [11, 0, 0, "-", "regex"], [12, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.logging": [[9, 1, 1, "", "CustomLogger"], [9, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[9, 2, 1, "", "trace"]], "botcore.utils.members": [[10, 4, 1, "", "get_or_fetch_member"], [10, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[11, 5, 1, "", "DISCORD_INVITE"], [11, 5, 1, "", "FORMATTED_CODE_REGEX"], [11, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[12, 1, 1, "", "Scheduler"], [12, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[12, 2, 1, "", "__contains__"], [12, 2, 1, "", "__init__"], [12, 2, 1, "", "cancel"], [12, 2, 1, "", "cancel_all"], [12, 2, 1, "", "schedule"], [12, 2, 1, "", "schedule_at"], [12, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "log": 9, "member": 10, "regex": 11, "schedul": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"members": [[10, "module-botcore.utils.members"]], "Utils": [[6, "module-botcore.utils"]], "Submodules": [[6, "submodules"], [2, "submodules"]], "caching": [[7, "module-botcore.utils.caching"]], "logging": [[9, "module-botcore.utils.logging"]], "channel": [[8, "module-botcore.utils.channel"]], "regex": [[11, "module-botcore.utils.regex"]], "Exts": [[4, "module-botcore.exts"]], "site_api": [[5, "module-botcore.site_api"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "Changelog": [[0, "changelog"]], "async_stats": [[3, "module-botcore.async_stats"]], "scheduling": [[12, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.logging"], [10, "module-botcore.utils.members"], [11, "module-botcore.utils.regex"], [12, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "customlogger (class in botcore.utils.logging)": [[9, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[9, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[9, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[9, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[10, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[10, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[10, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[11, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[11, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[11, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[11, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[12, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[12, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[12, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "2": [0, 2], "9th": 0, "juli": 0, "2022": 0, "bug": 0, "98": 0, "onli": [0, 2], "close": [0, 1, 2, 5, 12], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 12], "creat": [0, 2, 3, 7, 12], "1": [0, 9], "30th": 0, "june": 0, "91": 0, "add": [0, 2], "miss": 0, "await": [0, 10], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 9, 10, 12], "self": [0, 2], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 12], "fix": 0, "incorrect": 0, "docstr": 0, "botcor": [0, 1], "util": [0, 1, 2, 7, 9], "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 10], "96": 0, "attempt": [0, 2, 8, 10], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 12], "i": [0, 2, 5, 6, 8, 9, 10, 12], "none": [0, 2, 3, 5, 6, 7, 9, 10, 12], "0": [0, 7, 9], "28th": 0, "support": [0, 3, 6, 12], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 10, 11], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 12], "new": [0, 3, 5, 7, 12], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "3": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 9], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "featur": [0, 2], "78": 0, "4cbe8f5": 0, "thi": [0, 2, 6, 8, 10, 11, 12], "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 12], "out": 0, "10th": 0, "break": 0, "75": 0, "invit": [0, 11], "regex": [0, 2, 6], "longer": 0, "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 12], "url": [0, 2, 5], "safe": 0, "result": [0, 12], "refer": 0, "document": 0, "handl": [0, 10, 12], "captur": [0, 11], "all": [0, 2, 3, 6, 12], "charact": 0, "up": [0, 2], "whitespac": [0, 11], "6": 0, "4": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "timeout": 0, "guild": [0, 2, 10], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 12], "number": 0, "so": [0, 6], "should": [0, 2, 5], "actual": 0, "work": 0, "now": [0, 12], "25th": 0, "69": 0, "us": [0, 2, 3, 5, 6, 8, 9, 10, 11, 12], "get": [0, 2, 5, 8, 10], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 12], "t": [0, 12], "load": [0, 2, 6], "modul": [0, 2, 6, 12], "start": [0, 2, 12], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "": [0, 6, 7, 9, 11, 12], "own": 0, "task": [0, 2, 12], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 12], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 9], "pagin": 0, "also": [0, 6], "basic": 0, "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "allow": [0, 2], "an": [0, 2, 3, 5, 6, 7, 8, 9, 12], "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 12], "specifi": 0, "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 9, 12], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 12], "event": [0, 2, 3, 12], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 12], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 10], "42": 0, "remov": [0, 2], "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 9, 12], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 10, 12], "trace": [0, 6, 9], "import": 0, "can": [0, 12], "function": [0, 2, 7, 8, 9, 10, 12], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 10], "wrapper": [0, 5, 12], "from": [0, 2, 3, 5, 6, 8, 10, 12], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 9, 11], "cach": [0, 2, 6, 8, 10], "logger": [0, 9], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 11], "block": [0, 11], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "17th": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 9], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 9], "guild_id": 2, "allowed_rol": 2, "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 12], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12], "A": [2, 5, 6, 7, 8, 12], "implement": [2, 3, 7, 9], "python": [2, 12], "initialis": [2, 7], "int": [2, 3, 7, 8, 12], "The": [2, 3, 5, 6, 7, 8, 9, 10, 12], "id": [2, 8, 12], "list": 2, "role": [2, 10], "mention": 2, "clientsess": [2, 5], "option": [2, 3, 5, 7, 9, 10], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 12], "server": [2, 11], "If": [2, 5, 12], "given": [2, 3, 6, 8, 9, 10, 12], "oper": [2, 12], "type": [2, 3, 5, 6, 7, 8, 9, 10, 12], "normal": 2, "its": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 12], "instanti": [2, 12], "instead": [2, 12], "connector": 2, "resolv": 2, "save": 2, "them": [2, 12], "all_extens": 2, "ran": 2, "loop": [2, 3, 12], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 12], "messag": [2, 9, 12], "dev": 2, "set": 2, "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 12], "servic": 2, "ensur": [2, 11], "thei": 2, "ar": [2, 7, 11], "name": [2, 6, 9, 12], "alia": [2, 6], "individu": 2, "To": [2, 9], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "gener": [2, 12], "create_socket": [2, 3], "wait": [2, 12], "until": [2, 11], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 12], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 9, 12], "error": [2, 5, 6, 10], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 9], "get_logg": [2, 6, 9], "get_or_fetch_memb": [2, 6, 10], "discord_invit": [2, 6, 11], "formatted_code_regex": [2, 6, 11], "raw_code_regex": [2, 6, 11], "create_task": [2, 6, 12], "delet": [2, 5, 7], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 11], "__str__": [2, 5], "transport": 3, "method": [3, 5, 6, 9], "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 12], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 10, 12], "django": 5, "initi": [5, 12], "token": 5, "authent": 5, "keyword": [5, 6, 9], "argument": [5, 6, 7, 9, 10], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 9, 12], "send": 5, "json": 5, "respons": 5, "bool": [5, 8, 12], "whether": [5, 8], "rais": [5, 8, 10, 12], "ok": 5, "ani": [5, 11, 12], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 12], "http": [5, 11], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 11], "root_alias": 6, "two": 6, "sequenc": 6, "act": 6, "top": 6, "level": [6, 9], "rather": 6, "than": 6, "being": [6, 10], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "ha": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "__contains__": [6, 12], "cancel": [6, 12], "cancel_al": [6, 12], "schedule_at": [6, 12], "schedule_lat": [6, 12], "relat": [7, 9], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 10, 12], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 12], "offset": 7, "provid": [7, 12], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 10], "wrap": [7, 12], "target": 7, "how": [7, 12], "item": 7, "helper": [8, 10], "interact": 8, "variou": 8, "channel_id": 8, "fetch": [8, 10], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 11], "do": 8, "have": [8, 9], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "msg": 9, "sever": 9, "exc_info": 9, "valu": 9, "houston": 9, "we": [9, 10], "interest": 9, "problem": 9, "mypi": 9, "recognis": 9, "interactin": 10, "member_id": 10, "failur": 10, "indic": 10, "could": 10, "found": [10, 12], "coro": [10, 12], "sole": 10, "expect": 10, "add_rol": 10, "remove_rol": 10, "modifi": 10, "purpos": 10, "intend": 10, "regular": 11, "express": 11, "pattern": 11, "similar": 11, "pleas": 11, "sanitis": 11, "output": 11, "someth": 11, "urllib": 11, "pars": 11, "quot": 11, "format": 11, "raw": 11, "execut": 12, "keep": 12, "track": 12, "must": 12, "distinguish": 12, "other": 12, "contain": 12, "suggest": 12, "immedi": 12, "futur": 12, "uniqu": 12, "prematur": 12, "same": 12, "current": 12, "done": 12, "task_id": 12, "hashabl": 12, "look": 12, "unschedul": 12, "identifi": 12, "warn": 12, "doesn": 12, "exist": 12, "known": 12, "alreadi": 12, "prevent": 12, "unawait": 12, "ll": 12, "elsewher": 12, "timezon": 12, "awar": 12, "calcul": 12, "subtract": 12, "na\u00efv": 12, "utc": 12, "past": 12, "datetim": 12, "delai": 12, "after": 12, "union": 12, "float": 12, "long": 12, "suppressed_except": 12, "event_loop": 12, "otherwis": 12, "run": 12, "typevar": 12, "task_return": 12, "tupl": 12}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "logging"], [10, 0, 0, "-", "members"], [11, 0, 0, "-", "regex"], [12, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.logging": [[9, 1, 1, "", "CustomLogger"], [9, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[9, 2, 1, "", "trace"]], "botcore.utils.members": [[10, 4, 1, "", "get_or_fetch_member"], [10, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[11, 5, 1, "", "DISCORD_INVITE"], [11, 5, 1, "", "FORMATTED_CODE_REGEX"], [11, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[12, 1, 1, "", "Scheduler"], [12, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[12, 2, 1, "", "__contains__"], [12, 2, 1, "", "__init__"], [12, 2, 1, "", "cancel"], [12, 2, 1, "", "cancel_all"], [12, 2, 1, "", "schedule"], [12, 2, 1, "", "schedule_at"], [12, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "log": 9, "member": 10, "regex": 11, "schedul": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Utils": [[6, "module-botcore.utils"]], "Submodules": [[6, "submodules"], [2, "submodules"]], "channel": [[8, "module-botcore.utils.channel"]], "members": [[10, "module-botcore.utils.members"]], "caching": [[7, "module-botcore.utils.caching"]], "regex": [[11, "module-botcore.utils.regex"]], "logging": [[9, "module-botcore.utils.logging"]], "Changelog": [[0, "changelog"]], "Exts": [[4, "module-botcore.exts"]], "site_api": [[5, "module-botcore.site_api"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "async_stats": [[3, "module-botcore.async_stats"]], "scheduling": [[12, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.logging"], [10, "module-botcore.utils.members"], [11, "module-botcore.utils.regex"], [12, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "customlogger (class in botcore.utils.logging)": [[9, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[9, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[9, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[9, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[10, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[10, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[10, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[11, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[11, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[11, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[11, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[12, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[12, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[12, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[12, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v7.3.0/.buildinfo b/v7.3.0/.buildinfo index f05e0ddc..ed97a50e 100644 --- a/v7.3.0/.buildinfo +++ b/v7.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: ad404d466878b66860916f4a9428a908 +config: dea8d696fc24556f3c7d7fdb8e49fac5 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.3.0/_static/basic.css b/v7.3.0/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v7.3.0/_static/basic.css +++ b/v7.3.0/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v7.3.0/_static/debug.css b/v7.3.0/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v7.3.0/_static/debug.css +++ b/v7.3.0/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v7.3.0/_static/pygments.css b/v7.3.0/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v7.3.0/_static/pygments.css +++ b/v7.3.0/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v7.3.0/_static/skeleton.css b/v7.3.0/_static/skeleton.css index 01231167..467c878c 100644 --- a/v7.3.0/_static/skeleton.css +++ b/v7.3.0/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v7.3.0/changelog.html b/v7.3.0/changelog.html index fadaea81..aeab3fed 100644 --- a/v7.3.0/changelog.html +++ b/v7.3.0/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v7.3.0/index.html b/v7.3.0/index.html index 43707a15..70f483f9 100644 --- a/v7.3.0/index.html +++ b/v7.3.0/index.html @@ -2,7 +2,7 @@ - + diff --git a/v7.3.0/output/botcore.async_stats.html b/v7.3.0/output/botcore.async_stats.html index f0f9282a..c5b31a8b 100644 --- a/v7.3.0/output/botcore.async_stats.html +++ b/v7.3.0/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
    • - main + main
    • @@ -352,13 +352,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

      Create a new AsyncStatsClient.

      -
      Parameters
      +
      Parameters:
      @@ -367,10 +367,10 @@
      async create_socket()[source]#
      -

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

      +

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

      -
      Return type
      -

      None

      +
      Return type:
      +

      None

      diff --git a/v7.3.0/output/botcore.exts.html b/v7.3.0/output/botcore.exts.html index a7681d90..983db8d8 100644 --- a/v7.3.0/output/botcore.exts.html +++ b/v7.3.0/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
      • - main + main
      • diff --git a/v7.3.0/output/botcore.html b/v7.3.0/output/botcore.html index d6d2174a..e2cd3906 100644 --- a/v7.3.0/output/botcore.html +++ b/v7.3.0/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
        • - main + main
        • @@ -352,14 +352,14 @@ __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
          +
          Parameters:
          @@ -371,8 +371,8 @@ a dummy statsd client will be created.

          • async add_cog(cog)[source]#

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

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -382,8 +382,8 @@ a dummy statsd client will be created.

          add_command(command)[source]#

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

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -393,8 +393,8 @@ a dummy statsd client will be created.

          clear()[source]#

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

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -404,8 +404,8 @@ a dummy statsd client will be created.

          async close()[source]#

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

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -416,8 +416,8 @@ a dummy statsd client will be created.

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

          This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -427,8 +427,8 @@ a dummy statsd client will be created.

          async log_to_dev_log(message)[source]#

          Log the given message to #dev-log.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -440,8 +440,8 @@ a dummy statsd client will be created.

          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.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

      @@ -451,8 +451,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

      Clear the internal guild available event when self.guild_id becomes unavailable.

      -
      Return type
      -

      None

      +
      Return type:
      +

      None

      @@ -462,8 +462,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

      Ping all required services on setup to ensure they are up before starting.

      -
      Return type
      -

      None

      +
      Return type:
      +

      None

      @@ -475,8 +475,8 @@ will not be set and guild_available_but_cache_empty event will be e

      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
      -

      Optional[Command]

      +
      Return type:
      +

      Optional[Command]

      @@ -489,8 +489,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

      -
      Return type
      -

      None

      +
      Return type:
      +

      None

      @@ -502,8 +502,8 @@ and -
      Return type
      -

      None

      +
      Return type:
      +

      None

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

      Bases: Exception

      +

      Bases: Exception

      Exception class for startup errors.

      diff --git a/v7.3.0/output/botcore.site_api.html b/v7.3.0/output/botcore.site_api.html index 23375df1..bc49fc3e 100644 --- a/v7.3.0/output/botcore.site_api.html +++ b/v7.3.0/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
      • - main + main
      • @@ -345,17 +345,17 @@
        class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
        -

        Bases: object

        +

        Bases: object

        A wrapper for the Django Site API.

        __init__(site_api_url, site_api_token, **session_kwargs)[source]#

        Initialize a new APIClient instance.

        -
        Parameters
        +
        Parameters:
          -

        • site_api_url (str) – The URL of the site API.

          • -

        • site_api_token (str) – The token to use for authentication.

          • +

        • site_api_url (str) – The URL of the site API.

          • +

        • site_api_token (str) – The token to use for authentication.

        • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

        @@ -367,8 +367,8 @@ async close()[source]#

      Close the aiohttp session.

      -
      Return type
      -

      None

      +
      Return type:
      +

      None

      @@ -378,17 +378,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

      Send a DELETE request to the site API and return the JSON response.

      -
      Parameters
      +
      Parameters:
        -

      • endpoint (str) – The endpoint to send the request to.

        • -

      • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

        • +

      • endpoint (str) – The endpoint to send the request to.

        • +

      • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

      • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

      -
      Return type
      -

      Optional[dict]

      +
      Return type:
      +

      Optional[dict]

      -
      Returns
      +
      Returns:

      The JSON response the API returns, or None if the response is 204 No Content.

      @@ -399,8 +399,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

      -
      Return type
      -

      dict

      +
      Return type:
      +

      dict

      @@ -410,17 +410,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

      -
      Parameters
      +
      Parameters:

      • response (aiohttp.ClientResponse) – The response to check.

        • -

      • should_raise (bool) – Whether or not to raise an exception.

        • +

      • should_raise (bool) – Whether or not to raise an exception.

      -
      Raises
      +
      Raises:

      ResponseCodeError – If the response is not OK and should_raise is True.

      -
      Return type
      -

      None

      +
      Return type:
      +

      None

      @@ -430,8 +430,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

      -
      Return type
      -

      dict

      +
      Return type:
      +

      dict

      @@ -441,8 +441,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

      -
      Return type
      -

      dict

      +
      Return type:
      +

      dict

      @@ -452,8 +452,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

      -
      Return type
      -

      dict

      +
      Return type:
      +

      dict

      @@ -463,21 +463,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

      Send an HTTP request to the site API and return the JSON response.

      -
      Parameters
      +
      Parameters:
        -

      • method (str) – The HTTP method to use.

        • -

      • endpoint (str) – The endpoint to send the request to.

        • -

      • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

        • +

      • method (str) – The HTTP method to use.

        • +

      • endpoint (str) – The endpoint to send the request to.

        • +

      • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

      • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

      -
      Return type
      -

      dict

      +
      Return type:
      +

      dict

      -
      Returns
      +
      Returns:

      The JSON response the API returns.

      -
      Raises
      +
      Raises:

      ResponseCodeError – If the response is not OK and raise_for_status is True.

      @@ -488,18 +488,18 @@
      exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
      -

      Bases: ValueError

      +

      Bases: ValueError

      Raised in APIClient.request() when a non-OK HTTP response is received.

      __init__(response, response_json=None, response_text=None)[source]#

      Initialize a new ResponseCodeError instance.

      -
      Parameters
      +
      Parameters:

      • response (aiohttp.ClientResponse) – The response object from the request.

        • -

      • response_json (Optional[dict]) – The JSON response returned from the request, if any.

        • -

      • response_text (Optional[str]) – The text of the request, if any.

        • +

      • response_json (Optional[dict]) – The JSON response returned from the request, if any.

        • +

      • response_text (Optional[str]) – The text of the request, if any.

      diff --git a/v7.3.0/output/botcore.utils.caching.html b/v7.3.0/output/botcore.utils.caching.html index 085c537a..4f96a181 100644 --- a/v7.3.0/output/botcore.utils.caching.html +++ b/v7.3.0/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
      • - main + main
      • @@ -345,7 +345,7 @@
        class AsyncCache(max_size=128)[source]#
        -

        Bases: object

        +

        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.

        @@ -354,13 +354,13 @@ __call__(arg_offset=0)[source]#

        Decorator for async cache.

        -
        Parameters
        -

        arg_offset (int) – The offset for the position of the key argument.

        +
        Parameters:
        +

        arg_offset (int) – The offset for the position of the key argument.

        -
        Return type
        -

        Callable

        +
        Return type:
        +

        Callable

        -
        Returns
        +
        Returns:

        A decorator to wrap the target function.

        @@ -371,8 +371,8 @@ __init__(max_size=128)[source]#

        Initialise a new AsyncCache instance.

        -
        Parameters
        -

        max_size (int) – How many items to store in the cache.

        +
        Parameters:
        +

        max_size (int) – How many items to store in the cache.

        @@ -382,8 +382,8 @@ clear()[source]#

        Clear cache instance.

        -
        Return type
        -

        None

        +
        Return type:
        +

        None

      diff --git a/v7.3.0/output/botcore.utils.channel.html b/v7.3.0/output/botcore.utils.channel.html index 6ce1a8df..6c9ebe82 100644 --- a/v7.3.0/output/botcore.utils.channel.html +++ b/v7.3.0/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
      • - main + main
      • @@ -347,13 +347,13 @@ 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
        +
        Parameters:

        • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

          • -

        • channel_id (int) – The channel to get/fetch.

          • +

        • channel_id (int) – The channel to get/fetch.

        -
        Raises
        +
        Raises:
        -
        Return type
        +
        Return type:

        GuildChannel

        -
        Returns
        +
        Returns:

        The channel from the ID.

        @@ -375,16 +375,16 @@ is_in_category(channel, category_id)[source]#

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

        -
        Parameters
        +
        Parameters:

        • channel (TextChannel) – The channel to check.

          • -

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

          • +

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

        -
        Return type
        -

        bool

        +
        Return type:
        +

        bool

        -
        Returns
        +
        Returns:

        A bool depending on whether the channel is in the category.

        diff --git a/v7.3.0/output/botcore.utils.html b/v7.3.0/output/botcore.utils.html index ad88cbff..cd168d60 100644 --- a/v7.3.0/output/botcore.utils.html +++ b/v7.3.0/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
        • - main + main
        • @@ -355,8 +355,8 @@ that will act as top-level groups rather than being aliases of the command’s g
      -
      Return type
      -

      None

      +
      Return type:
      +

      None

      @@ -366,13 +366,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

      -
      Parameters
      -

      name (str) – The module name to unqualify.

      +
      Parameters:
      +

      name (str) – The module name to unqualify.

      -
      Return type
      -

      str

      +
      Return type:
      +

      str

      -
      Returns
      +
      Returns:

      The unqualified module name.

      diff --git a/v7.3.0/output/botcore.utils.interactions.html b/v7.3.0/output/botcore.utils.interactions.html index 97d93935..4253d733 100644 --- a/v7.3.0/output/botcore.utils.interactions.html +++ b/v7.3.0/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
      • - main + main
      • @@ -349,10 +349,10 @@

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

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

        -
        Parameters
        +
        Parameters:

        • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

          • -

        • label (str) – The label of the button, set to “Delete” if not specified.

          • +

        • label (str) – The label of the button, set to “Delete” if not specified.

        @@ -366,8 +366,8 @@ async callback(interaction)[source]#

        Delete the original message on button click.

        -
        Return type
        -

        None

        +
        Return type:
        +

        None

        @@ -380,11 +380,11 @@

        Bases: View

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

        -
        Parameters
        +
        Parameters:
          -

        • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

          • -

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

        • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

          • +

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

        @@ -399,11 +399,11 @@ If Noneasync interaction_check(interaction)[source]#

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

        -
        Parameters
        +
        Parameters:

        interaction (Interaction) – The interaction that occurred.

        -
        Return type
        -

        bool

        +
        Return type:
        +

        bool

        diff --git a/v7.3.0/output/botcore.utils.logging.html b/v7.3.0/output/botcore.utils.logging.html index 3910108c..e2939c02 100644 --- a/v7.3.0/output/botcore.utils.logging.html +++ b/v7.3.0/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
        • - main + main
        • @@ -345,8 +345,8 @@
          class CustomLogger(name, level=0)[source]#
          -

          Bases: Logger

          -

          Custom implementation of the logging.Logger class with an added trace method.

          +

          Bases: Logger

          +

          Custom implementation of the logging.Logger class with an added trace method.

          trace(msg, *args, **kwargs)[source]#
          @@ -356,15 +356,15 @@
          -
          Parameters
          +
          Parameters:
            -

          • msg (str) – The message to be logged.

            • +

          • msg (str) – The message to be logged.

          • args – Passed to the base log function as is.

          • kwargs – Passed to the base log function as is.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -376,13 +376,13 @@ get_logger(name=None)[source]#

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

          -
          Parameters
          -

          name (Optional[str]) – The name given to the logger.

          +
          Parameters:
          +

          name (Optional[str]) – The name given to the logger.

          -
          Return type
          +
          Return type:

          CustomLogger

          -
          Returns
          +
          Returns:

          An instance of the CustomLogger class.

          diff --git a/v7.3.0/output/botcore.utils.members.html b/v7.3.0/output/botcore.utils.members.html index e61b1a15..ce1793d3 100644 --- a/v7.3.0/output/botcore.utils.members.html +++ b/v7.3.0/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
          diff --git a/v7.3.0/output/botcore.utils.regex.html b/v7.3.0/output/botcore.utils.regex.html index 17891d65..79f629b4 100644 --- a/v7.3.0/output/botcore.utils.regex.html +++ b/v7.3.0/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
          • - main + main
          • @@ -350,7 +350,7 @@

            Warning

            This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

            +such as urllib.parse.quote().

            diff --git a/v7.3.0/output/botcore.utils.scheduling.html b/v7.3.0/output/botcore.utils.scheduling.html index 1399ab29..b15f6739 100644 --- a/v7.3.0/output/botcore.utils.scheduling.html +++ b/v7.3.0/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
            • - main + main
            • @@ -345,7 +345,7 @@
              class Scheduler(name)[source]#
              -

              Bases: object

              +

              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 instance’s log messages from other instances. Using the name of the class or module containing @@ -359,16 +359,16 @@ the same ID used to schedule it.

              __contains__(task_id)[source]#
              -

              Return True if a task with the given task_id is currently scheduled.

              +

              Return True if a task with the given task_id is currently scheduled.

              -
              Parameters
              -

              task_id (Hashable) – The task to look for.

              +
              Parameters:
              +

              task_id (Hashable) – The task to look for.

              -
              Return type
              -

              bool

              +
              Return type:
              +

              bool

              -
              Returns
              -

              True if the task was found.

              +
              Returns:
              +

              True if the task was found.

              @@ -378,8 +378,8 @@ the same ID used to schedule it.

              __init__(name)[source]#

              Initialize a new Scheduler instance.

              -
              Parameters
              -

              name (str) – The name of the Scheduler. Used in logging, and namespacing.

              +
              Parameters:
              +

              name (str) – The name of the Scheduler. Used in logging, and namespacing.

              @@ -389,11 +389,11 @@ the same ID used to schedule it.

              cancel(task_id)[source]#

              Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

              -
              Parameters
              -

              task_id (Hashable) – The task’s unique ID.

              +
              Parameters:
              +

              task_id (Hashable) – The task’s unique ID.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -403,8 +403,8 @@ the same ID used to schedule it.

              cancel_all()[source]#

              Unschedule all known tasks.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -416,14 +416,14 @@ the same ID used to schedule it.

              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.

              -
              Parameters
              +
              Parameters:
                -

              • task_id (Hashable) – A unique ID to create the task with.

                • -

              • coroutine (Coroutine) – The function to be called.

                • +

              • task_id (Hashable) – A unique ID to create the task with.

                • +

              • coroutine (Coroutine) – The function to be called.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

        @@ -438,15 +438,15 @@ If timeIf 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.

        -
        Parameters
        +
        Parameters:
          -

        • time (datetime) – The time to start the task.

          • -

        • task_id (Hashable) – A unique ID to create the task with.

          • -

        • coroutine (Coroutine) – The function to be called.

          • +

        • time (datetime) – The time to start the task.

          • +

        • task_id (Hashable) – A unique ID to create the task with.

          • +

        • coroutine (Coroutine) – The function to be called.

        -
        Return type
        -

        None

        +
        Return type:
        +

        None

      @@ -458,15 +458,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

      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.

      -
      Parameters
      +
      Parameters:
        -

      • delay (Union[int, float]) – How long to wait before starting the task.

        • -

      • task_id (Hashable) – A unique ID to create the task with.

        • -

      • coroutine (Coroutine) – The function to be called.

        • +

      • delay (Union[int, float]) – How long to wait before starting the task.

        • +

      • task_id (Hashable) – A unique ID to create the task with.

        • +

      • coroutine (Coroutine) – The function to be called.

      -
      Return type
      -

      None

      +
      Return type:
      +

      None

      @@ -476,23 +476,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
      create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
      -

      Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

      +

      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.

      -
      Parameters
      +
      Parameters:
      -
      Returns
      +
      Returns:

      The wrapped task.

      -
      Return type
      -

      asyncio.Task

      +
      Return type:
      +

      asyncio.Task

      diff --git a/v7.3.0/searchindex.js b/v7.3.0/searchindex.js index 01c94d40..db3aac57 100644 --- a/v7.3.0/searchindex.js +++ b/v7.3.0/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "3": 0, "0": [0, 7, 9, 10], "16th": 0, "juli": 0, "2022": 0, "featur": [0, 2], "103": 0, "add": [0, 2], "button": [0, 9], "botcor": [0, 1, 9], "util": [0, 1, 2, 7, 9, 10], "interact": [0, 2, 6, 8], "deletemessagebutton": [0, 2, 6, 9], "delet": [0, 2, 5, 7, 9], "messag": [0, 2, 9, 10, 13], "attach": 0, "its": [0, 2], "parent": [0, 9], "view": [0, 9], "gener": [0, 2, 13], "viewwithuserandrolecheck": [0, 2, 6, 9], "onli": [0, 2], "allow": [0, 2, 9], "specifi": [0, 9], "user": [0, 9], "role": [0, 2, 9, 11], "2": [0, 2, 9], "9th": 0, "bug": 0, "98": 0, "close": [0, 1, 2, 5, 13], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 13], "creat": [0, 2, 3, 7, 13], "1": [0, 10], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 10, 11, 13], "self": [0, 2], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "fix": 0, "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 11], "96": 0, "attempt": [0, 2, 8, 11], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 13], "i": [0, 2, 5, 6, 8, 9, 10, 11, 13], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 13], "28th": 0, "support": [0, 3, 6, 13], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 11, 12], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 13], "new": [0, 3, 5, 7, 13], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 10], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "thi": [0, 2, 6, 8, 9, 11, 12, 13], "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 13], "out": [0, 9], "10th": 0, "break": 0, "75": 0, "invit": [0, 12], "regex": [0, 2, 6], "longer": [0, 9], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "url": [0, 2, 5], "safe": 0, "result": [0, 13], "refer": 0, "document": 0, "handl": [0, 11, 13], "captur": [0, 12], "all": [0, 2, 3, 6, 13], "charact": 0, "up": [0, 2], "whitespac": [0, 12], "6": 0, "4": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "timeout": [0, 9], "guild": [0, 2, 11], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 10, 13], "number": 0, "so": [0, 6], "should": [0, 2, 5, 9], "actual": 0, "work": 0, "now": [0, 13], "25th": 0, "69": 0, "us": [0, 2, 3, 5, 6, 8, 10, 11, 12, 13], "get": [0, 2, 5, 8, 11], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 13], "t": [0, 13], "load": [0, 2, 6], "modul": [0, 2, 6, 13], "start": [0, 2, 13], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "": [0, 6, 7, 9, 10, 12, 13], "own": 0, "task": [0, 2, 13], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 13], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 10], "pagin": 0, "also": [0, 6], "basic": [0, 9], "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "an": [0, 2, 3, 5, 6, 7, 8, 10, 13], "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 9, 13], "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 10, 13], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 13], "event": [0, 2, 3, 13], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 9, 13], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 9, 11], "42": 0, "remov": [0, 2], "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 9, 10, 13], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 11, 13], "trace": [0, 6, 10], "import": 0, "can": [0, 9, 13], "function": [0, 2, 7, 8, 10, 11, 13], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 11], "wrapper": [0, 5, 13], "from": [0, 2, 3, 5, 6, 8, 9, 11, 13], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 10, 12], "cach": [0, 2, 6, 8, 11], "logger": [0, 10], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9, 10], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 12], "block": [0, 12], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "17th": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 10], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 10], "guild_id": 2, "allowed_rol": [2, 9], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 10, 13], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13], "A": [2, 5, 6, 7, 8, 9, 13], "implement": [2, 3, 7, 9, 10], "python": [2, 13], "initialis": [2, 7], "int": [2, 3, 7, 8, 9, 13], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "id": [2, 8, 9, 13], "list": 2, "mention": 2, "clientsess": [2, 5], "option": [2, 3, 5, 7, 9, 10, 11], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 13], "server": [2, 12], "If": [2, 5, 9, 13], "given": [2, 3, 6, 8, 10, 11, 13], "oper": [2, 13], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "normal": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 13], "instanti": [2, 13], "instead": [2, 13], "connector": 2, "resolv": 2, "save": 2, "them": [2, 13], "all_extens": 2, "ran": 2, "loop": [2, 3, 13], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 13], "dev": 2, "set": [2, 9], "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 13], "servic": 2, "ensur": [2, 9, 12], "thei": 2, "ar": [2, 7, 9, 12], "name": [2, 6, 10, 13], "alia": [2, 6], "individu": 2, "To": [2, 10], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "create_socket": [2, 3], "wait": [2, 13], "until": [2, 12], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 9, 13], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 10, 13], "error": [2, 5, 6, 11], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 10], "get_logg": [2, 6, 10], "get_or_fetch_memb": [2, 6, 11], "discord_invit": [2, 6, 12], "formatted_code_regex": [2, 6, 12], "raw_code_regex": [2, 6, 12], "create_task": [2, 6, 13], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 12], "__str__": [2, 5], "transport": 3, "method": [3, 5, 6, 10], "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 13], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 11, 13], "django": 5, "initi": [5, 13], "token": 5, "authent": 5, "keyword": [5, 6, 10], "argument": [5, 6, 7, 10, 11], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 10, 13], "send": 5, "json": 5, "respons": 5, "bool": [5, 8, 9, 13], "whether": [5, 8], "rais": [5, 8, 11, 13], "ok": 5, "ani": [5, 12, 13], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 9, 13], "http": [5, 12], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 12], "root_alias": 6, "two": 6, "sequenc": [6, 9], "act": 6, "top": 6, "level": [6, 10], "rather": 6, "than": 6, "being": [6, 11], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "ha": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "callback": [6, 9], "interaction_check": [6, 9], "__contains__": [6, 13], "cancel": [6, 13], "cancel_al": [6, 13], "schedule_at": [6, 13], "schedule_lat": [6, 13], "relat": [7, 10], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 11, 13], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 13], "offset": 7, "provid": [7, 13], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 11], "wrap": [7, 13], "target": 7, "how": [7, 13], "item": 7, "helper": [8, 11], "variou": 8, "channel_id": 8, "fetch": [8, 11], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 12], "do": 8, "have": [8, 10], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "style": 9, "buttonstyl": 9, "secondari": 9, "label": 9, "contain": [9, 13], "click": 9, "itself": 9, "carri": 9, "done": [9, 13], "see": 9, "origin": 9, "allowed_us": 9, "180": 9, "invok": 9, "moder": 9, "who": 9, "float": [9, 13], "last": 9, "ui": 9, "accept": 9, "input": 9, "occur": 9, "msg": 10, "sever": 10, "exc_info": 10, "valu": 10, "houston": 10, "we": [10, 11], "interest": 10, "problem": 10, "mypi": 10, "recognis": 10, "interactin": 11, "member_id": 11, "failur": 11, "indic": 11, "could": 11, "found": [11, 13], "coro": [11, 13], "sole": 11, "expect": 11, "add_rol": 11, "remove_rol": 11, "modifi": 11, "purpos": 11, "intend": 11, "regular": 12, "express": 12, "pattern": 12, "similar": 12, "pleas": 12, "sanitis": 12, "output": 12, "someth": 12, "urllib": 12, "pars": 12, "quot": 12, "format": 12, "raw": 12, "execut": 13, "keep": 13, "track": 13, "must": 13, "distinguish": 13, "other": 13, "suggest": 13, "immedi": 13, "futur": 13, "uniqu": 13, "prematur": 13, "same": 13, "current": 13, "task_id": 13, "hashabl": 13, "look": 13, "unschedul": 13, "identifi": 13, "warn": 13, "doesn": 13, "exist": 13, "known": 13, "alreadi": 13, "prevent": 13, "unawait": 13, "ll": 13, "elsewher": 13, "timezon": 13, "awar": 13, "calcul": 13, "subtract": 13, "na\u00efv": 13, "utc": 13, "past": 13, "datetim": 13, "delai": 13, "after": 13, "union": 13, "long": 13, "suppressed_except": 13, "event_loop": 13, "otherwis": 13, "run": 13, "typevar": 13, "task_return": 13, "tupl": 13}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "interactions"], [10, 0, 0, "-", "logging"], [11, 0, 0, "-", "members"], [12, 0, 0, "-", "regex"], [13, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.interactions": [[9, 1, 1, "", "DeleteMessageButton"], [9, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "interaction_check"]], "botcore.utils.logging": [[10, 1, 1, "", "CustomLogger"], [10, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[10, 2, 1, "", "trace"]], "botcore.utils.members": [[11, 4, 1, "", "get_or_fetch_member"], [11, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[12, 5, 1, "", "DISCORD_INVITE"], [12, 5, 1, "", "FORMATTED_CODE_REGEX"], [12, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[13, 1, 1, "", "Scheduler"], [13, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[13, 2, 1, "", "__contains__"], [13, 2, 1, "", "__init__"], [13, 2, 1, "", "cancel"], [13, 2, 1, "", "cancel_all"], [13, 2, 1, "", "schedule"], [13, 2, 1, "", "schedule_at"], [13, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "interact": 9, "log": 10, "member": 11, "regex": 12, "schedul": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Exts": [[4, "module-botcore.exts"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "site_api": [[5, "module-botcore.site_api"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "Submodules": [[2, "submodules"], [6, "submodules"]], "Utils": [[6, "module-botcore.utils"]], "Changelog": [[0, "changelog"]], "async_stats": [[3, "module-botcore.async_stats"]], "caching": [[7, "module-botcore.utils.caching"]], "members": [[11, "module-botcore.utils.members"]], "logging": [[10, "module-botcore.utils.logging"]], "scheduling": [[13, "module-botcore.utils.scheduling"]], "regex": [[12, "module-botcore.utils.regex"]], "interactions": [[9, "module-botcore.utils.interactions"]], "channel": [[8, "module-botcore.utils.channel"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.interactions"], [10, "module-botcore.utils.logging"], [11, "module-botcore.utils.members"], [12, "module-botcore.utils.regex"], [13, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "deletemessagebutton (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[9, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "customlogger (class in botcore.utils.logging)": [[10, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[10, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[10, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[10, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[11, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[11, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[11, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[12, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[12, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[13, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "3": 0, "0": [0, 7, 9, 10], "16th": 0, "juli": 0, "2022": 0, "featur": [0, 2], "103": 0, "add": [0, 2], "button": [0, 9], "botcor": [0, 1, 9], "util": [0, 1, 2, 7, 9, 10], "interact": [0, 2, 6, 8], "deletemessagebutton": [0, 2, 6, 9], "delet": [0, 2, 5, 7, 9], "messag": [0, 2, 9, 10, 13], "attach": 0, "its": [0, 2], "parent": [0, 9], "view": [0, 9], "gener": [0, 2, 13], "viewwithuserandrolecheck": [0, 2, 6, 9], "onli": [0, 2], "allow": [0, 2, 9], "specifi": [0, 9], "user": [0, 9], "role": [0, 2, 9, 11], "2": [0, 2, 9], "9th": 0, "bug": 0, "98": 0, "close": [0, 1, 2, 5, 13], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 13], "creat": [0, 2, 3, 7, 13], "1": [0, 10], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 10, 11, 13], "self": [0, 2], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "fix": 0, "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 11], "96": 0, "attempt": [0, 2, 8, 11], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 13], "i": [0, 2, 5, 6, 8, 9, 10, 11, 13], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 13], "28th": 0, "support": [0, 3, 6, 13], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 11, 12], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 13], "new": [0, 3, 5, 7, 13], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 10], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "thi": [0, 2, 6, 8, 9, 11, 12, 13], "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 13], "out": [0, 9], "10th": 0, "break": 0, "75": 0, "invit": [0, 12], "regex": [0, 2, 6], "longer": [0, 9], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "url": [0, 2, 5], "safe": 0, "result": [0, 13], "refer": 0, "document": 0, "handl": [0, 11, 13], "captur": [0, 12], "all": [0, 2, 3, 6, 13], "charact": 0, "up": [0, 2], "whitespac": [0, 12], "6": 0, "4": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "timeout": [0, 9], "guild": [0, 2, 11], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 10, 13], "number": 0, "so": [0, 6], "should": [0, 2, 5, 9], "actual": 0, "work": 0, "now": [0, 13], "25th": 0, "69": 0, "us": [0, 2, 3, 5, 6, 8, 10, 11, 12, 13], "get": [0, 2, 5, 8, 11], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 13], "t": [0, 13], "load": [0, 2, 6], "modul": [0, 2, 6, 13], "start": [0, 2, 13], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "": [0, 6, 7, 9, 10, 12, 13], "own": 0, "task": [0, 2, 13], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 13], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 10], "pagin": 0, "also": [0, 6], "basic": [0, 9], "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "an": [0, 2, 3, 5, 6, 7, 8, 10, 13], "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 9, 13], "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 10, 13], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 13], "event": [0, 2, 3, 13], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 9, 13], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 9, 11], "42": 0, "remov": [0, 2], "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 9, 10, 13], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 11, 13], "trace": [0, 6, 10], "import": 0, "can": [0, 9, 13], "function": [0, 2, 7, 8, 10, 11, 13], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 11], "wrapper": [0, 5, 13], "from": [0, 2, 3, 5, 6, 8, 9, 11, 13], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 10, 12], "cach": [0, 2, 6, 8, 11], "logger": [0, 10], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9, 10], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 12], "block": [0, 12], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "17th": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 10], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 10], "guild_id": 2, "allowed_rol": [2, 9], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 10, 13], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13], "A": [2, 5, 6, 7, 8, 9, 13], "implement": [2, 3, 7, 9, 10], "python": [2, 13], "initialis": [2, 7], "int": [2, 3, 7, 8, 9, 13], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "id": [2, 8, 9, 13], "list": 2, "mention": 2, "clientsess": [2, 5], "option": [2, 3, 5, 7, 9, 10, 11], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 13], "server": [2, 12], "If": [2, 5, 9, 13], "given": [2, 3, 6, 8, 10, 11, 13], "oper": [2, 13], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "normal": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 13], "instanti": [2, 13], "instead": [2, 13], "connector": 2, "resolv": 2, "save": 2, "them": [2, 13], "all_extens": 2, "ran": 2, "loop": [2, 3, 13], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 13], "dev": 2, "set": [2, 9], "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 13], "servic": 2, "ensur": [2, 9, 12], "thei": 2, "ar": [2, 7, 9, 12], "name": [2, 6, 10, 13], "alia": [2, 6], "individu": 2, "To": [2, 10], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "create_socket": [2, 3], "wait": [2, 13], "until": [2, 12], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 9, 13], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 10, 13], "error": [2, 5, 6, 11], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 10], "get_logg": [2, 6, 10], "get_or_fetch_memb": [2, 6, 11], "discord_invit": [2, 6, 12], "formatted_code_regex": [2, 6, 12], "raw_code_regex": [2, 6, 12], "create_task": [2, 6, 13], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 12], "__str__": [2, 5], "transport": 3, "method": [3, 5, 6, 10], "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 13], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 11, 13], "django": 5, "initi": [5, 13], "token": 5, "authent": 5, "keyword": [5, 6, 10], "argument": [5, 6, 7, 10, 11], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 10, 13], "send": 5, "json": 5, "respons": 5, "bool": [5, 8, 9, 13], "whether": [5, 8], "rais": [5, 8, 11, 13], "ok": 5, "ani": [5, 12, 13], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 9, 13], "http": [5, 12], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 12], "root_alias": 6, "two": 6, "sequenc": [6, 9], "act": 6, "top": 6, "level": [6, 10], "rather": 6, "than": 6, "being": [6, 11], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "ha": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "callback": [6, 9], "interaction_check": [6, 9], "__contains__": [6, 13], "cancel": [6, 13], "cancel_al": [6, 13], "schedule_at": [6, 13], "schedule_lat": [6, 13], "relat": [7, 10], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 11, 13], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 13], "offset": 7, "provid": [7, 13], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 11], "wrap": [7, 13], "target": 7, "how": [7, 13], "item": 7, "helper": [8, 11], "variou": 8, "channel_id": 8, "fetch": [8, 11], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 12], "do": 8, "have": [8, 10], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "style": 9, "buttonstyl": 9, "secondari": 9, "label": 9, "contain": [9, 13], "click": 9, "itself": 9, "carri": 9, "done": [9, 13], "see": 9, "origin": 9, "allowed_us": 9, "180": 9, "invok": 9, "moder": 9, "who": 9, "float": [9, 13], "last": 9, "ui": 9, "accept": 9, "input": 9, "occur": 9, "msg": 10, "sever": 10, "exc_info": 10, "valu": 10, "houston": 10, "we": [10, 11], "interest": 10, "problem": 10, "mypi": 10, "recognis": 10, "interactin": 11, "member_id": 11, "failur": 11, "indic": 11, "could": 11, "found": [11, 13], "coro": [11, 13], "sole": 11, "expect": 11, "add_rol": 11, "remove_rol": 11, "modifi": 11, "purpos": 11, "intend": 11, "regular": 12, "express": 12, "pattern": 12, "similar": 12, "pleas": 12, "sanitis": 12, "output": 12, "someth": 12, "urllib": 12, "pars": 12, "quot": 12, "format": 12, "raw": 12, "execut": 13, "keep": 13, "track": 13, "must": 13, "distinguish": 13, "other": 13, "suggest": 13, "immedi": 13, "futur": 13, "uniqu": 13, "prematur": 13, "same": 13, "current": 13, "task_id": 13, "hashabl": 13, "look": 13, "unschedul": 13, "identifi": 13, "warn": 13, "doesn": 13, "exist": 13, "known": 13, "alreadi": 13, "prevent": 13, "unawait": 13, "ll": 13, "elsewher": 13, "timezon": 13, "awar": 13, "calcul": 13, "subtract": 13, "na\u00efv": 13, "utc": 13, "past": 13, "datetim": 13, "delai": 13, "after": 13, "union": 13, "long": 13, "suppressed_except": 13, "event_loop": 13, "otherwis": 13, "run": 13, "typevar": 13, "task_return": 13, "tupl": 13}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "interactions"], [10, 0, 0, "-", "logging"], [11, 0, 0, "-", "members"], [12, 0, 0, "-", "regex"], [13, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.interactions": [[9, 1, 1, "", "DeleteMessageButton"], [9, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "interaction_check"]], "botcore.utils.logging": [[10, 1, 1, "", "CustomLogger"], [10, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[10, 2, 1, "", "trace"]], "botcore.utils.members": [[11, 4, 1, "", "get_or_fetch_member"], [11, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[12, 5, 1, "", "DISCORD_INVITE"], [12, 5, 1, "", "FORMATTED_CODE_REGEX"], [12, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[13, 1, 1, "", "Scheduler"], [13, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[13, 2, 1, "", "__contains__"], [13, 2, 1, "", "__init__"], [13, 2, 1, "", "cancel"], [13, 2, 1, "", "cancel_all"], [13, 2, 1, "", "schedule"], [13, 2, 1, "", "schedule_at"], [13, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "interact": 9, "log": 10, "member": 11, "regex": 12, "schedul": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Exts": [[4, "module-botcore.exts"]], "async_stats": [[3, "module-botcore.async_stats"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "Submodules": [[2, "submodules"], [6, "submodules"]], "Changelog": [[0, "changelog"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "site_api": [[5, "module-botcore.site_api"]], "Utils": [[6, "module-botcore.utils"]], "logging": [[10, "module-botcore.utils.logging"]], "members": [[11, "module-botcore.utils.members"]], "interactions": [[9, "module-botcore.utils.interactions"]], "channel": [[8, "module-botcore.utils.channel"]], "caching": [[7, "module-botcore.utils.caching"]], "regex": [[12, "module-botcore.utils.regex"]], "scheduling": [[13, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.interactions"], [10, "module-botcore.utils.logging"], [11, "module-botcore.utils.members"], [12, "module-botcore.utils.regex"], [13, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "deletemessagebutton (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[9, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "customlogger (class in botcore.utils.logging)": [[10, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[10, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[10, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[10, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[11, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[11, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[11, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[12, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[12, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[13, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v7.3.1/.buildinfo b/v7.3.1/.buildinfo index 944a6687..a4dbaf84 100644 --- a/v7.3.1/.buildinfo +++ b/v7.3.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: 6f2ffd2a51bf77d29e17fad8783419a4 +config: 1e7978436805dd6365b6ca08632b9775 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.3.1/_static/basic.css b/v7.3.1/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v7.3.1/_static/basic.css +++ b/v7.3.1/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v7.3.1/_static/debug.css b/v7.3.1/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v7.3.1/_static/debug.css +++ b/v7.3.1/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v7.3.1/_static/pygments.css b/v7.3.1/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v7.3.1/_static/pygments.css +++ b/v7.3.1/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v7.3.1/_static/skeleton.css b/v7.3.1/_static/skeleton.css index 01231167..467c878c 100644 --- a/v7.3.1/_static/skeleton.css +++ b/v7.3.1/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v7.3.1/changelog.html b/v7.3.1/changelog.html index 3699448a..5ab5ae2f 100644 --- a/v7.3.1/changelog.html +++ b/v7.3.1/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v7.3.1/index.html b/v7.3.1/index.html index c8c7e4d0..2255b2a8 100644 --- a/v7.3.1/index.html +++ b/v7.3.1/index.html @@ -2,7 +2,7 @@ - + diff --git a/v7.3.1/output/botcore.async_stats.html b/v7.3.1/output/botcore.async_stats.html index 7ffe054a..ea8d414e 100644 --- a/v7.3.1/output/botcore.async_stats.html +++ b/v7.3.1/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
      • - main + main
      • @@ -352,13 +352,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

        Create a new AsyncStatsClient.

        -
        Parameters
        +
        Parameters:
        @@ -367,10 +367,10 @@
        async create_socket()[source]#
        -

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

        +

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

        -
        Return type
        -

        None

        +
        Return type:
        +

        None

        diff --git a/v7.3.1/output/botcore.exts.html b/v7.3.1/output/botcore.exts.html index ae79a0e0..8e8388ed 100644 --- a/v7.3.1/output/botcore.exts.html +++ b/v7.3.1/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
        • - main + main
        • diff --git a/v7.3.1/output/botcore.html b/v7.3.1/output/botcore.html index d37ad798..c077f9fa 100644 --- a/v7.3.1/output/botcore.html +++ b/v7.3.1/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
          • - main + main
          • @@ -352,14 +352,14 @@ __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
            +
            Parameters:
            @@ -371,8 +371,8 @@ a dummy statsd client will be created.

            • async add_cog(cog)[source]#

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

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -382,8 +382,8 @@ a dummy statsd client will be created.

            add_command(command)[source]#

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

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -393,8 +393,8 @@ a dummy statsd client will be created.

            clear()[source]#

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

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -404,8 +404,8 @@ a dummy statsd client will be created.

            async close()[source]#

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

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -416,8 +416,8 @@ a dummy statsd client will be created.

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

            This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -427,8 +427,8 @@ a dummy statsd client will be created.

            async log_to_dev_log(message)[source]#

            Log the given message to #dev-log.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -440,8 +440,8 @@ a dummy statsd client will be created.

            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.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

        @@ -451,8 +451,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

        Clear the internal guild available event when self.guild_id becomes unavailable.

        -
        Return type
        -

        None

        +
        Return type:
        +

        None

        @@ -462,8 +462,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

        Ping all required services on setup to ensure they are up before starting.

        -
        Return type
        -

        None

        +
        Return type:
        +

        None

        @@ -475,8 +475,8 @@ will not be set and guild_available_but_cache_empty event will be e

        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
        -

        Optional[Command]

        +
        Return type:
        +

        Optional[Command]

        @@ -489,8 +489,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

        -
        Return type
        -

        None

        +
        Return type:
        +

        None

        @@ -502,8 +502,8 @@ and -
        Return type
        -

        None

        +
        Return type:
        +

        None

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

        Bases: Exception

        +

        Bases: Exception

        Exception class for startup errors.

        diff --git a/v7.3.1/output/botcore.site_api.html b/v7.3.1/output/botcore.site_api.html index 2bf5a1f4..0230e934 100644 --- a/v7.3.1/output/botcore.site_api.html +++ b/v7.3.1/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
        • - main + main
        • @@ -345,17 +345,17 @@
          class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
          -

          Bases: object

          +

          Bases: object

          A wrapper for the Django Site API.

          __init__(site_api_url, site_api_token, **session_kwargs)[source]#

          Initialize a new APIClient instance.

          -
          Parameters
          +
          Parameters:
            -

          • site_api_url (str) – The URL of the site API.

            • -

          • site_api_token (str) – The token to use for authentication.

            • +

          • site_api_url (str) – The URL of the site API.

            • +

          • site_api_token (str) – The token to use for authentication.

          • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

          @@ -367,8 +367,8 @@ async close()[source]#

        Close the aiohttp session.

        -
        Return type
        -

        None

        +
        Return type:
        +

        None

        @@ -378,17 +378,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

        Send a DELETE request to the site API and return the JSON response.

        -
        Parameters
        +
        Parameters:
          -

        • endpoint (str) – The endpoint to send the request to.

          • -

        • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

          • +

        • endpoint (str) – The endpoint to send the request to.

          • +

        • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

        • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

        -
        Return type
        -

        Optional[dict]

        +
        Return type:
        +

        Optional[dict]

        -
        Returns
        +
        Returns:

        The JSON response the API returns, or None if the response is 204 No Content.

        @@ -399,8 +399,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

        -
        Return type
        -

        dict

        +
        Return type:
        +

        dict

        @@ -410,17 +410,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

        -
        Parameters
        +
        Parameters:

        • response (aiohttp.ClientResponse) – The response to check.

          • -

        • should_raise (bool) – Whether or not to raise an exception.

          • +

        • should_raise (bool) – Whether or not to raise an exception.

        -
        Raises
        +
        Raises:

        ResponseCodeError – If the response is not OK and should_raise is True.

        -
        Return type
        -

        None

        +
        Return type:
        +

        None

        @@ -430,8 +430,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

        -
        Return type
        -

        dict

        +
        Return type:
        +

        dict

        @@ -441,8 +441,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

        -
        Return type
        -

        dict

        +
        Return type:
        +

        dict

        @@ -452,8 +452,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

        -
        Return type
        -

        dict

        +
        Return type:
        +

        dict

        @@ -463,21 +463,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

        Send an HTTP request to the site API and return the JSON response.

        -
        Parameters
        +
        Parameters:
          -

        • method (str) – The HTTP method to use.

          • -

        • endpoint (str) – The endpoint to send the request to.

          • -

        • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

          • +

        • method (str) – The HTTP method to use.

          • +

        • endpoint (str) – The endpoint to send the request to.

          • +

        • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

        • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

        -
        Return type
        -

        dict

        +
        Return type:
        +

        dict

        -
        Returns
        +
        Returns:

        The JSON response the API returns.

        -
        Raises
        +
        Raises:

        ResponseCodeError – If the response is not OK and raise_for_status is True.

        @@ -488,18 +488,18 @@
        exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
        -

        Bases: ValueError

        +

        Bases: ValueError

        Raised in APIClient.request() when a non-OK HTTP response is received.

        __init__(response, response_json=None, response_text=None)[source]#

        Initialize a new ResponseCodeError instance.

        -
        Parameters
        +
        Parameters:

        • response (aiohttp.ClientResponse) – The response object from the request.

          • -

        • response_json (Optional[dict]) – The JSON response returned from the request, if any.

          • -

        • response_text (Optional[str]) – The text of the request, if any.

          • +

        • response_json (Optional[dict]) – The JSON response returned from the request, if any.

          • +

        • response_text (Optional[str]) – The text of the request, if any.

        diff --git a/v7.3.1/output/botcore.utils.caching.html b/v7.3.1/output/botcore.utils.caching.html index 475c72c4..75a358be 100644 --- a/v7.3.1/output/botcore.utils.caching.html +++ b/v7.3.1/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
        • - main + main
        • @@ -345,7 +345,7 @@
          class AsyncCache(max_size=128)[source]#
          -

          Bases: object

          +

          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.

          @@ -354,13 +354,13 @@ __call__(arg_offset=0)[source]#

          Decorator for async cache.

          -
          Parameters
          -

          arg_offset (int) – The offset for the position of the key argument.

          +
          Parameters:
          +

          arg_offset (int) – The offset for the position of the key argument.

          -
          Return type
          -

          Callable

          +
          Return type:
          +

          Callable

          -
          Returns
          +
          Returns:

          A decorator to wrap the target function.

          @@ -371,8 +371,8 @@ __init__(max_size=128)[source]#

          Initialise a new AsyncCache instance.

          -
          Parameters
          -

          max_size (int) – How many items to store in the cache.

          +
          Parameters:
          +

          max_size (int) – How many items to store in the cache.

          @@ -382,8 +382,8 @@ clear()[source]#

          Clear cache instance.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

        diff --git a/v7.3.1/output/botcore.utils.channel.html b/v7.3.1/output/botcore.utils.channel.html index d0bfb012..1afdc06e 100644 --- a/v7.3.1/output/botcore.utils.channel.html +++ b/v7.3.1/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
        • - main + main
        • @@ -347,13 +347,13 @@ 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
          +
          Parameters:

          • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

            • -

          • channel_id (int) – The channel to get/fetch.

            • +

          • channel_id (int) – The channel to get/fetch.

          -
          Raises
          +
          Raises:
          -
          Return type
          +
          Return type:

          GuildChannel

          -
          Returns
          +
          Returns:

          The channel from the ID.

          @@ -375,16 +375,16 @@ is_in_category(channel, category_id)[source]#

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

          -
          Parameters
          +
          Parameters:

          • channel (TextChannel) – The channel to check.

            • -

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

            • +

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

          -
          Return type
          -

          bool

          +
          Return type:
          +

          bool

          -
          Returns
          +
          Returns:

          A bool depending on whether the channel is in the category.

          diff --git a/v7.3.1/output/botcore.utils.html b/v7.3.1/output/botcore.utils.html index 48e04453..e352bf2a 100644 --- a/v7.3.1/output/botcore.utils.html +++ b/v7.3.1/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
          • - main + main
          • @@ -355,8 +355,8 @@ that will act as top-level groups rather than being aliases of the command’s g
        -
        Return type
        -

        None

        +
        Return type:
        +

        None

        @@ -366,13 +366,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

        -
        Parameters
        -

        name (str) – The module name to unqualify.

        +
        Parameters:
        +

        name (str) – The module name to unqualify.

        -
        Return type
        -

        str

        +
        Return type:
        +

        str

        -
        Returns
        +
        Returns:

        The unqualified module name.

        diff --git a/v7.3.1/output/botcore.utils.interactions.html b/v7.3.1/output/botcore.utils.interactions.html index 11bfc20b..352c35ec 100644 --- a/v7.3.1/output/botcore.utils.interactions.html +++ b/v7.3.1/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
        • - main + main
        • @@ -349,10 +349,10 @@

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

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

          -
          Parameters
          +
          Parameters:

          • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

            • -

          • label (str) – The label of the button, set to “Delete” if not specified.

            • +

          • label (str) – The label of the button, set to “Delete” if not specified.

          @@ -366,8 +366,8 @@ async callback(interaction)[source]#

          Delete the original message on button click.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -380,11 +380,11 @@

          Bases: View

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

          -
          Parameters
          +
          Parameters:
            -

          • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

            • -

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

          • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

            • +

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

          @@ -399,11 +399,11 @@ If Noneasync interaction_check(interaction)[source]#

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

          -
          Parameters
          +
          Parameters:

          interaction (Interaction) – The interaction that occurred.

          -
          Return type
          -

          bool

          +
          Return type:
          +

          bool

          diff --git a/v7.3.1/output/botcore.utils.logging.html b/v7.3.1/output/botcore.utils.logging.html index 50de6434..3bd0138e 100644 --- a/v7.3.1/output/botcore.utils.logging.html +++ b/v7.3.1/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
          • - main + main
          • @@ -345,8 +345,8 @@
            class CustomLogger(name, level=0)[source]#
            -

            Bases: Logger

            -

            Custom implementation of the logging.Logger class with an added trace method.

            +

            Bases: Logger

            +

            Custom implementation of the logging.Logger class with an added trace method.

            trace(msg, *args, **kwargs)[source]#
            @@ -356,15 +356,15 @@
            -
            Parameters
            +
            Parameters:
              -

            • msg (str) – The message to be logged.

              • +

            • msg (str) – The message to be logged.

            • args – Passed to the base log function as is.

            • kwargs – Passed to the base log function as is.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -376,13 +376,13 @@ get_logger(name=None)[source]#

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

            -
            Parameters
            -

            name (Optional[str]) – The name given to the logger.

            +
            Parameters:
            +

            name (Optional[str]) – The name given to the logger.

            -
            Return type
            +
            Return type:

            CustomLogger

            -
            Returns
            +
            Returns:

            An instance of the CustomLogger class.

            diff --git a/v7.3.1/output/botcore.utils.members.html b/v7.3.1/output/botcore.utils.members.html index 718cfde4..1eeb8b2b 100644 --- a/v7.3.1/output/botcore.utils.members.html +++ b/v7.3.1/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
            diff --git a/v7.3.1/output/botcore.utils.regex.html b/v7.3.1/output/botcore.utils.regex.html index 66ac7d77..b2944bd3 100644 --- a/v7.3.1/output/botcore.utils.regex.html +++ b/v7.3.1/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
            • - main + main
            • @@ -350,7 +350,7 @@

              Warning

              This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

              +such as urllib.parse.quote().

              diff --git a/v7.3.1/output/botcore.utils.scheduling.html b/v7.3.1/output/botcore.utils.scheduling.html index 4c061ecb..2b69e568 100644 --- a/v7.3.1/output/botcore.utils.scheduling.html +++ b/v7.3.1/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
              • - main + main
              • @@ -345,7 +345,7 @@
                class Scheduler(name)[source]#
                -

                Bases: object

                +

                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 instance’s log messages from other instances. Using the name of the class or module containing @@ -359,16 +359,16 @@ the same ID used to schedule it.

                __contains__(task_id)[source]#
                -

                Return True if a task with the given task_id is currently scheduled.

                +

                Return True if a task with the given task_id is currently scheduled.

                -
                Parameters
                -

                task_id (Hashable) – The task to look for.

                +
                Parameters:
                +

                task_id (Hashable) – The task to look for.

                -
                Return type
                -

                bool

                +
                Return type:
                +

                bool

                -
                Returns
                -

                True if the task was found.

                +
                Returns:
                +

                True if the task was found.

                @@ -378,8 +378,8 @@ the same ID used to schedule it.

                __init__(name)[source]#

                Initialize a new Scheduler instance.

                -
                Parameters
                -

                name (str) – The name of the Scheduler. Used in logging, and namespacing.

                +
                Parameters:
                +

                name (str) – The name of the Scheduler. Used in logging, and namespacing.

                @@ -389,11 +389,11 @@ the same ID used to schedule it.

                cancel(task_id)[source]#

                Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                -
                Parameters
                -

                task_id (Hashable) – The task’s unique ID.

                +
                Parameters:
                +

                task_id (Hashable) – The task’s unique ID.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -403,8 +403,8 @@ the same ID used to schedule it.

                cancel_all()[source]#

                Unschedule all known tasks.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -416,14 +416,14 @@ the same ID used to schedule it.

                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.

                -
                Parameters
                +
                Parameters:
                  -

                • task_id (Hashable) – A unique ID to create the task with.

                  • -

                • coroutine (Coroutine) – The function to be called.

                  • +

                • task_id (Hashable) – A unique ID to create the task with.

                  • +

                • coroutine (Coroutine) – The function to be called.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

          @@ -438,15 +438,15 @@ If timeIf 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.

          -
          Parameters
          +
          Parameters:
            -

          • time (datetime) – The time to start the task.

            • -

          • task_id (Hashable) – A unique ID to create the task with.

            • -

          • coroutine (Coroutine) – The function to be called.

            • +

          • time (datetime) – The time to start the task.

            • +

          • task_id (Hashable) – A unique ID to create the task with.

            • +

          • coroutine (Coroutine) – The function to be called.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

        @@ -458,15 +458,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

        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.

        -
        Parameters
        +
        Parameters:
          -

        • delay (Union[int, float]) – How long to wait before starting the task.

          • -

        • task_id (Hashable) – A unique ID to create the task with.

          • -

        • coroutine (Coroutine) – The function to be called.

          • +

        • delay (Union[int, float]) – How long to wait before starting the task.

          • +

        • task_id (Hashable) – A unique ID to create the task with.

          • +

        • coroutine (Coroutine) – The function to be called.

        -
        Return type
        -

        None

        +
        Return type:
        +

        None

        @@ -476,23 +476,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
        create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
        -

        Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

        +

        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.

        -
        Parameters
        +
        Parameters:
        -
        Returns
        +
        Returns:

        The wrapped task.

        -
        Return type
        -

        asyncio.Task

        +
        Return type:
        +

        asyncio.Task

        diff --git a/v7.3.1/searchindex.js b/v7.3.1/searchindex.js index 1a2bdb69..28afa3fd 100644 --- a/v7.3.1/searchindex.js +++ b/v7.3.1/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "3": 0, "1": [0, 10], "16th": 0, "juli": 0, "2022": 0, "bug": 0, "104": 0, "fix": 0, "botcor": [0, 1, 9], "util": [0, 1, 2, 7, 9, 10], "interact": [0, 2, 6, 8], "deletemessagebutton": [0, 2, 6, 9], "work": 0, "due": 0, "us": [0, 2, 3, 5, 6, 8, 10, 11, 12, 13], "wrong": 0, "delet": [0, 2, 5, 7, 9], "method": [0, 3, 5, 6, 10], "0": [0, 7, 9, 10], "featur": [0, 2], "103": 0, "add": [0, 2], "button": [0, 9], "messag": [0, 2, 9, 10, 13], "attach": 0, "its": [0, 2], "parent": [0, 9], "view": [0, 9], "gener": [0, 2, 13], "viewwithuserandrolecheck": [0, 2, 6, 9], "onli": [0, 2], "allow": [0, 2, 9], "specifi": [0, 9], "user": [0, 9], "role": [0, 2, 9, 11], "2": [0, 2, 9], "9th": 0, "98": 0, "close": [0, 1, 2, 5, 13], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 13], "creat": [0, 2, 3, 7, 13], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 10, 11, 13], "self": [0, 2], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 11], "96": 0, "attempt": [0, 2, 8, 11], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 13], "i": [0, 2, 5, 6, 8, 9, 10, 11, 13], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 13], "28th": 0, "support": [0, 3, 6, 13], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 11, 12], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 13], "new": [0, 3, 5, 7, 13], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 10], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "thi": [0, 2, 6, 8, 9, 11, 12, 13], "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 13], "out": [0, 9], "10th": 0, "break": 0, "75": 0, "invit": [0, 12], "regex": [0, 2, 6], "longer": [0, 9], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "url": [0, 2, 5], "safe": 0, "result": [0, 13], "refer": 0, "document": 0, "handl": [0, 11, 13], "captur": [0, 12], "all": [0, 2, 3, 6, 13], "charact": 0, "up": [0, 2], "whitespac": [0, 12], "6": 0, "4": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "timeout": [0, 9], "guild": [0, 2, 11], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 10, 13], "number": 0, "so": [0, 6], "should": [0, 2, 5, 9], "actual": 0, "now": [0, 13], "25th": 0, "69": 0, "get": [0, 2, 5, 8, 11], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 13], "t": [0, 13], "load": [0, 2, 6], "modul": [0, 2, 6, 13], "start": [0, 2, 13], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "": [0, 6, 7, 9, 10, 12, 13], "own": 0, "task": [0, 2, 13], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 13], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 10], "pagin": 0, "also": [0, 6], "basic": [0, 9], "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "an": [0, 2, 3, 5, 6, 7, 8, 10, 13], "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 9, 13], "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 10, 13], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 13], "event": [0, 2, 3, 13], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 9, 13], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 9, 11], "42": 0, "remov": [0, 2], "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 9, 10, 13], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 11, 13], "trace": [0, 6, 10], "import": 0, "can": [0, 9, 13], "function": [0, 2, 7, 8, 10, 11, 13], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 11], "wrapper": [0, 5, 13], "from": [0, 2, 3, 5, 6, 8, 9, 11, 13], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 10, 12], "cach": [0, 2, 6, 8, 11], "logger": [0, 10], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9, 10], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 12], "block": [0, 12], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "17th": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 10], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 10], "guild_id": 2, "allowed_rol": [2, 9], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 10, 13], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13], "A": [2, 5, 6, 7, 8, 9, 13], "implement": [2, 3, 7, 9, 10], "python": [2, 13], "initialis": [2, 7], "int": [2, 3, 7, 8, 9, 13], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "id": [2, 8, 9, 13], "list": 2, "mention": 2, "clientsess": [2, 5], "option": [2, 3, 5, 7, 9, 10, 11], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 13], "server": [2, 12], "If": [2, 5, 9, 13], "given": [2, 3, 6, 8, 10, 11, 13], "oper": [2, 13], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "normal": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 13], "instanti": [2, 13], "instead": [2, 13], "connector": 2, "resolv": 2, "save": 2, "them": [2, 13], "all_extens": 2, "ran": 2, "loop": [2, 3, 13], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 13], "dev": 2, "set": [2, 9], "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 13], "servic": 2, "ensur": [2, 9, 12], "thei": 2, "ar": [2, 7, 9, 12], "name": [2, 6, 10, 13], "alia": [2, 6], "individu": 2, "To": [2, 10], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "create_socket": [2, 3], "wait": [2, 13], "until": [2, 12], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 9, 13], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 10, 13], "error": [2, 5, 6, 11], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 10], "get_logg": [2, 6, 10], "get_or_fetch_memb": [2, 6, 11], "discord_invit": [2, 6, 12], "formatted_code_regex": [2, 6, 12], "raw_code_regex": [2, 6, 12], "create_task": [2, 6, 13], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 12], "__str__": [2, 5], "transport": 3, "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 13], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 11, 13], "django": 5, "initi": [5, 13], "token": 5, "authent": 5, "keyword": [5, 6, 10], "argument": [5, 6, 7, 10, 11], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 10, 13], "send": 5, "json": 5, "respons": 5, "bool": [5, 8, 9, 13], "whether": [5, 8], "rais": [5, 8, 11, 13], "ok": 5, "ani": [5, 12, 13], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 9, 13], "http": [5, 12], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 12], "root_alias": 6, "two": 6, "sequenc": [6, 9], "act": 6, "top": 6, "level": [6, 10], "rather": 6, "than": 6, "being": [6, 11], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "ha": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "callback": [6, 9], "interaction_check": [6, 9], "__contains__": [6, 13], "cancel": [6, 13], "cancel_al": [6, 13], "schedule_at": [6, 13], "schedule_lat": [6, 13], "relat": [7, 10], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 11, 13], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 13], "offset": 7, "provid": [7, 13], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 11], "wrap": [7, 13], "target": 7, "how": [7, 13], "item": 7, "helper": [8, 11], "variou": 8, "channel_id": 8, "fetch": [8, 11], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 12], "do": 8, "have": [8, 10], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "style": 9, "buttonstyl": 9, "secondari": 9, "label": 9, "contain": [9, 13], "click": 9, "itself": 9, "carri": 9, "done": [9, 13], "see": 9, "origin": 9, "allowed_us": 9, "180": 9, "invok": 9, "moder": 9, "who": 9, "float": [9, 13], "last": 9, "ui": 9, "accept": 9, "input": 9, "occur": 9, "msg": 10, "sever": 10, "exc_info": 10, "valu": 10, "houston": 10, "we": [10, 11], "interest": 10, "problem": 10, "mypi": 10, "recognis": 10, "interactin": 11, "member_id": 11, "failur": 11, "indic": 11, "could": 11, "found": [11, 13], "coro": [11, 13], "sole": 11, "expect": 11, "add_rol": 11, "remove_rol": 11, "modifi": 11, "purpos": 11, "intend": 11, "regular": 12, "express": 12, "pattern": 12, "similar": 12, "pleas": 12, "sanitis": 12, "output": 12, "someth": 12, "urllib": 12, "pars": 12, "quot": 12, "format": 12, "raw": 12, "execut": 13, "keep": 13, "track": 13, "must": 13, "distinguish": 13, "other": 13, "suggest": 13, "immedi": 13, "futur": 13, "uniqu": 13, "prematur": 13, "same": 13, "current": 13, "task_id": 13, "hashabl": 13, "look": 13, "unschedul": 13, "identifi": 13, "warn": 13, "doesn": 13, "exist": 13, "known": 13, "alreadi": 13, "prevent": 13, "unawait": 13, "ll": 13, "elsewher": 13, "timezon": 13, "awar": 13, "calcul": 13, "subtract": 13, "na\u00efv": 13, "utc": 13, "past": 13, "datetim": 13, "delai": 13, "after": 13, "union": 13, "long": 13, "suppressed_except": 13, "event_loop": 13, "otherwis": 13, "run": 13, "typevar": 13, "task_return": 13, "tupl": 13}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "interactions"], [10, 0, 0, "-", "logging"], [11, 0, 0, "-", "members"], [12, 0, 0, "-", "regex"], [13, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.interactions": [[9, 1, 1, "", "DeleteMessageButton"], [9, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "interaction_check"]], "botcore.utils.logging": [[10, 1, 1, "", "CustomLogger"], [10, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[10, 2, 1, "", "trace"]], "botcore.utils.members": [[11, 4, 1, "", "get_or_fetch_member"], [11, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[12, 5, 1, "", "DISCORD_INVITE"], [12, 5, 1, "", "FORMATTED_CODE_REGEX"], [12, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[13, 1, 1, "", "Scheduler"], [13, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[13, 2, 1, "", "__contains__"], [13, 2, 1, "", "__init__"], [13, 2, 1, "", "cancel"], [13, 2, 1, "", "cancel_all"], [13, 2, 1, "", "schedule"], [13, 2, 1, "", "schedule_at"], [13, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "interact": 9, "log": 10, "member": 11, "regex": 12, "schedul": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Utils": [[6, "module-botcore.utils"]], "Submodules": [[6, "submodules"], [2, "submodules"]], "Exts": [[4, "module-botcore.exts"]], "site_api": [[5, "module-botcore.site_api"]], "async_stats": [[3, "module-botcore.async_stats"]], "Changelog": [[0, "changelog"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "scheduling": [[13, "module-botcore.utils.scheduling"]], "caching": [[7, "module-botcore.utils.caching"]], "logging": [[10, "module-botcore.utils.logging"]], "channel": [[8, "module-botcore.utils.channel"]], "members": [[11, "module-botcore.utils.members"]], "regex": [[12, "module-botcore.utils.regex"]], "interactions": [[9, "module-botcore.utils.interactions"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.interactions"], [10, "module-botcore.utils.logging"], [11, "module-botcore.utils.members"], [12, "module-botcore.utils.regex"], [13, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "deletemessagebutton (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[9, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "customlogger (class in botcore.utils.logging)": [[10, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[10, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[10, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[10, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[11, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[11, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[11, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[12, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[12, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[13, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "3": 0, "1": [0, 10], "16th": 0, "juli": 0, "2022": 0, "bug": 0, "104": 0, "fix": 0, "botcor": [0, 1, 9], "util": [0, 1, 2, 7, 9, 10], "interact": [0, 2, 6, 8], "deletemessagebutton": [0, 2, 6, 9], "work": 0, "due": 0, "us": [0, 2, 3, 5, 6, 8, 10, 11, 12, 13], "wrong": 0, "delet": [0, 2, 5, 7, 9], "method": [0, 3, 5, 6, 10], "0": [0, 7, 9, 10], "featur": [0, 2], "103": 0, "add": [0, 2], "button": [0, 9], "messag": [0, 2, 9, 10, 13], "attach": 0, "its": [0, 2], "parent": [0, 9], "view": [0, 9], "gener": [0, 2, 13], "viewwithuserandrolecheck": [0, 2, 6, 9], "onli": [0, 2], "allow": [0, 2, 9], "specifi": [0, 9], "user": [0, 9], "role": [0, 2, 9, 11], "2": [0, 2, 9], "9th": 0, "98": 0, "close": [0, 1, 2, 5, 13], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 13], "creat": [0, 2, 3, 7, 13], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 10, 11, 13], "self": [0, 2], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 11], "96": 0, "attempt": [0, 2, 8, 11], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 13], "i": [0, 2, 5, 6, 8, 9, 10, 11, 13], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 13], "28th": 0, "support": [0, 3, 6, 13], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 11, 12], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 13], "new": [0, 3, 5, 7, 13], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 10], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "thi": [0, 2, 6, 8, 9, 11, 12, 13], "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 13], "out": [0, 9], "10th": 0, "break": 0, "75": 0, "invit": [0, 12], "regex": [0, 2, 6], "longer": [0, 9], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "url": [0, 2, 5], "safe": 0, "result": [0, 13], "refer": 0, "document": 0, "handl": [0, 11, 13], "captur": [0, 12], "all": [0, 2, 3, 6, 13], "charact": 0, "up": [0, 2], "whitespac": [0, 12], "6": 0, "4": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "timeout": [0, 9], "guild": [0, 2, 11], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 10, 13], "number": 0, "so": [0, 6], "should": [0, 2, 5, 9], "actual": 0, "now": [0, 13], "25th": 0, "69": 0, "get": [0, 2, 5, 8, 11], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 13], "t": [0, 13], "load": [0, 2, 6], "modul": [0, 2, 6, 13], "start": [0, 2, 13], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "": [0, 6, 7, 9, 10, 12, 13], "own": 0, "task": [0, 2, 13], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 13], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 10], "pagin": 0, "also": [0, 6], "basic": [0, 9], "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "an": [0, 2, 3, 5, 6, 7, 8, 10, 13], "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 9, 13], "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 10, 13], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 13], "event": [0, 2, 3, 13], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 9, 13], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 9, 11], "42": 0, "remov": [0, 2], "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 9, 10, 13], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 11, 13], "trace": [0, 6, 10], "import": 0, "can": [0, 9, 13], "function": [0, 2, 7, 8, 10, 11, 13], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 11], "wrapper": [0, 5, 13], "from": [0, 2, 3, 5, 6, 8, 9, 11, 13], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 10, 12], "cach": [0, 2, 6, 8, 11], "logger": [0, 10], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9, 10], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 12], "block": [0, 12], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "17th": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 10], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 10], "guild_id": 2, "allowed_rol": [2, 9], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 10, 13], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13], "A": [2, 5, 6, 7, 8, 9, 13], "implement": [2, 3, 7, 9, 10], "python": [2, 13], "initialis": [2, 7], "int": [2, 3, 7, 8, 9, 13], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "id": [2, 8, 9, 13], "list": 2, "mention": 2, "clientsess": [2, 5], "option": [2, 3, 5, 7, 9, 10, 11], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 13], "server": [2, 12], "If": [2, 5, 9, 13], "given": [2, 3, 6, 8, 10, 11, 13], "oper": [2, 13], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "normal": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 13], "instanti": [2, 13], "instead": [2, 13], "connector": 2, "resolv": 2, "save": 2, "them": [2, 13], "all_extens": 2, "ran": 2, "loop": [2, 3, 13], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 13], "dev": 2, "set": [2, 9], "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 13], "servic": 2, "ensur": [2, 9, 12], "thei": 2, "ar": [2, 7, 9, 12], "name": [2, 6, 10, 13], "alia": [2, 6], "individu": 2, "To": [2, 10], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "create_socket": [2, 3], "wait": [2, 13], "until": [2, 12], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 9, 13], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 10, 13], "error": [2, 5, 6, 11], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 10], "get_logg": [2, 6, 10], "get_or_fetch_memb": [2, 6, 11], "discord_invit": [2, 6, 12], "formatted_code_regex": [2, 6, 12], "raw_code_regex": [2, 6, 12], "create_task": [2, 6, 13], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 12], "__str__": [2, 5], "transport": 3, "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 13], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 11, 13], "django": 5, "initi": [5, 13], "token": 5, "authent": 5, "keyword": [5, 6, 10], "argument": [5, 6, 7, 10, 11], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 10, 13], "send": 5, "json": 5, "respons": 5, "bool": [5, 8, 9, 13], "whether": [5, 8], "rais": [5, 8, 11, 13], "ok": 5, "ani": [5, 12, 13], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 9, 13], "http": [5, 12], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 12], "root_alias": 6, "two": 6, "sequenc": [6, 9], "act": 6, "top": 6, "level": [6, 10], "rather": 6, "than": 6, "being": [6, 11], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "ha": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "callback": [6, 9], "interaction_check": [6, 9], "__contains__": [6, 13], "cancel": [6, 13], "cancel_al": [6, 13], "schedule_at": [6, 13], "schedule_lat": [6, 13], "relat": [7, 10], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 11, 13], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 13], "offset": 7, "provid": [7, 13], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 11], "wrap": [7, 13], "target": 7, "how": [7, 13], "item": 7, "helper": [8, 11], "variou": 8, "channel_id": 8, "fetch": [8, 11], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 12], "do": 8, "have": [8, 10], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "style": 9, "buttonstyl": 9, "secondari": 9, "label": 9, "contain": [9, 13], "click": 9, "itself": 9, "carri": 9, "done": [9, 13], "see": 9, "origin": 9, "allowed_us": 9, "180": 9, "invok": 9, "moder": 9, "who": 9, "float": [9, 13], "last": 9, "ui": 9, "accept": 9, "input": 9, "occur": 9, "msg": 10, "sever": 10, "exc_info": 10, "valu": 10, "houston": 10, "we": [10, 11], "interest": 10, "problem": 10, "mypi": 10, "recognis": 10, "interactin": 11, "member_id": 11, "failur": 11, "indic": 11, "could": 11, "found": [11, 13], "coro": [11, 13], "sole": 11, "expect": 11, "add_rol": 11, "remove_rol": 11, "modifi": 11, "purpos": 11, "intend": 11, "regular": 12, "express": 12, "pattern": 12, "similar": 12, "pleas": 12, "sanitis": 12, "output": 12, "someth": 12, "urllib": 12, "pars": 12, "quot": 12, "format": 12, "raw": 12, "execut": 13, "keep": 13, "track": 13, "must": 13, "distinguish": 13, "other": 13, "suggest": 13, "immedi": 13, "futur": 13, "uniqu": 13, "prematur": 13, "same": 13, "current": 13, "task_id": 13, "hashabl": 13, "look": 13, "unschedul": 13, "identifi": 13, "warn": 13, "doesn": 13, "exist": 13, "known": 13, "alreadi": 13, "prevent": 13, "unawait": 13, "ll": 13, "elsewher": 13, "timezon": 13, "awar": 13, "calcul": 13, "subtract": 13, "na\u00efv": 13, "utc": 13, "past": 13, "datetim": 13, "delai": 13, "after": 13, "union": 13, "long": 13, "suppressed_except": 13, "event_loop": 13, "otherwis": 13, "run": 13, "typevar": 13, "task_return": 13, "tupl": 13}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "interactions"], [10, 0, 0, "-", "logging"], [11, 0, 0, "-", "members"], [12, 0, 0, "-", "regex"], [13, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.interactions": [[9, 1, 1, "", "DeleteMessageButton"], [9, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "interaction_check"]], "botcore.utils.logging": [[10, 1, 1, "", "CustomLogger"], [10, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[10, 2, 1, "", "trace"]], "botcore.utils.members": [[11, 4, 1, "", "get_or_fetch_member"], [11, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[12, 5, 1, "", "DISCORD_INVITE"], [12, 5, 1, "", "FORMATTED_CODE_REGEX"], [12, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[13, 1, 1, "", "Scheduler"], [13, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[13, 2, 1, "", "__contains__"], [13, 2, 1, "", "__init__"], [13, 2, 1, "", "cancel"], [13, 2, 1, "", "cancel_all"], [13, 2, 1, "", "schedule"], [13, 2, 1, "", "schedule_at"], [13, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "interact": 9, "log": 10, "member": 11, "regex": 12, "schedul": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Changelog": [[0, "changelog"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "Submodules": [[2, "submodules"], [6, "submodules"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "Exts": [[4, "module-botcore.exts"]], "site_api": [[5, "module-botcore.site_api"]], "async_stats": [[3, "module-botcore.async_stats"]], "Utils": [[6, "module-botcore.utils"]], "caching": [[7, "module-botcore.utils.caching"]], "members": [[11, "module-botcore.utils.members"]], "channel": [[8, "module-botcore.utils.channel"]], "logging": [[10, "module-botcore.utils.logging"]], "scheduling": [[13, "module-botcore.utils.scheduling"]], "regex": [[12, "module-botcore.utils.regex"]], "interactions": [[9, "module-botcore.utils.interactions"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.interactions"], [10, "module-botcore.utils.logging"], [11, "module-botcore.utils.members"], [12, "module-botcore.utils.regex"], [13, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "deletemessagebutton (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[9, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "customlogger (class in botcore.utils.logging)": [[10, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[10, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[10, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[10, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[11, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[11, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[11, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[12, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[12, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[13, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v7.4.0-beta1/.buildinfo b/v7.4.0-beta1/.buildinfo index 57b49627..cf7f86d0 100644 --- a/v7.4.0-beta1/.buildinfo +++ b/v7.4.0-beta1/.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: 633da3f3b36b3affab1642ea05a862d5 +config: 99bac076024445105302993cc1da9b58 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.4.0-beta1/_static/basic.css b/v7.4.0-beta1/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v7.4.0-beta1/_static/basic.css +++ b/v7.4.0-beta1/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v7.4.0-beta1/_static/debug.css b/v7.4.0-beta1/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v7.4.0-beta1/_static/debug.css +++ b/v7.4.0-beta1/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v7.4.0-beta1/_static/pygments.css b/v7.4.0-beta1/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v7.4.0-beta1/_static/pygments.css +++ b/v7.4.0-beta1/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v7.4.0-beta1/_static/skeleton.css b/v7.4.0-beta1/_static/skeleton.css index 01231167..467c878c 100644 --- a/v7.4.0-beta1/_static/skeleton.css +++ b/v7.4.0-beta1/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v7.4.0-beta1/changelog.html b/v7.4.0-beta1/changelog.html index a32c390b..10d9dfe8 100644 --- a/v7.4.0-beta1/changelog.html +++ b/v7.4.0-beta1/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v7.4.0-beta1/index.html b/v7.4.0-beta1/index.html index 3519ab45..5cc7f4c3 100644 --- a/v7.4.0-beta1/index.html +++ b/v7.4.0-beta1/index.html @@ -2,7 +2,7 @@ - + diff --git a/v7.4.0-beta1/output/botcore.async_stats.html b/v7.4.0-beta1/output/botcore.async_stats.html index 0d364968..3d1ef484 100644 --- a/v7.4.0-beta1/output/botcore.async_stats.html +++ b/v7.4.0-beta1/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
        • - main + main
        • @@ -352,13 +352,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

          Create a new AsyncStatsClient.

          -
          Parameters
          +
          Parameters:
          @@ -367,10 +367,10 @@
          async create_socket()[source]#
          -

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

          +

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

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          diff --git a/v7.4.0-beta1/output/botcore.exts.html b/v7.4.0-beta1/output/botcore.exts.html index 750ffce9..a294422e 100644 --- a/v7.4.0-beta1/output/botcore.exts.html +++ b/v7.4.0-beta1/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
          • - main + main
          • diff --git a/v7.4.0-beta1/output/botcore.html b/v7.4.0-beta1/output/botcore.html index ecb18dc8..a99b2dab 100644 --- a/v7.4.0-beta1/output/botcore.html +++ b/v7.4.0-beta1/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
            • - main + main
            • @@ -352,14 +352,14 @@ __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
              +
              Parameters:
              @@ -371,8 +371,8 @@ a dummy statsd client will be created.

              • async add_cog(cog)[source]#

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

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -382,8 +382,8 @@ a dummy statsd client will be created.

              add_command(command)[source]#

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

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -393,8 +393,8 @@ a dummy statsd client will be created.

              clear()[source]#

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

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -404,8 +404,8 @@ a dummy statsd client will be created.

              async close()[source]#

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

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -416,8 +416,8 @@ a dummy statsd client will be created.

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

              This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -427,8 +427,8 @@ a dummy statsd client will be created.

              async log_to_dev_log(message)[source]#

              Log the given message to #dev-log.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -440,8 +440,8 @@ a dummy statsd client will be created.

              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.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

          @@ -451,8 +451,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

          Clear the internal guild available event when self.guild_id becomes unavailable.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -462,8 +462,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

          Ping all required services on setup to ensure they are up before starting.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -475,8 +475,8 @@ will not be set and guild_available_but_cache_empty event will be e

          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
          -

          Optional[Command]

          +
          Return type:
          +

          Optional[Command]

          @@ -489,8 +489,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -502,8 +502,8 @@ and -
          Return type
          -

          None

          +
          Return type:
          +

          None

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

          Bases: Exception

          +

          Bases: Exception

          Exception class for startup errors.

          diff --git a/v7.4.0-beta1/output/botcore.site_api.html b/v7.4.0-beta1/output/botcore.site_api.html index 13000dae..db857182 100644 --- a/v7.4.0-beta1/output/botcore.site_api.html +++ b/v7.4.0-beta1/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
          • - main + main
          • @@ -345,17 +345,17 @@
            class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
            -

            Bases: object

            +

            Bases: object

            A wrapper for the Django Site API.

            __init__(site_api_url, site_api_token, **session_kwargs)[source]#

            Initialize a new APIClient instance.

            -
            Parameters
            +
            Parameters:
              -

            • site_api_url (str) – The URL of the site API.

              • -

            • site_api_token (str) – The token to use for authentication.

              • +

            • site_api_url (str) – The URL of the site API.

              • +

            • site_api_token (str) – The token to use for authentication.

            • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

            @@ -367,8 +367,8 @@ async close()[source]#

          Close the aiohttp session.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -378,17 +378,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

          Send a DELETE request to the site API and return the JSON response.

          -
          Parameters
          +
          Parameters:
            -

          • endpoint (str) – The endpoint to send the request to.

            • -

          • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

            • +

          • endpoint (str) – The endpoint to send the request to.

            • +

          • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

          • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

          -
          Return type
          -

          Optional[dict]

          +
          Return type:
          +

          Optional[dict]

          -
          Returns
          +
          Returns:

          The JSON response the API returns, or None if the response is 204 No Content.

          @@ -399,8 +399,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

          -
          Return type
          -

          dict

          +
          Return type:
          +

          dict

          @@ -410,17 +410,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

          -
          Parameters
          +
          Parameters:

          • response (aiohttp.ClientResponse) – The response to check.

            • -

          • should_raise (bool) – Whether or not to raise an exception.

            • +

          • should_raise (bool) – Whether or not to raise an exception.

          -
          Raises
          +
          Raises:

          ResponseCodeError – If the response is not OK and should_raise is True.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -430,8 +430,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

          -
          Return type
          -

          dict

          +
          Return type:
          +

          dict

          @@ -441,8 +441,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

          -
          Return type
          -

          dict

          +
          Return type:
          +

          dict

          @@ -452,8 +452,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

          -
          Return type
          -

          dict

          +
          Return type:
          +

          dict

          @@ -463,21 +463,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

          Send an HTTP request to the site API and return the JSON response.

          -
          Parameters
          +
          Parameters:
            -

          • method (str) – The HTTP method to use.

            • -

          • endpoint (str) – The endpoint to send the request to.

            • -

          • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

            • +

          • method (str) – The HTTP method to use.

            • +

          • endpoint (str) – The endpoint to send the request to.

            • +

          • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

          • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

          -
          Return type
          -

          dict

          +
          Return type:
          +

          dict

          -
          Returns
          +
          Returns:

          The JSON response the API returns.

          -
          Raises
          +
          Raises:

          ResponseCodeError – If the response is not OK and raise_for_status is True.

          @@ -488,18 +488,18 @@
          exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
          -

          Bases: ValueError

          +

          Bases: ValueError

          Raised in APIClient.request() when a non-OK HTTP response is received.

          __init__(response, response_json=None, response_text=None)[source]#

          Initialize a new ResponseCodeError instance.

          -
          Parameters
          +
          Parameters:

          • response (aiohttp.ClientResponse) – The response object from the request.

            • -

          • response_json (Optional[dict]) – The JSON response returned from the request, if any.

            • -

          • response_text (Optional[str]) – The text of the request, if any.

            • +

          • response_json (Optional[dict]) – The JSON response returned from the request, if any.

            • +

          • response_text (Optional[str]) – The text of the request, if any.

          diff --git a/v7.4.0-beta1/output/botcore.utils.caching.html b/v7.4.0-beta1/output/botcore.utils.caching.html index edba8aba..43762812 100644 --- a/v7.4.0-beta1/output/botcore.utils.caching.html +++ b/v7.4.0-beta1/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
          • - main + main
          • @@ -345,7 +345,7 @@
            class AsyncCache(max_size=128)[source]#
            -

            Bases: object

            +

            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.

            @@ -354,13 +354,13 @@ __call__(arg_offset=0)[source]#

            Decorator for async cache.

            -
            Parameters
            -

            arg_offset (int) – The offset for the position of the key argument.

            +
            Parameters:
            +

            arg_offset (int) – The offset for the position of the key argument.

            -
            Return type
            -

            Callable

            +
            Return type:
            +

            Callable

            -
            Returns
            +
            Returns:

            A decorator to wrap the target function.

            @@ -371,8 +371,8 @@ __init__(max_size=128)[source]#

            Initialise a new AsyncCache instance.

            -
            Parameters
            -

            max_size (int) – How many items to store in the cache.

            +
            Parameters:
            +

            max_size (int) – How many items to store in the cache.

            @@ -382,8 +382,8 @@ clear()[source]#

            Clear cache instance.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

          diff --git a/v7.4.0-beta1/output/botcore.utils.channel.html b/v7.4.0-beta1/output/botcore.utils.channel.html index 03084028..af2cadda 100644 --- a/v7.4.0-beta1/output/botcore.utils.channel.html +++ b/v7.4.0-beta1/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
          • - main + main
          • @@ -347,13 +347,13 @@ 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
            +
            Parameters:

            • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

              • -

            • channel_id (int) – The channel to get/fetch.

              • +

            • channel_id (int) – The channel to get/fetch.

            -
            Raises
            +
            Raises:
            -
            Return type
            +
            Return type:

            GuildChannel

            -
            Returns
            +
            Returns:

            The channel from the ID.

            @@ -375,16 +375,16 @@ is_in_category(channel, category_id)[source]#

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

            -
            Parameters
            +
            Parameters:

            • channel (TextChannel) – The channel to check.

              • -

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

              • +

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

            -
            Return type
            -

            bool

            +
            Return type:
            +

            bool

            -
            Returns
            +
            Returns:

            A bool depending on whether the channel is in the category.

            diff --git a/v7.4.0-beta1/output/botcore.utils.html b/v7.4.0-beta1/output/botcore.utils.html index 4c538a55..29bd803e 100644 --- a/v7.4.0-beta1/output/botcore.utils.html +++ b/v7.4.0-beta1/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
            • - main + main
            • @@ -355,8 +355,8 @@ that will act as top-level groups rather than being aliases of the command’s g
          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -366,13 +366,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

          -
          Parameters
          -

          name (str) – The module name to unqualify.

          +
          Parameters:
          +

          name (str) – The module name to unqualify.

          -
          Return type
          -

          str

          +
          Return type:
          +

          str

          -
          Returns
          +
          Returns:

          The unqualified module name.

          diff --git a/v7.4.0-beta1/output/botcore.utils.interactions.html b/v7.4.0-beta1/output/botcore.utils.interactions.html index f366243b..d92f0749 100644 --- a/v7.4.0-beta1/output/botcore.utils.interactions.html +++ b/v7.4.0-beta1/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
          • - main + main
          • @@ -349,10 +349,10 @@

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

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

            -
            Parameters
            +
            Parameters:

            • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

              • -

            • label (str) – The label of the button, set to “Delete” if not specified.

              • +

            • label (str) – The label of the button, set to “Delete” if not specified.

            @@ -366,8 +366,8 @@ async callback(interaction)[source]#

            Delete the original message on button click.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -380,13 +380,13 @@

            Bases: View

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

            -
            Parameters
            +
            Parameters:
              -

            • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

              • -

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

            • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

              • +

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

            @@ -401,11 +401,11 @@ If Noneasync interaction_check(interaction)[source]#

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

            -
            Parameters
            +
            Parameters:

            interaction (Interaction) – The interaction that occurred.

            -
            Return type
            -

            bool

            +
            Return type:
            +

            bool

            @@ -415,8 +415,8 @@ If Noneasync on_timeout()[source]#

            Remove the view from self.message if set.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            diff --git a/v7.4.0-beta1/output/botcore.utils.logging.html b/v7.4.0-beta1/output/botcore.utils.logging.html index 0150f2ee..d1d109cd 100644 --- a/v7.4.0-beta1/output/botcore.utils.logging.html +++ b/v7.4.0-beta1/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
            • - main + main
            • @@ -345,8 +345,8 @@
              class CustomLogger(name, level=0)[source]#
              -

              Bases: Logger

              -

              Custom implementation of the logging.Logger class with an added trace method.

              +

              Bases: Logger

              +

              Custom implementation of the logging.Logger class with an added trace method.

              trace(msg, *args, **kwargs)[source]#
              @@ -356,15 +356,15 @@
              -
              Parameters
              +
              Parameters:
                -

              • msg (str) – The message to be logged.

                • +

              • msg (str) – The message to be logged.

              • args – Passed to the base log function as is.

              • kwargs – Passed to the base log function as is.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -376,13 +376,13 @@ get_logger(name=None)[source]#

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

              -
              Parameters
              -

              name (Optional[str]) – The name given to the logger.

              +
              Parameters:
              +

              name (Optional[str]) – The name given to the logger.

              -
              Return type
              +
              Return type:

              CustomLogger

              -
              Returns
              +
              Returns:

              An instance of the CustomLogger class.

              diff --git a/v7.4.0-beta1/output/botcore.utils.members.html b/v7.4.0-beta1/output/botcore.utils.members.html index 3cd76c26..2a1f816e 100644 --- a/v7.4.0-beta1/output/botcore.utils.members.html +++ b/v7.4.0-beta1/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
              diff --git a/v7.4.0-beta1/output/botcore.utils.regex.html b/v7.4.0-beta1/output/botcore.utils.regex.html index ec7dbe7d..0ae565c6 100644 --- a/v7.4.0-beta1/output/botcore.utils.regex.html +++ b/v7.4.0-beta1/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
              • - main + main
              • @@ -350,7 +350,7 @@

                Warning

                This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                +such as urllib.parse.quote().

                diff --git a/v7.4.0-beta1/output/botcore.utils.scheduling.html b/v7.4.0-beta1/output/botcore.utils.scheduling.html index 846691a1..7e68a865 100644 --- a/v7.4.0-beta1/output/botcore.utils.scheduling.html +++ b/v7.4.0-beta1/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
                • - main + main
                • @@ -345,7 +345,7 @@
                  class Scheduler(name)[source]#
                  -

                  Bases: object

                  +

                  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 instance’s log messages from other instances. Using the name of the class or module containing @@ -359,16 +359,16 @@ the same ID used to schedule it.

                  __contains__(task_id)[source]#
                  -

                  Return True if a task with the given task_id is currently scheduled.

                  +

                  Return True if a task with the given task_id is currently scheduled.

                  -
                  Parameters
                  -

                  task_id (Hashable) – The task to look for.

                  +
                  Parameters:
                  +

                  task_id (Hashable) – The task to look for.

                  -
                  Return type
                  -

                  bool

                  +
                  Return type:
                  +

                  bool

                  -
                  Returns
                  -

                  True if the task was found.

                  +
                  Returns:
                  +

                  True if the task was found.

                  @@ -378,8 +378,8 @@ the same ID used to schedule it.

                  __init__(name)[source]#

                  Initialize a new Scheduler instance.

                  -
                  Parameters
                  -

                  name (str) – The name of the Scheduler. Used in logging, and namespacing.

                  +
                  Parameters:
                  +

                  name (str) – The name of the Scheduler. Used in logging, and namespacing.

                  @@ -389,11 +389,11 @@ the same ID used to schedule it.

                  cancel(task_id)[source]#

                  Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                  -
                  Parameters
                  -

                  task_id (Hashable) – The task’s unique ID.

                  +
                  Parameters:
                  +

                  task_id (Hashable) – The task’s unique ID.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -403,8 +403,8 @@ the same ID used to schedule it.

                  cancel_all()[source]#

                  Unschedule all known tasks.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -416,14 +416,14 @@ the same ID used to schedule it.

                  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.

                  -
                  Parameters
                  +
                  Parameters:
                    -

                  • task_id (Hashable) – A unique ID to create the task with.

                    • -

                  • coroutine (Coroutine) – The function to be called.

                    • +

                  • task_id (Hashable) – A unique ID to create the task with.

                    • +

                  • coroutine (Coroutine) – The function to be called.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

          @@ -438,15 +438,15 @@ If timeIf 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.

          -
          Parameters
          +
          Parameters:
            -

          • time (datetime) – The time to start the task.

            • -

          • task_id (Hashable) – A unique ID to create the task with.

            • -

          • coroutine (Coroutine) – The function to be called.

            • +

          • time (datetime) – The time to start the task.

            • +

          • task_id (Hashable) – A unique ID to create the task with.

            • +

          • coroutine (Coroutine) – The function to be called.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -458,15 +458,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

          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.

          -
          Parameters
          +
          Parameters:
            -

          • delay (Union[int, float]) – How long to wait before starting the task.

            • -

          • task_id (Hashable) – A unique ID to create the task with.

            • -

          • coroutine (Coroutine) – The function to be called.

            • +

          • delay (Union[int, float]) – How long to wait before starting the task.

            • +

          • task_id (Hashable) – A unique ID to create the task with.

            • +

          • coroutine (Coroutine) – The function to be called.

          -
          Return type
          -

          None

          +
          Return type:
          +

          None

          @@ -476,23 +476,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
          create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
          -

          Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

          +

          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.

          -
          Parameters
          +
          Parameters:
          -
          Returns
          +
          Returns:

          The wrapped task.

          -
          Return type
          -

          asyncio.Task

          +
          Return type:
          +

          asyncio.Task

          diff --git a/v7.4.0-beta1/searchindex.js b/v7.4.0-beta1/searchindex.js index 86b8cb9d..d515d1b8 100644 --- a/v7.4.0-beta1/searchindex.js +++ b/v7.4.0-beta1/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "4": 0, "0": [0, 7, 9, 10], "17th": 0, "juli": 0, "2022": 0, "featur": [0, 2], "106": 0, "add": [0, 2], "an": [0, 2, 3, 5, 6, 7, 8, 10, 13], "option": [0, 2, 3, 5, 7, 9, 10, 11], "messag": [0, 2, 9, 10, 13], "attr": 0, "botcor": [0, 1, 9], "util": [0, 1, 2, 7, 9, 10], "interact": [0, 2, 6, 8], "viewwithuserandrolecheck": [0, 2, 6, 9], "On": 0, "view": [0, 9], "timeout": [0, 9], "thi": [0, 2, 6, 8, 9, 11, 12, 13], "ha": [0, 6], "": [0, 6, 7, 9, 10, 12, 13], "remov": [0, 2, 9], "set": [0, 2, 9], "3": 0, "1": [0, 10], "16th": 0, "bug": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 2, 6, 9], "work": 0, "due": 0, "us": [0, 2, 3, 5, 6, 8, 10, 11, 12, 13], "wrong": 0, "delet": [0, 2, 5, 7, 9], "method": [0, 3, 5, 6, 10], "103": 0, "button": [0, 9], "attach": 0, "its": [0, 2], "parent": [0, 9], "gener": [0, 2, 13], "onli": [0, 2], "allow": [0, 2, 9], "specifi": [0, 9], "user": [0, 9], "role": [0, 2, 9, 11], "2": [0, 2, 9], "9th": 0, "98": 0, "close": [0, 1, 2, 5, 13], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 13], "creat": [0, 2, 3, 7, 13], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 9, 11], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 10, 11, 13], "self": [0, 2, 9], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 11], "96": 0, "attempt": [0, 2, 8, 11], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 13], "i": [0, 2, 5, 6, 8, 9, 10, 11, 13], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 13], "28th": 0, "support": [0, 3, 6, 13], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 11, 12], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 13], "new": [0, 3, 5, 7, 13], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 10], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 13], "out": [0, 9], "10th": 0, "break": 0, "75": 0, "invit": [0, 12], "regex": [0, 2, 6], "longer": [0, 9], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "url": [0, 2, 5], "safe": 0, "result": [0, 13], "refer": 0, "document": 0, "handl": [0, 11, 13], "captur": [0, 12], "all": [0, 2, 3, 6, 13], "charact": 0, "up": [0, 2], "whitespac": [0, 12], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 2, 11], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 10, 13], "number": 0, "so": [0, 6], "should": [0, 2, 5, 9], "actual": 0, "now": [0, 13], "25th": 0, "69": 0, "get": [0, 2, 5, 8, 11], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 13], "t": [0, 13], "load": [0, 2, 6], "modul": [0, 2, 6, 13], "start": [0, 2, 13], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "own": 0, "task": [0, 2, 13], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 13], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 10], "pagin": 0, "also": [0, 6, 9], "basic": [0, 9], "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 9, 13], "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 10, 13], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 13], "event": [0, 2, 3, 13], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 9, 13], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 9, 11], "42": 0, "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 9, 10, 13], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 11, 13], "trace": [0, 6, 10], "import": 0, "can": [0, 9, 13], "function": [0, 2, 7, 8, 10, 11, 13], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 11], "wrapper": [0, 5, 13], "from": [0, 2, 3, 5, 6, 8, 9, 11, 13], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 10, 12], "cach": [0, 2, 6, 8, 11], "logger": [0, 10], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9, 10], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 12], "block": [0, 12], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 10], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 10], "guild_id": 2, "allowed_rol": [2, 9], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 10, 13], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13], "A": [2, 5, 6, 7, 8, 9, 13], "implement": [2, 3, 7, 9, 10], "python": [2, 13], "initialis": [2, 7], "int": [2, 3, 7, 8, 9, 13], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "id": [2, 8, 9, 13], "list": 2, "mention": 2, "clientsess": [2, 5], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 13], "server": [2, 12], "If": [2, 5, 9, 13], "given": [2, 3, 6, 8, 10, 11, 13], "oper": [2, 13], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "normal": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 13], "instanti": [2, 9, 13], "instead": [2, 13], "connector": 2, "resolv": 2, "save": 2, "them": [2, 13], "all_extens": 2, "ran": 2, "loop": [2, 3, 13], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 13], "dev": 2, "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 13], "servic": 2, "ensur": [2, 9, 12], "thei": 2, "ar": [2, 7, 9, 12], "name": [2, 6, 10, 13], "alia": [2, 6], "individu": 2, "To": [2, 10], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "create_socket": [2, 3], "wait": [2, 13], "until": [2, 12], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 9, 13], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 10, 13], "error": [2, 5, 6, 11], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 10], "get_logg": [2, 6, 10], "get_or_fetch_memb": [2, 6, 11], "discord_invit": [2, 6, 12], "formatted_code_regex": [2, 6, 12], "raw_code_regex": [2, 6, 12], "create_task": [2, 6, 13], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 12], "__str__": [2, 5], "transport": 3, "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 13], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 11, 13], "django": 5, "initi": [5, 13], "token": 5, "authent": 5, "keyword": [5, 6, 10], "argument": [5, 6, 7, 10, 11], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 10, 13], "send": [5, 9], "json": 5, "respons": 5, "bool": [5, 8, 9, 13], "whether": [5, 8], "rais": [5, 8, 11, 13], "ok": 5, "ani": [5, 12, 13], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 9, 13], "http": [5, 12], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 12], "root_alias": 6, "two": 6, "sequenc": [6, 9], "act": 6, "top": 6, "level": [6, 10], "rather": 6, "than": 6, "being": [6, 11], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "callback": [6, 9], "interaction_check": [6, 9], "on_timeout": [6, 9], "__contains__": [6, 13], "cancel": [6, 13], "cancel_al": [6, 13], "schedule_at": [6, 13], "schedule_lat": [6, 13], "relat": [7, 10], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 11, 13], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 13], "offset": 7, "provid": [7, 13], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 11], "wrap": [7, 13], "target": 7, "how": [7, 13], "item": 7, "helper": [8, 11], "variou": 8, "channel_id": 8, "fetch": [8, 11], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 12], "do": 8, "have": [8, 10], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "style": 9, "buttonstyl": 9, "secondari": 9, "label": 9, "contain": [9, 13], "click": 9, "itself": 9, "carri": 9, "done": [9, 13], "see": 9, "origin": 9, "allowed_us": 9, "180": 9, "invok": 9, "moder": 9, "who": 9, "float": [9, 13], "last": 9, "ui": 9, "accept": 9, "input": 9, "ctx": 9, "similar": [9, 12], "after": [9, 13], "occur": 9, "msg": 10, "sever": 10, "exc_info": 10, "valu": 10, "houston": 10, "we": [10, 11], "interest": 10, "problem": 10, "mypi": 10, "recognis": 10, "interactin": 11, "member_id": 11, "failur": 11, "indic": 11, "could": 11, "found": [11, 13], "coro": [11, 13], "sole": 11, "expect": 11, "add_rol": 11, "remove_rol": 11, "modifi": 11, "purpos": 11, "intend": 11, "regular": 12, "express": 12, "pattern": 12, "pleas": 12, "sanitis": 12, "output": 12, "someth": 12, "urllib": 12, "pars": 12, "quot": 12, "format": 12, "raw": 12, "execut": 13, "keep": 13, "track": 13, "must": 13, "distinguish": 13, "other": 13, "suggest": 13, "immedi": 13, "futur": 13, "uniqu": 13, "prematur": 13, "same": 13, "current": 13, "task_id": 13, "hashabl": 13, "look": 13, "unschedul": 13, "identifi": 13, "warn": 13, "doesn": 13, "exist": 13, "known": 13, "alreadi": 13, "prevent": 13, "unawait": 13, "ll": 13, "elsewher": 13, "timezon": 13, "awar": 13, "calcul": 13, "subtract": 13, "na\u00efv": 13, "utc": 13, "past": 13, "datetim": 13, "delai": 13, "union": 13, "long": 13, "suppressed_except": 13, "event_loop": 13, "otherwis": 13, "run": 13, "typevar": 13, "task_return": 13, "tupl": 13}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "interactions"], [10, 0, 0, "-", "logging"], [11, 0, 0, "-", "members"], [12, 0, 0, "-", "regex"], [13, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.interactions": [[9, 1, 1, "", "DeleteMessageButton"], [9, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "interaction_check"], [9, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[10, 1, 1, "", "CustomLogger"], [10, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[10, 2, 1, "", "trace"]], "botcore.utils.members": [[11, 4, 1, "", "get_or_fetch_member"], [11, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[12, 5, 1, "", "DISCORD_INVITE"], [12, 5, 1, "", "FORMATTED_CODE_REGEX"], [12, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[13, 1, 1, "", "Scheduler"], [13, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[13, 2, 1, "", "__contains__"], [13, 2, 1, "", "__init__"], [13, 2, 1, "", "cancel"], [13, 2, 1, "", "cancel_all"], [13, 2, 1, "", "schedule"], [13, 2, 1, "", "schedule_at"], [13, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "interact": 9, "log": 10, "member": 11, "regex": 12, "schedul": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"site_api": [[5, "module-botcore.site_api"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "Exts": [[4, "module-botcore.exts"]], "Utils": [[6, "module-botcore.utils"]], "Submodules": [[6, "submodules"], [2, "submodules"]], "Changelog": [[0, "changelog"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "async_stats": [[3, "module-botcore.async_stats"]], "caching": [[7, "module-botcore.utils.caching"]], "logging": [[10, "module-botcore.utils.logging"]], "interactions": [[9, "module-botcore.utils.interactions"]], "regex": [[12, "module-botcore.utils.regex"]], "members": [[11, "module-botcore.utils.members"]], "channel": [[8, "module-botcore.utils.channel"]], "scheduling": [[13, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.interactions"], [10, "module-botcore.utils.logging"], [11, "module-botcore.utils.members"], [12, "module-botcore.utils.regex"], [13, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "deletemessagebutton (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[9, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[10, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[10, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[10, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[10, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[11, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[11, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[11, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[12, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[12, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[13, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "4": 0, "0": [0, 7, 9, 10], "17th": 0, "juli": 0, "2022": 0, "featur": [0, 2], "106": 0, "add": [0, 2], "an": [0, 2, 3, 5, 6, 7, 8, 10, 13], "option": [0, 2, 3, 5, 7, 9, 10, 11], "messag": [0, 2, 9, 10, 13], "attr": 0, "botcor": [0, 1, 9], "util": [0, 1, 2, 7, 9, 10], "interact": [0, 2, 6, 8], "viewwithuserandrolecheck": [0, 2, 6, 9], "On": 0, "view": [0, 9], "timeout": [0, 9], "thi": [0, 2, 6, 8, 9, 11, 12, 13], "ha": [0, 6], "": [0, 6, 7, 9, 10, 12, 13], "remov": [0, 2, 9], "set": [0, 2, 9], "3": 0, "1": [0, 10], "16th": 0, "bug": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 2, 6, 9], "work": 0, "due": 0, "us": [0, 2, 3, 5, 6, 8, 10, 11, 12, 13], "wrong": 0, "delet": [0, 2, 5, 7, 9], "method": [0, 3, 5, 6, 10], "103": 0, "button": [0, 9], "attach": 0, "its": [0, 2], "parent": [0, 9], "gener": [0, 2, 13], "onli": [0, 2], "allow": [0, 2, 9], "specifi": [0, 9], "user": [0, 9], "role": [0, 2, 9, 11], "2": [0, 2, 9], "9th": 0, "98": 0, "close": [0, 1, 2, 5, 13], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 13], "creat": [0, 2, 3, 7, 13], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 9, 11], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 10, 11, 13], "self": [0, 2, 9], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 11], "96": 0, "attempt": [0, 2, 8, 11], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 13], "i": [0, 2, 5, 6, 8, 9, 10, 11, 13], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 13], "28th": 0, "support": [0, 3, 6, 13], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 11, 12], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 13], "new": [0, 3, 5, 7, 13], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 10], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 13], "out": [0, 9], "10th": 0, "break": 0, "75": 0, "invit": [0, 12], "regex": [0, 2, 6], "longer": [0, 9], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "url": [0, 2, 5], "safe": 0, "result": [0, 13], "refer": 0, "document": 0, "handl": [0, 11, 13], "captur": [0, 12], "all": [0, 2, 3, 6, 13], "charact": 0, "up": [0, 2], "whitespac": [0, 12], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 2, 11], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 10, 13], "number": 0, "so": [0, 6], "should": [0, 2, 5, 9], "actual": 0, "now": [0, 13], "25th": 0, "69": 0, "get": [0, 2, 5, 8, 11], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 13], "t": [0, 13], "load": [0, 2, 6], "modul": [0, 2, 6, 13], "start": [0, 2, 13], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "own": 0, "task": [0, 2, 13], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 13], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 10], "pagin": 0, "also": [0, 6, 9], "basic": [0, 9], "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 9, 13], "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 10, 13], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 13], "event": [0, 2, 3, 13], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 9, 13], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 9, 11], "42": 0, "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 9, 10, 13], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 11, 13], "trace": [0, 6, 10], "import": 0, "can": [0, 9, 13], "function": [0, 2, 7, 8, 10, 11, 13], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 11], "wrapper": [0, 5, 13], "from": [0, 2, 3, 5, 6, 8, 9, 11, 13], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 10, 12], "cach": [0, 2, 6, 8, 11], "logger": [0, 10], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9, 10], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 12], "block": [0, 12], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 10], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 10], "guild_id": 2, "allowed_rol": [2, 9], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 10, 13], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13], "A": [2, 5, 6, 7, 8, 9, 13], "implement": [2, 3, 7, 9, 10], "python": [2, 13], "initialis": [2, 7], "int": [2, 3, 7, 8, 9, 13], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "id": [2, 8, 9, 13], "list": 2, "mention": 2, "clientsess": [2, 5], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 13], "server": [2, 12], "If": [2, 5, 9, 13], "given": [2, 3, 6, 8, 10, 11, 13], "oper": [2, 13], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "normal": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 13], "instanti": [2, 9, 13], "instead": [2, 13], "connector": 2, "resolv": 2, "save": 2, "them": [2, 13], "all_extens": 2, "ran": 2, "loop": [2, 3, 13], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 13], "dev": 2, "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 13], "servic": 2, "ensur": [2, 9, 12], "thei": 2, "ar": [2, 7, 9, 12], "name": [2, 6, 10, 13], "alia": [2, 6], "individu": 2, "To": [2, 10], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "create_socket": [2, 3], "wait": [2, 13], "until": [2, 12], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 9, 13], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 10, 13], "error": [2, 5, 6, 11], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 10], "get_logg": [2, 6, 10], "get_or_fetch_memb": [2, 6, 11], "discord_invit": [2, 6, 12], "formatted_code_regex": [2, 6, 12], "raw_code_regex": [2, 6, 12], "create_task": [2, 6, 13], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 12], "__str__": [2, 5], "transport": 3, "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 13], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 11, 13], "django": 5, "initi": [5, 13], "token": 5, "authent": 5, "keyword": [5, 6, 10], "argument": [5, 6, 7, 10, 11], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 10, 13], "send": [5, 9], "json": 5, "respons": 5, "bool": [5, 8, 9, 13], "whether": [5, 8], "rais": [5, 8, 11, 13], "ok": 5, "ani": [5, 12, 13], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 9, 13], "http": [5, 12], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 12], "root_alias": 6, "two": 6, "sequenc": [6, 9], "act": 6, "top": 6, "level": [6, 10], "rather": 6, "than": 6, "being": [6, 11], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "callback": [6, 9], "interaction_check": [6, 9], "on_timeout": [6, 9], "__contains__": [6, 13], "cancel": [6, 13], "cancel_al": [6, 13], "schedule_at": [6, 13], "schedule_lat": [6, 13], "relat": [7, 10], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 11, 13], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 13], "offset": 7, "provid": [7, 13], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 11], "wrap": [7, 13], "target": 7, "how": [7, 13], "item": 7, "helper": [8, 11], "variou": 8, "channel_id": 8, "fetch": [8, 11], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 12], "do": 8, "have": [8, 10], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "style": 9, "buttonstyl": 9, "secondari": 9, "label": 9, "contain": [9, 13], "click": 9, "itself": 9, "carri": 9, "done": [9, 13], "see": 9, "origin": 9, "allowed_us": 9, "180": 9, "invok": 9, "moder": 9, "who": 9, "float": [9, 13], "last": 9, "ui": 9, "accept": 9, "input": 9, "ctx": 9, "similar": [9, 12], "after": [9, 13], "occur": 9, "msg": 10, "sever": 10, "exc_info": 10, "valu": 10, "houston": 10, "we": [10, 11], "interest": 10, "problem": 10, "mypi": 10, "recognis": 10, "interactin": 11, "member_id": 11, "failur": 11, "indic": 11, "could": 11, "found": [11, 13], "coro": [11, 13], "sole": 11, "expect": 11, "add_rol": 11, "remove_rol": 11, "modifi": 11, "purpos": 11, "intend": 11, "regular": 12, "express": 12, "pattern": 12, "pleas": 12, "sanitis": 12, "output": 12, "someth": 12, "urllib": 12, "pars": 12, "quot": 12, "format": 12, "raw": 12, "execut": 13, "keep": 13, "track": 13, "must": 13, "distinguish": 13, "other": 13, "suggest": 13, "immedi": 13, "futur": 13, "uniqu": 13, "prematur": 13, "same": 13, "current": 13, "task_id": 13, "hashabl": 13, "look": 13, "unschedul": 13, "identifi": 13, "warn": 13, "doesn": 13, "exist": 13, "known": 13, "alreadi": 13, "prevent": 13, "unawait": 13, "ll": 13, "elsewher": 13, "timezon": 13, "awar": 13, "calcul": 13, "subtract": 13, "na\u00efv": 13, "utc": 13, "past": 13, "datetim": 13, "delai": 13, "union": 13, "long": 13, "suppressed_except": 13, "event_loop": 13, "otherwis": 13, "run": 13, "typevar": 13, "task_return": 13, "tupl": 13}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "interactions"], [10, 0, 0, "-", "logging"], [11, 0, 0, "-", "members"], [12, 0, 0, "-", "regex"], [13, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.interactions": [[9, 1, 1, "", "DeleteMessageButton"], [9, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "interaction_check"], [9, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[10, 1, 1, "", "CustomLogger"], [10, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[10, 2, 1, "", "trace"]], "botcore.utils.members": [[11, 4, 1, "", "get_or_fetch_member"], [11, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[12, 5, 1, "", "DISCORD_INVITE"], [12, 5, 1, "", "FORMATTED_CODE_REGEX"], [12, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[13, 1, 1, "", "Scheduler"], [13, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[13, 2, 1, "", "__contains__"], [13, 2, 1, "", "__init__"], [13, 2, 1, "", "cancel"], [13, 2, 1, "", "cancel_all"], [13, 2, 1, "", "schedule"], [13, 2, 1, "", "schedule_at"], [13, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "interact": 9, "log": 10, "member": 11, "regex": 12, "schedul": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Utils": [[6, "module-botcore.utils"]], "Submodules": [[6, "submodules"], [2, "submodules"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "site_api": [[5, "module-botcore.site_api"]], "Changelog": [[0, "changelog"]], "Exts": [[4, "module-botcore.exts"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "async_stats": [[3, "module-botcore.async_stats"]], "caching": [[7, "module-botcore.utils.caching"]], "members": [[11, "module-botcore.utils.members"]], "channel": [[8, "module-botcore.utils.channel"]], "regex": [[12, "module-botcore.utils.regex"]], "logging": [[10, "module-botcore.utils.logging"]], "interactions": [[9, "module-botcore.utils.interactions"]], "scheduling": [[13, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.interactions"], [10, "module-botcore.utils.logging"], [11, "module-botcore.utils.members"], [12, "module-botcore.utils.regex"], [13, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "deletemessagebutton (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[9, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[10, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[10, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[10, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[10, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[11, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[11, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[11, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[12, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[12, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[13, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v7.4.0/.buildinfo b/v7.4.0/.buildinfo index 011031cd..55ffc47d 100644 --- a/v7.4.0/.buildinfo +++ b/v7.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: c7ea3decf331418da33ceff023943fb1 +config: 3f0b9245a83fd7df0373539f376f8ed7 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.4.0/_static/basic.css b/v7.4.0/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v7.4.0/_static/basic.css +++ b/v7.4.0/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v7.4.0/_static/debug.css b/v7.4.0/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v7.4.0/_static/debug.css +++ b/v7.4.0/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v7.4.0/_static/pygments.css b/v7.4.0/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v7.4.0/_static/pygments.css +++ b/v7.4.0/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v7.4.0/_static/skeleton.css b/v7.4.0/_static/skeleton.css index 01231167..467c878c 100644 --- a/v7.4.0/_static/skeleton.css +++ b/v7.4.0/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v7.4.0/changelog.html b/v7.4.0/changelog.html index 9f8bebb3..fd1b702f 100644 --- a/v7.4.0/changelog.html +++ b/v7.4.0/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v7.4.0/index.html b/v7.4.0/index.html index 70d923dc..54517895 100644 --- a/v7.4.0/index.html +++ b/v7.4.0/index.html @@ -2,7 +2,7 @@ - + diff --git a/v7.4.0/output/botcore.async_stats.html b/v7.4.0/output/botcore.async_stats.html index 284dd363..9cf66b96 100644 --- a/v7.4.0/output/botcore.async_stats.html +++ b/v7.4.0/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
          • - main + main
          • @@ -352,13 +352,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

            Create a new AsyncStatsClient.

            -
            Parameters
            +
            Parameters:
            @@ -367,10 +367,10 @@
            async create_socket()[source]#
            -

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

            +

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

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            diff --git a/v7.4.0/output/botcore.exts.html b/v7.4.0/output/botcore.exts.html index ef729c57..5ad4cb45 100644 --- a/v7.4.0/output/botcore.exts.html +++ b/v7.4.0/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
            • - main + main
            • diff --git a/v7.4.0/output/botcore.html b/v7.4.0/output/botcore.html index 5c3f31d2..9ea2b836 100644 --- a/v7.4.0/output/botcore.html +++ b/v7.4.0/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
              • - main + main
              • @@ -352,14 +352,14 @@ __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
                +
                Parameters:
                @@ -371,8 +371,8 @@ a dummy statsd client will be created.

                • async add_cog(cog)[source]#

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

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -382,8 +382,8 @@ a dummy statsd client will be created.

                add_command(command)[source]#

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

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -393,8 +393,8 @@ a dummy statsd client will be created.

                clear()[source]#

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

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -404,8 +404,8 @@ a dummy statsd client will be created.

                async close()[source]#

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

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -416,8 +416,8 @@ a dummy statsd client will be created.

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

                This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -427,8 +427,8 @@ a dummy statsd client will be created.

                async log_to_dev_log(message)[source]#

                Log the given message to #dev-log.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -440,8 +440,8 @@ a dummy statsd client will be created.

                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.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

            @@ -451,8 +451,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

            Clear the internal guild available event when self.guild_id becomes unavailable.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -462,8 +462,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

            Ping all required services on setup to ensure they are up before starting.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -475,8 +475,8 @@ will not be set and guild_available_but_cache_empty event will be e

            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
            -

            Optional[Command]

            +
            Return type:
            +

            Optional[Command]

            @@ -489,8 +489,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -502,8 +502,8 @@ and -
            Return type
            -

            None

            +
            Return type:
            +

            None

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

            Bases: Exception

            +

            Bases: Exception

            Exception class for startup errors.

            diff --git a/v7.4.0/output/botcore.site_api.html b/v7.4.0/output/botcore.site_api.html index d6443970..dc1f47bd 100644 --- a/v7.4.0/output/botcore.site_api.html +++ b/v7.4.0/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
            • - main + main
            • @@ -345,17 +345,17 @@
              class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
              -

              Bases: object

              +

              Bases: object

              A wrapper for the Django Site API.

              __init__(site_api_url, site_api_token, **session_kwargs)[source]#

              Initialize a new APIClient instance.

              -
              Parameters
              +
              Parameters:
                -

              • site_api_url (str) – The URL of the site API.

                • -

              • site_api_token (str) – The token to use for authentication.

                • +

              • site_api_url (str) – The URL of the site API.

                • +

              • site_api_token (str) – The token to use for authentication.

              • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

              @@ -367,8 +367,8 @@ async close()[source]#

            Close the aiohttp session.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -378,17 +378,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

            Send a DELETE request to the site API and return the JSON response.

            -
            Parameters
            +
            Parameters:
              -

            • endpoint (str) – The endpoint to send the request to.

              • -

            • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

              • +

            • endpoint (str) – The endpoint to send the request to.

              • +

            • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

            • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

            -
            Return type
            -

            Optional[dict]

            +
            Return type:
            +

            Optional[dict]

            -
            Returns
            +
            Returns:

            The JSON response the API returns, or None if the response is 204 No Content.

            @@ -399,8 +399,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

            -
            Return type
            -

            dict

            +
            Return type:
            +

            dict

            @@ -410,17 +410,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

            -
            Parameters
            +
            Parameters:

            • response (aiohttp.ClientResponse) – The response to check.

              • -

            • should_raise (bool) – Whether or not to raise an exception.

              • +

            • should_raise (bool) – Whether or not to raise an exception.

            -
            Raises
            +
            Raises:

            ResponseCodeError – If the response is not OK and should_raise is True.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -430,8 +430,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

            -
            Return type
            -

            dict

            +
            Return type:
            +

            dict

            @@ -441,8 +441,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

            -
            Return type
            -

            dict

            +
            Return type:
            +

            dict

            @@ -452,8 +452,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

            -
            Return type
            -

            dict

            +
            Return type:
            +

            dict

            @@ -463,21 +463,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

            Send an HTTP request to the site API and return the JSON response.

            -
            Parameters
            +
            Parameters:
              -

            • method (str) – The HTTP method to use.

              • -

            • endpoint (str) – The endpoint to send the request to.

              • -

            • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

              • +

            • method (str) – The HTTP method to use.

              • +

            • endpoint (str) – The endpoint to send the request to.

              • +

            • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

            • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

            -
            Return type
            -

            dict

            +
            Return type:
            +

            dict

            -
            Returns
            +
            Returns:

            The JSON response the API returns.

            -
            Raises
            +
            Raises:

            ResponseCodeError – If the response is not OK and raise_for_status is True.

            @@ -488,18 +488,18 @@
            exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
            -

            Bases: ValueError

            +

            Bases: ValueError

            Raised in APIClient.request() when a non-OK HTTP response is received.

            __init__(response, response_json=None, response_text=None)[source]#

            Initialize a new ResponseCodeError instance.

            -
            Parameters
            +
            Parameters:

            • response (aiohttp.ClientResponse) – The response object from the request.

              • -

            • response_json (Optional[dict]) – The JSON response returned from the request, if any.

              • -

            • response_text (Optional[str]) – The text of the request, if any.

              • +

            • response_json (Optional[dict]) – The JSON response returned from the request, if any.

              • +

            • response_text (Optional[str]) – The text of the request, if any.

            diff --git a/v7.4.0/output/botcore.utils.caching.html b/v7.4.0/output/botcore.utils.caching.html index 8351169a..9dad4050 100644 --- a/v7.4.0/output/botcore.utils.caching.html +++ b/v7.4.0/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
            • - main + main
            • @@ -345,7 +345,7 @@
              class AsyncCache(max_size=128)[source]#
              -

              Bases: object

              +

              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.

              @@ -354,13 +354,13 @@ __call__(arg_offset=0)[source]#

              Decorator for async cache.

              -
              Parameters
              -

              arg_offset (int) – The offset for the position of the key argument.

              +
              Parameters:
              +

              arg_offset (int) – The offset for the position of the key argument.

              -
              Return type
              -

              Callable

              +
              Return type:
              +

              Callable

              -
              Returns
              +
              Returns:

              A decorator to wrap the target function.

              @@ -371,8 +371,8 @@ __init__(max_size=128)[source]#

              Initialise a new AsyncCache instance.

              -
              Parameters
              -

              max_size (int) – How many items to store in the cache.

              +
              Parameters:
              +

              max_size (int) – How many items to store in the cache.

              @@ -382,8 +382,8 @@ clear()[source]#

              Clear cache instance.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

            diff --git a/v7.4.0/output/botcore.utils.channel.html b/v7.4.0/output/botcore.utils.channel.html index ee1f2a3c..a30e1316 100644 --- a/v7.4.0/output/botcore.utils.channel.html +++ b/v7.4.0/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
            • - main + main
            • @@ -347,13 +347,13 @@ 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
              +
              Parameters:

              • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

                • -

              • channel_id (int) – The channel to get/fetch.

                • +

              • channel_id (int) – The channel to get/fetch.

              -
              Raises
              +
              Raises:
              -
              Return type
              +
              Return type:

              GuildChannel

              -
              Returns
              +
              Returns:

              The channel from the ID.

              @@ -375,16 +375,16 @@ is_in_category(channel, category_id)[source]#

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

              -
              Parameters
              +
              Parameters:

              • channel (TextChannel) – The channel to check.

                • -

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

                • +

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

              -
              Return type
              -

              bool

              +
              Return type:
              +

              bool

              -
              Returns
              +
              Returns:

              A bool depending on whether the channel is in the category.

              diff --git a/v7.4.0/output/botcore.utils.html b/v7.4.0/output/botcore.utils.html index 7b24db03..adc5ca18 100644 --- a/v7.4.0/output/botcore.utils.html +++ b/v7.4.0/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
              • - main + main
              • @@ -355,8 +355,8 @@ that will act as top-level groups rather than being aliases of the command’s g
            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -366,13 +366,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

            -
            Parameters
            -

            name (str) – The module name to unqualify.

            +
            Parameters:
            +

            name (str) – The module name to unqualify.

            -
            Return type
            -

            str

            +
            Return type:
            +

            str

            -
            Returns
            +
            Returns:

            The unqualified module name.

            diff --git a/v7.4.0/output/botcore.utils.interactions.html b/v7.4.0/output/botcore.utils.interactions.html index b8497fb7..c08d7635 100644 --- a/v7.4.0/output/botcore.utils.interactions.html +++ b/v7.4.0/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
            • - main + main
            • @@ -349,10 +349,10 @@

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

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

              -
              Parameters
              +
              Parameters:

              • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

                • -

              • label (str) – The label of the button, set to “Delete” if not specified.

                • +

              • label (str) – The label of the button, set to “Delete” if not specified.

              @@ -366,8 +366,8 @@ async callback(interaction)[source]#

              Delete the original message on button click.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -380,13 +380,13 @@

              Bases: View

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

              -
              Parameters
              +
              Parameters:
                -

              • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                • -

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

              • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                • +

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

              @@ -401,11 +401,11 @@ If Noneasync interaction_check(interaction)[source]#

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

              -
              Parameters
              +
              Parameters:

              interaction (Interaction) – The interaction that occurred.

              -
              Return type
              -

              bool

              +
              Return type:
              +

              bool

              @@ -415,8 +415,8 @@ If Noneasync on_timeout()[source]#

              Remove the view from self.message if set.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              diff --git a/v7.4.0/output/botcore.utils.logging.html b/v7.4.0/output/botcore.utils.logging.html index c9ebbf9d..2ea9cf16 100644 --- a/v7.4.0/output/botcore.utils.logging.html +++ b/v7.4.0/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
              • - main + main
              • @@ -345,8 +345,8 @@
                class CustomLogger(name, level=0)[source]#
                -

                Bases: Logger

                -

                Custom implementation of the logging.Logger class with an added trace method.

                +

                Bases: Logger

                +

                Custom implementation of the logging.Logger class with an added trace method.

                trace(msg, *args, **kwargs)[source]#
                @@ -356,15 +356,15 @@
                -
                Parameters
                +
                Parameters:
                  -

                • msg (str) – The message to be logged.

                  • +

                • msg (str) – The message to be logged.

                • args – Passed to the base log function as is.

                • kwargs – Passed to the base log function as is.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -376,13 +376,13 @@ get_logger(name=None)[source]#

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

                -
                Parameters
                -

                name (Optional[str]) – The name given to the logger.

                +
                Parameters:
                +

                name (Optional[str]) – The name given to the logger.

                -
                Return type
                +
                Return type:

                CustomLogger

                -
                Returns
                +
                Returns:

                An instance of the CustomLogger class.

                diff --git a/v7.4.0/output/botcore.utils.members.html b/v7.4.0/output/botcore.utils.members.html index b2883d64..01cfc954 100644 --- a/v7.4.0/output/botcore.utils.members.html +++ b/v7.4.0/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
                diff --git a/v7.4.0/output/botcore.utils.regex.html b/v7.4.0/output/botcore.utils.regex.html index 2567ab49..b4dfe581 100644 --- a/v7.4.0/output/botcore.utils.regex.html +++ b/v7.4.0/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
                • - main + main
                • @@ -350,7 +350,7 @@

                  Warning

                  This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                  +such as urllib.parse.quote().

                  diff --git a/v7.4.0/output/botcore.utils.scheduling.html b/v7.4.0/output/botcore.utils.scheduling.html index 9ad34316..2698909e 100644 --- a/v7.4.0/output/botcore.utils.scheduling.html +++ b/v7.4.0/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -202,7 +202,7 @@
                  • - main + main
                  • @@ -345,7 +345,7 @@
                    class Scheduler(name)[source]#
                    -

                    Bases: object

                    +

                    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 instance’s log messages from other instances. Using the name of the class or module containing @@ -359,16 +359,16 @@ the same ID used to schedule it.

                    __contains__(task_id)[source]#
                    -

                    Return True if a task with the given task_id is currently scheduled.

                    +

                    Return True if a task with the given task_id is currently scheduled.

                    -
                    Parameters
                    -

                    task_id (Hashable) – The task to look for.

                    +
                    Parameters:
                    +

                    task_id (Hashable) – The task to look for.

                    -
                    Return type
                    -

                    bool

                    +
                    Return type:
                    +

                    bool

                    -
                    Returns
                    -

                    True if the task was found.

                    +
                    Returns:
                    +

                    True if the task was found.

                    @@ -378,8 +378,8 @@ the same ID used to schedule it.

                    __init__(name)[source]#

                    Initialize a new Scheduler instance.

                    -
                    Parameters
                    -

                    name (str) – The name of the Scheduler. Used in logging, and namespacing.

                    +
                    Parameters:
                    +

                    name (str) – The name of the Scheduler. Used in logging, and namespacing.

                    @@ -389,11 +389,11 @@ the same ID used to schedule it.

                    cancel(task_id)[source]#

                    Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                    -
                    Parameters
                    -

                    task_id (Hashable) – The task’s unique ID.

                    +
                    Parameters:
                    +

                    task_id (Hashable) – The task’s unique ID.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -403,8 +403,8 @@ the same ID used to schedule it.

                    cancel_all()[source]#

                    Unschedule all known tasks.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -416,14 +416,14 @@ the same ID used to schedule it.

                    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.

                    -
                    Parameters
                    +
                    Parameters:
                      -

                    • task_id (Hashable) – A unique ID to create the task with.

                      • -

                    • coroutine (Coroutine) – The function to be called.

                      • +

                    • task_id (Hashable) – A unique ID to create the task with.

                      • +

                    • coroutine (Coroutine) – The function to be called.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

            @@ -438,15 +438,15 @@ If timeIf 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.

            -
            Parameters
            +
            Parameters:
              -

            • time (datetime) – The time to start the task.

              • -

            • task_id (Hashable) – A unique ID to create the task with.

              • -

            • coroutine (Coroutine) – The function to be called.

              • +

            • time (datetime) – The time to start the task.

              • +

            • task_id (Hashable) – A unique ID to create the task with.

              • +

            • coroutine (Coroutine) – The function to be called.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -458,15 +458,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

            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.

            -
            Parameters
            +
            Parameters:
              -

            • delay (Union[int, float]) – How long to wait before starting the task.

              • -

            • task_id (Hashable) – A unique ID to create the task with.

              • -

            • coroutine (Coroutine) – The function to be called.

              • +

            • delay (Union[int, float]) – How long to wait before starting the task.

              • +

            • task_id (Hashable) – A unique ID to create the task with.

              • +

            • coroutine (Coroutine) – The function to be called.

            -
            Return type
            -

            None

            +
            Return type:
            +

            None

            @@ -476,23 +476,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
            create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
            -

            Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

            +

            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.

            -
            Parameters
            +
            Parameters:
            -
            Returns
            +
            Returns:

            The wrapped task.

            -
            Return type
            -

            asyncio.Task

            +
            Return type:
            +

            asyncio.Task

            diff --git a/v7.4.0/searchindex.js b/v7.4.0/searchindex.js index f52f3a85..378f1b49 100644 --- a/v7.4.0/searchindex.js +++ b/v7.4.0/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "4": 0, "0": [0, 7, 9, 10], "17th": 0, "juli": 0, "2022": 0, "featur": [0, 2], "106": 0, "add": [0, 2], "an": [0, 2, 3, 5, 6, 7, 8, 10, 13], "option": [0, 2, 3, 5, 7, 9, 10, 11], "messag": [0, 2, 9, 10, 13], "attr": 0, "botcor": [0, 1, 9], "util": [0, 1, 2, 7, 9, 10], "interact": [0, 2, 6, 8], "viewwithuserandrolecheck": [0, 2, 6, 9], "On": 0, "view": [0, 9], "timeout": [0, 9], "thi": [0, 2, 6, 8, 9, 11, 12, 13], "ha": [0, 6], "its": [0, 2], "remov": [0, 2, 9], "set": [0, 2, 9], "3": 0, "1": [0, 10], "16th": 0, "bug": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 2, 6, 9], "work": 0, "due": 0, "us": [0, 2, 3, 5, 6, 8, 10, 11, 12, 13], "wrong": 0, "delet": [0, 2, 5, 7, 9], "method": [0, 3, 5, 6, 10], "103": 0, "button": [0, 9], "attach": 0, "parent": [0, 9], "gener": [0, 2, 13], "onli": [0, 2], "allow": [0, 2, 9], "specifi": [0, 9], "user": [0, 9], "role": [0, 2, 9, 11], "2": [0, 2, 9], "9th": 0, "98": 0, "close": [0, 1, 2, 5, 13], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 13], "creat": [0, 2, 3, 7, 13], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 9, 11], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 10, 11, 13], "self": [0, 2, 9], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 11], "96": 0, "attempt": [0, 2, 8, 11], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 13], "i": [0, 2, 5, 6, 8, 9, 10, 11, 13], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 13], "28th": 0, "support": [0, 3, 6, 13], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 11, 12], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 13], "new": [0, 3, 5, 7, 13], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 10], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 13], "out": [0, 9], "10th": 0, "break": 0, "75": 0, "invit": [0, 12], "regex": [0, 2, 6], "longer": [0, 9], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "url": [0, 2, 5], "safe": 0, "result": [0, 13], "refer": 0, "document": 0, "handl": [0, 11, 13], "captur": [0, 12], "all": [0, 2, 3, 6, 13], "charact": 0, "up": [0, 2], "whitespac": [0, 12], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 2, 11], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 10, 13], "number": 0, "so": [0, 6], "should": [0, 2, 5, 9], "actual": 0, "now": [0, 13], "25th": 0, "69": 0, "get": [0, 2, 5, 8, 11], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 13], "t": [0, 13], "load": [0, 2, 6], "modul": [0, 2, 6, 13], "start": [0, 2, 13], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "": [0, 6, 7, 9, 10, 12, 13], "own": 0, "task": [0, 2, 13], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 13], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 10], "pagin": 0, "also": [0, 6, 9], "basic": [0, 9], "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 9, 13], "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 10, 13], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 13], "event": [0, 2, 3, 13], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 9, 13], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 9, 11], "42": 0, "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 9, 10, 13], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 11, 13], "trace": [0, 6, 10], "import": 0, "can": [0, 9, 13], "function": [0, 2, 7, 8, 10, 11, 13], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 11], "wrapper": [0, 5, 13], "from": [0, 2, 3, 5, 6, 8, 9, 11, 13], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 10, 12], "cach": [0, 2, 6, 8, 11], "logger": [0, 10], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9, 10], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 12], "block": [0, 12], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 10], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 10], "guild_id": 2, "allowed_rol": [2, 9], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 10, 13], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13], "A": [2, 5, 6, 7, 8, 9, 13], "implement": [2, 3, 7, 9, 10], "python": [2, 13], "initialis": [2, 7], "int": [2, 3, 7, 8, 9, 13], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "id": [2, 8, 9, 13], "list": 2, "mention": 2, "clientsess": [2, 5], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 13], "server": [2, 12], "If": [2, 5, 9, 13], "given": [2, 3, 6, 8, 10, 11, 13], "oper": [2, 13], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "normal": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 13], "instanti": [2, 9, 13], "instead": [2, 13], "connector": 2, "resolv": 2, "save": 2, "them": [2, 13], "all_extens": 2, "ran": 2, "loop": [2, 3, 13], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 13], "dev": 2, "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 13], "servic": 2, "ensur": [2, 9, 12], "thei": 2, "ar": [2, 7, 9, 12], "name": [2, 6, 10, 13], "alia": [2, 6], "individu": 2, "To": [2, 10], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "create_socket": [2, 3], "wait": [2, 13], "until": [2, 12], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 9, 13], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 10, 13], "error": [2, 5, 6, 11], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 10], "get_logg": [2, 6, 10], "get_or_fetch_memb": [2, 6, 11], "discord_invit": [2, 6, 12], "formatted_code_regex": [2, 6, 12], "raw_code_regex": [2, 6, 12], "create_task": [2, 6, 13], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 12], "__str__": [2, 5], "transport": 3, "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 13], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 11, 13], "django": 5, "initi": [5, 13], "token": 5, "authent": 5, "keyword": [5, 6, 10], "argument": [5, 6, 7, 10, 11], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 10, 13], "send": [5, 9], "json": 5, "respons": 5, "bool": [5, 8, 9, 13], "whether": [5, 8], "rais": [5, 8, 11, 13], "ok": 5, "ani": [5, 12, 13], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 9, 13], "http": [5, 12], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 12], "root_alias": 6, "two": 6, "sequenc": [6, 9], "act": 6, "top": 6, "level": [6, 10], "rather": 6, "than": 6, "being": [6, 11], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "callback": [6, 9], "interaction_check": [6, 9], "on_timeout": [6, 9], "__contains__": [6, 13], "cancel": [6, 13], "cancel_al": [6, 13], "schedule_at": [6, 13], "schedule_lat": [6, 13], "relat": [7, 10], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 11, 13], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 13], "offset": 7, "provid": [7, 13], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 11], "wrap": [7, 13], "target": 7, "how": [7, 13], "item": 7, "helper": [8, 11], "variou": 8, "channel_id": 8, "fetch": [8, 11], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 12], "do": 8, "have": [8, 10], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "style": 9, "buttonstyl": 9, "secondari": 9, "label": 9, "contain": [9, 13], "click": 9, "itself": 9, "carri": 9, "done": [9, 13], "see": 9, "origin": 9, "allowed_us": 9, "180": 9, "invok": 9, "moder": 9, "who": 9, "float": [9, 13], "last": 9, "ui": 9, "accept": 9, "input": 9, "ctx": 9, "similar": [9, 12], "after": [9, 13], "occur": 9, "msg": 10, "sever": 10, "exc_info": 10, "valu": 10, "houston": 10, "we": [10, 11], "interest": 10, "problem": 10, "mypi": 10, "recognis": 10, "interactin": 11, "member_id": 11, "failur": 11, "indic": 11, "could": 11, "found": [11, 13], "coro": [11, 13], "sole": 11, "expect": 11, "add_rol": 11, "remove_rol": 11, "modifi": 11, "purpos": 11, "intend": 11, "regular": 12, "express": 12, "pattern": 12, "pleas": 12, "sanitis": 12, "output": 12, "someth": 12, "urllib": 12, "pars": 12, "quot": 12, "format": 12, "raw": 12, "execut": 13, "keep": 13, "track": 13, "must": 13, "distinguish": 13, "other": 13, "suggest": 13, "immedi": 13, "futur": 13, "uniqu": 13, "prematur": 13, "same": 13, "current": 13, "task_id": 13, "hashabl": 13, "look": 13, "unschedul": 13, "identifi": 13, "warn": 13, "doesn": 13, "exist": 13, "known": 13, "alreadi": 13, "prevent": 13, "unawait": 13, "ll": 13, "elsewher": 13, "timezon": 13, "awar": 13, "calcul": 13, "subtract": 13, "na\u00efv": 13, "utc": 13, "past": 13, "datetim": 13, "delai": 13, "union": 13, "long": 13, "suppressed_except": 13, "event_loop": 13, "otherwis": 13, "run": 13, "typevar": 13, "task_return": 13, "tupl": 13}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "interactions"], [10, 0, 0, "-", "logging"], [11, 0, 0, "-", "members"], [12, 0, 0, "-", "regex"], [13, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.interactions": [[9, 1, 1, "", "DeleteMessageButton"], [9, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "interaction_check"], [9, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[10, 1, 1, "", "CustomLogger"], [10, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[10, 2, 1, "", "trace"]], "botcore.utils.members": [[11, 4, 1, "", "get_or_fetch_member"], [11, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[12, 5, 1, "", "DISCORD_INVITE"], [12, 5, 1, "", "FORMATTED_CODE_REGEX"], [12, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[13, 1, 1, "", "Scheduler"], [13, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[13, 2, 1, "", "__contains__"], [13, 2, 1, "", "__init__"], [13, 2, 1, "", "cancel"], [13, 2, 1, "", "cancel_all"], [13, 2, 1, "", "schedule"], [13, 2, 1, "", "schedule_at"], [13, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "interact": 9, "log": 10, "member": 11, "regex": 12, "schedul": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"site_api": [[5, "module-botcore.site_api"]], "Changelog": [[0, "changelog"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "Utils": [[6, "module-botcore.utils"]], "Submodules": [[6, "submodules"], [2, "submodules"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "Exts": [[4, "module-botcore.exts"]], "async_stats": [[3, "module-botcore.async_stats"]], "interactions": [[9, "module-botcore.utils.interactions"]], "logging": [[10, "module-botcore.utils.logging"]], "members": [[11, "module-botcore.utils.members"]], "regex": [[12, "module-botcore.utils.regex"]], "scheduling": [[13, "module-botcore.utils.scheduling"]], "caching": [[7, "module-botcore.utils.caching"]], "channel": [[8, "module-botcore.utils.channel"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.interactions"], [10, "module-botcore.utils.logging"], [11, "module-botcore.utils.members"], [12, "module-botcore.utils.regex"], [13, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "deletemessagebutton (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[9, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[10, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[10, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[10, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[10, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[11, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[11, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[11, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[12, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[12, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[13, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "4": 0, "0": [0, 7, 9, 10], "17th": 0, "juli": 0, "2022": 0, "featur": [0, 2], "106": 0, "add": [0, 2], "an": [0, 2, 3, 5, 6, 7, 8, 10, 13], "option": [0, 2, 3, 5, 7, 9, 10, 11], "messag": [0, 2, 9, 10, 13], "attr": 0, "botcor": [0, 1, 9], "util": [0, 1, 2, 7, 9, 10], "interact": [0, 2, 6, 8], "viewwithuserandrolecheck": [0, 2, 6, 9], "On": 0, "view": [0, 9], "timeout": [0, 9], "thi": [0, 2, 6, 8, 9, 11, 12, 13], "ha": [0, 6], "its": [0, 2], "remov": [0, 2, 9], "set": [0, 2, 9], "3": 0, "1": [0, 10], "16th": 0, "bug": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 2, 6, 9], "work": 0, "due": 0, "us": [0, 2, 3, 5, 6, 8, 10, 11, 12, 13], "wrong": 0, "delet": [0, 2, 5, 7, 9], "method": [0, 3, 5, 6, 10], "103": 0, "button": [0, 9], "attach": 0, "parent": [0, 9], "gener": [0, 2, 13], "onli": [0, 2], "allow": [0, 2, 9], "specifi": [0, 9], "user": [0, 9], "role": [0, 2, 9, 11], "2": [0, 2, 9], "9th": 0, "98": 0, "close": [0, 1, 2, 5, 13], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 13], "creat": [0, 2, 3, 7, 13], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 9, 11], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 10, 11, 13], "self": [0, 2, 9], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 11], "96": 0, "attempt": [0, 2, 8, 11], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 13], "i": [0, 2, 5, 6, 8, 9, 10, 11, 13], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 13], "28th": 0, "support": [0, 3, 6, 13], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 11, 12], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 13], "new": [0, 3, 5, 7, 13], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 10], "avail": [0, 2], "older": 0, "doc": 0, "version": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 13], "out": [0, 9], "10th": 0, "break": 0, "75": 0, "invit": [0, 12], "regex": [0, 2, 6], "longer": [0, 9], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "url": [0, 2, 5], "safe": 0, "result": [0, 13], "refer": 0, "document": 0, "handl": [0, 11, 13], "captur": [0, 12], "all": [0, 2, 3, 6, 13], "charact": 0, "up": [0, 2], "whitespac": [0, 12], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 2, 11], "chunk": 0, "base": [0, 2, 3, 5, 7, 9, 10, 13], "number": 0, "so": [0, 6], "should": [0, 2, 5, 9], "actual": 0, "now": [0, 13], "25th": 0, "69": 0, "get": [0, 2, 5, 8, 11], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 13], "t": [0, 13], "load": [0, 2, 6], "modul": [0, 2, 6, 13], "start": [0, 2, 13], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "": [0, 6, 7, 9, 10, 12, 13], "own": 0, "task": [0, 2, 13], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 13], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 10], "pagin": 0, "also": [0, 6, 9], "basic": [0, 9], "forum": 0, "channel": [0, 2, 6], "5": 0, "18th": 0, "63": 0, "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 9, 13], "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 10, 13], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 13], "event": [0, 2, 3, 13], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 9, 13], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 9, 11], "42": 0, "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 9, 10, 13], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 11, 13], "trace": [0, 6, 10], "import": 0, "can": [0, 9, 13], "function": [0, 2, 7, 8, 10, 11, 13], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 11], "wrapper": [0, 5, 13], "from": [0, 2, 3, 5, 6, 8, 9, 11, 13], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 10, 12], "cach": [0, 2, 6, 8, 11], "logger": [0, 10], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 9, 10], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 12], "block": [0, 12], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 10], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 10], "guild_id": 2, "allowed_rol": [2, 9], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 9, 10, 13], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13], "A": [2, 5, 6, 7, 8, 9, 13], "implement": [2, 3, 7, 9, 10], "python": [2, 13], "initialis": [2, 7], "int": [2, 3, 7, 8, 9, 13], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "id": [2, 8, 9, 13], "list": 2, "mention": 2, "clientsess": [2, 5], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 13], "server": [2, 12], "If": [2, 5, 9, 13], "given": [2, 3, 6, 8, 10, 11, 13], "oper": [2, 13], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 13], "normal": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 13], "instanti": [2, 9, 13], "instead": [2, 13], "connector": 2, "resolv": 2, "save": 2, "them": [2, 13], "all_extens": 2, "ran": 2, "loop": [2, 3, 13], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 13], "dev": 2, "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 13], "servic": 2, "ensur": [2, 9, 12], "thei": 2, "ar": [2, 7, 9, 12], "name": [2, 6, 10, 13], "alia": [2, 6], "individu": 2, "To": [2, 10], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "create_socket": [2, 3], "wait": [2, 13], "until": [2, 12], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 9, 13], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 10, 13], "error": [2, 5, 6, 11], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "customlogg": [2, 6, 10], "get_logg": [2, 6, 10], "get_or_fetch_memb": [2, 6, 11], "discord_invit": [2, 6, 12], "formatted_code_regex": [2, 6, 12], "raw_code_regex": [2, 6, 12], "create_task": [2, 6, 13], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 12], "__str__": [2, 5], "transport": 3, "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 13], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 11, 13], "django": 5, "initi": [5, 13], "token": 5, "authent": 5, "keyword": [5, 6, 10], "argument": [5, 6, 7, 10, 11], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 10, 13], "send": [5, 9], "json": 5, "respons": 5, "bool": [5, 8, 9, 13], "whether": [5, 8], "rais": [5, 8, 11, 13], "ok": 5, "ani": [5, 12, 13], "extra": 5, "dict": 5, "204": 5, "No": 5, "content": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 9, 13], "http": [5, 12], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": 5, "string": 5, "represent": 5, "appli": [6, 7], "group": [6, 12], "root_alias": 6, "two": 6, "sequenc": [6, 9], "act": 6, "top": 6, "level": [6, 10], "rather": 6, "than": 6, "being": [6, 11], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "callback": [6, 9], "interaction_check": [6, 9], "on_timeout": [6, 9], "__contains__": [6, 13], "cancel": [6, 13], "cancel_al": [6, 13], "schedule_at": [6, 13], "schedule_lat": [6, 13], "relat": [7, 10], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 11, 13], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 13], "offset": 7, "provid": [7, 13], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 11], "wrap": [7, 13], "target": 7, "how": [7, 13], "item": 7, "helper": [8, 11], "variou": 8, "channel_id": 8, "fetch": [8, 11], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 12], "do": 8, "have": [8, 10], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "style": 9, "buttonstyl": 9, "secondari": 9, "label": 9, "contain": [9, 13], "click": 9, "itself": 9, "carri": 9, "done": [9, 13], "see": 9, "origin": 9, "allowed_us": 9, "180": 9, "invok": 9, "moder": 9, "who": 9, "float": [9, 13], "last": 9, "ui": 9, "accept": 9, "input": 9, "ctx": 9, "similar": [9, 12], "after": [9, 13], "occur": 9, "msg": 10, "sever": 10, "exc_info": 10, "valu": 10, "houston": 10, "we": [10, 11], "interest": 10, "problem": 10, "mypi": 10, "recognis": 10, "interactin": 11, "member_id": 11, "failur": 11, "indic": 11, "could": 11, "found": [11, 13], "coro": [11, 13], "sole": 11, "expect": 11, "add_rol": 11, "remove_rol": 11, "modifi": 11, "purpos": 11, "intend": 11, "regular": 12, "express": 12, "pattern": 12, "pleas": 12, "sanitis": 12, "output": 12, "someth": 12, "urllib": 12, "pars": 12, "quot": 12, "format": 12, "raw": 12, "execut": 13, "keep": 13, "track": 13, "must": 13, "distinguish": 13, "other": 13, "suggest": 13, "immedi": 13, "futur": 13, "uniqu": 13, "prematur": 13, "same": 13, "current": 13, "task_id": 13, "hashabl": 13, "look": 13, "unschedul": 13, "identifi": 13, "warn": 13, "doesn": 13, "exist": 13, "known": 13, "alreadi": 13, "prevent": 13, "unawait": 13, "ll": 13, "elsewher": 13, "timezon": 13, "awar": 13, "calcul": 13, "subtract": 13, "na\u00efv": 13, "utc": 13, "past": 13, "datetim": 13, "delai": 13, "union": 13, "long": 13, "suppressed_except": 13, "event_loop": 13, "otherwis": 13, "run": 13, "typevar": 13, "task_return": 13, "tupl": 13}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "interactions"], [10, 0, 0, "-", "logging"], [11, 0, 0, "-", "members"], [12, 0, 0, "-", "regex"], [13, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.interactions": [[9, 1, 1, "", "DeleteMessageButton"], [9, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[9, 2, 1, "", "__init__"], [9, 2, 1, "", "interaction_check"], [9, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[10, 1, 1, "", "CustomLogger"], [10, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[10, 2, 1, "", "trace"]], "botcore.utils.members": [[11, 4, 1, "", "get_or_fetch_member"], [11, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[12, 5, 1, "", "DISCORD_INVITE"], [12, 5, 1, "", "FORMATTED_CODE_REGEX"], [12, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[13, 1, 1, "", "Scheduler"], [13, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[13, 2, 1, "", "__contains__"], [13, 2, 1, "", "__init__"], [13, 2, 1, "", "cancel"], [13, 2, 1, "", "cancel_all"], [13, 2, 1, "", "schedule"], [13, 2, 1, "", "schedule_at"], [13, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "interact": 9, "log": 10, "member": 11, "regex": 12, "schedul": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "Submodules": [[2, "submodules"], [6, "submodules"]], "async_stats": [[3, "module-botcore.async_stats"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "site_api": [[5, "module-botcore.site_api"]], "Changelog": [[0, "changelog"]], "Exts": [[4, "module-botcore.exts"]], "Utils": [[6, "module-botcore.utils"]], "regex": [[12, "module-botcore.utils.regex"]], "members": [[11, "module-botcore.utils.members"]], "caching": [[7, "module-botcore.utils.caching"]], "interactions": [[9, "module-botcore.utils.interactions"]], "channel": [[8, "module-botcore.utils.channel"]], "logging": [[10, "module-botcore.utils.logging"]], "scheduling": [[13, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.interactions"], [10, "module-botcore.utils.logging"], [11, "module-botcore.utils.members"], [12, "module-botcore.utils.regex"], [13, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "deletemessagebutton (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[9, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[9, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[9, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[10, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[10, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[10, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[10, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[11, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[11, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[11, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[12, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[12, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[12, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[13, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[13, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[13, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v7.5.0/.buildinfo b/v7.5.0/.buildinfo index df083483..191cfeea 100644 --- a/v7.5.0/.buildinfo +++ b/v7.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: 12a83196d71c4ea3ce50a74cbe2e7ccd +config: 27a2a69e3df2cb09648bfa066aeb0e3d tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.5.0/_static/basic.css b/v7.5.0/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v7.5.0/_static/basic.css +++ b/v7.5.0/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v7.5.0/_static/debug.css b/v7.5.0/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v7.5.0/_static/debug.css +++ b/v7.5.0/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v7.5.0/_static/pygments.css b/v7.5.0/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v7.5.0/_static/pygments.css +++ b/v7.5.0/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v7.5.0/_static/skeleton.css b/v7.5.0/_static/skeleton.css index 01231167..467c878c 100644 --- a/v7.5.0/_static/skeleton.css +++ b/v7.5.0/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v7.5.0/changelog.html b/v7.5.0/changelog.html index d44b9cfe..5d3d382e 100644 --- a/v7.5.0/changelog.html +++ b/v7.5.0/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v7.5.0/index.html b/v7.5.0/index.html index 4ee0f6a0..211cfc5f 100644 --- a/v7.5.0/index.html +++ b/v7.5.0/index.html @@ -2,7 +2,7 @@ - + diff --git a/v7.5.0/output/botcore.async_stats.html b/v7.5.0/output/botcore.async_stats.html index 616c70c3..bf6f476a 100644 --- a/v7.5.0/output/botcore.async_stats.html +++ b/v7.5.0/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
            • - main + main
            • @@ -353,13 +353,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

              Create a new AsyncStatsClient.

              -
              Parameters
              +
              Parameters:
              @@ -368,10 +368,10 @@
              async create_socket()[source]#
              -

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

              +

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

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              diff --git a/v7.5.0/output/botcore.exts.html b/v7.5.0/output/botcore.exts.html index 48af1e2e..1194a932 100644 --- a/v7.5.0/output/botcore.exts.html +++ b/v7.5.0/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
              • - main + main
              • diff --git a/v7.5.0/output/botcore.html b/v7.5.0/output/botcore.html index 0afabf2f..fe88763d 100644 --- a/v7.5.0/output/botcore.html +++ b/v7.5.0/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
                • - main + main
                • @@ -353,14 +353,14 @@ __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
                  +
                  Parameters:
                  @@ -372,8 +372,8 @@ a dummy statsd client will be created.

                  • async add_cog(cog)[source]#

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

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -383,8 +383,8 @@ a dummy statsd client will be created.

                  add_command(command)[source]#

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

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -394,8 +394,8 @@ a dummy statsd client will be created.

                  clear()[source]#

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

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -405,8 +405,8 @@ a dummy statsd client will be created.

                  async close()[source]#

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

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -417,8 +417,8 @@ a dummy statsd client will be created.

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

                  This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -428,8 +428,8 @@ a dummy statsd client will be created.

                  async log_to_dev_log(message)[source]#

                  Log the given message to #dev-log.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -441,8 +441,8 @@ a dummy statsd client will be created.

                  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.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

              @@ -452,8 +452,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

              Clear the internal guild available event when self.guild_id becomes unavailable.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -463,8 +463,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

              Ping all required services on setup to ensure they are up before starting.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -476,8 +476,8 @@ will not be set and guild_available_but_cache_empty event will be e

              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
              -

              Optional[Command]

              +
              Return type:
              +

              Optional[Command]

              @@ -490,8 +490,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -503,8 +503,8 @@ and -
              Return type
              -

              None

              +
              Return type:
              +

              None

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

              Bases: Exception

              +

              Bases: Exception

              Exception class for startup errors.

              diff --git a/v7.5.0/output/botcore.site_api.html b/v7.5.0/output/botcore.site_api.html index 1f83d322..d2c71470 100644 --- a/v7.5.0/output/botcore.site_api.html +++ b/v7.5.0/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
              • - main + main
              • @@ -346,17 +346,17 @@
                class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
                -

                Bases: object

                +

                Bases: object

                A wrapper for the Django Site API.

                __init__(site_api_url, site_api_token, **session_kwargs)[source]#

                Initialize a new APIClient instance.

                -
                Parameters
                +
                Parameters:
                  -

                • site_api_url (str) – The URL of the site API.

                  • -

                • site_api_token (str) – The token to use for authentication.

                  • +

                • site_api_url (str) – The URL of the site API.

                  • +

                • site_api_token (str) – The token to use for authentication.

                • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

                @@ -368,8 +368,8 @@ async close()[source]#

              Close the aiohttp session.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -379,17 +379,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

              Send a DELETE request to the site API and return the JSON response.

              -
              Parameters
              +
              Parameters:
                -

              • endpoint (str) – The endpoint to send the request to.

                • -

              • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                • +

              • endpoint (str) – The endpoint to send the request to.

                • +

              • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

              • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

              -
              Return type
              -

              Optional[dict]

              +
              Return type:
              +

              Optional[dict]

              -
              Returns
              +
              Returns:

              The JSON response the API returns, or None if the response is 204 No Content.

              @@ -400,8 +400,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

              -
              Return type
              -

              dict

              +
              Return type:
              +

              dict

              @@ -411,17 +411,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

              -
              Parameters
              +
              Parameters:

              • response (aiohttp.ClientResponse) – The response to check.

                • -

              • should_raise (bool) – Whether or not to raise an exception.

                • +

              • should_raise (bool) – Whether or not to raise an exception.

              -
              Raises
              +
              Raises:

              ResponseCodeError – If the response is not OK and should_raise is True.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -431,8 +431,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

              -
              Return type
              -

              dict

              +
              Return type:
              +

              dict

              @@ -442,8 +442,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

              -
              Return type
              -

              dict

              +
              Return type:
              +

              dict

              @@ -453,8 +453,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

              -
              Return type
              -

              dict

              +
              Return type:
              +

              dict

              @@ -464,21 +464,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

              Send an HTTP request to the site API and return the JSON response.

              -
              Parameters
              +
              Parameters:
                -

              • method (str) – The HTTP method to use.

                • -

              • endpoint (str) – The endpoint to send the request to.

                • -

              • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                • +

              • method (str) – The HTTP method to use.

                • +

              • endpoint (str) – The endpoint to send the request to.

                • +

              • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

              • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

              -
              Return type
              -

              dict

              +
              Return type:
              +

              dict

              -
              Returns
              +
              Returns:

              The JSON response the API returns.

              -
              Raises
              +
              Raises:

              ResponseCodeError – If the response is not OK and raise_for_status is True.

              @@ -489,18 +489,18 @@
              exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
              -

              Bases: ValueError

              +

              Bases: ValueError

              Raised in APIClient.request() when a non-OK HTTP response is received.

              __init__(response, response_json=None, response_text=None)[source]#

              Initialize a new ResponseCodeError instance.

              -
              Parameters
              +
              Parameters:

              • response (aiohttp.ClientResponse) – The response object from the request.

                • -

              • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                • -

              • response_text (Optional[str]) – The text of the request, if any.

                • +

              • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                • +

              • response_text (Optional[str]) – The text of the request, if any.

              diff --git a/v7.5.0/output/botcore.utils.caching.html b/v7.5.0/output/botcore.utils.caching.html index 85034495..415a18e6 100644 --- a/v7.5.0/output/botcore.utils.caching.html +++ b/v7.5.0/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
              • - main + main
              • @@ -346,7 +346,7 @@
                class AsyncCache(max_size=128)[source]#
                -

                Bases: object

                +

                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.

                @@ -355,13 +355,13 @@ __call__(arg_offset=0)[source]#

                Decorator for async cache.

                -
                Parameters
                -

                arg_offset (int) – The offset for the position of the key argument.

                +
                Parameters:
                +

                arg_offset (int) – The offset for the position of the key argument.

                -
                Return type
                -

                Callable

                +
                Return type:
                +

                Callable

                -
                Returns
                +
                Returns:

                A decorator to wrap the target function.

                @@ -372,8 +372,8 @@ __init__(max_size=128)[source]#

                Initialise a new AsyncCache instance.

                -
                Parameters
                -

                max_size (int) – How many items to store in the cache.

                +
                Parameters:
                +

                max_size (int) – How many items to store in the cache.

                @@ -383,8 +383,8 @@ clear()[source]#

                Clear cache instance.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

              diff --git a/v7.5.0/output/botcore.utils.channel.html b/v7.5.0/output/botcore.utils.channel.html index 44281631..8eaca6a1 100644 --- a/v7.5.0/output/botcore.utils.channel.html +++ b/v7.5.0/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
              • - main + main
              • @@ -348,13 +348,13 @@ 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
                +
                Parameters:

                • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

                  • -

                • channel_id (int) – The channel to get/fetch.

                  • +

                • channel_id (int) – The channel to get/fetch.

                -
                Raises
                +
                Raises:
                -
                Return type
                +
                Return type:

                GuildChannel

                -
                Returns
                +
                Returns:

                The channel from the ID.

                @@ -376,16 +376,16 @@ is_in_category(channel, category_id)[source]#

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

                -
                Parameters
                +
                Parameters:

                • channel (TextChannel) – The channel to check.

                  • -

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

                  • +

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

                -
                Return type
                -

                bool

                +
                Return type:
                +

                bool

                -
                Returns
                +
                Returns:

                A bool depending on whether the channel is in the category.

                diff --git a/v7.5.0/output/botcore.utils.commands.html b/v7.5.0/output/botcore.utils.commands.html index 1f5786ba..1b637c15 100644 --- a/v7.5.0/output/botcore.utils.commands.html +++ b/v7.5.0/output/botcore.utils.commands.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
                • - main + main
                • @@ -347,19 +347,19 @@ async clean_text_or_reply(ctx, text=None)[source]#

                  Cleans a text argument or replied message’s content.

                  -
                  Parameters
                  +
                  Parameters:

                  • ctx (Context) – The command’s context

                    • -

                  • text (Optional[str]) – The provided text argument of the command (if given)

                    • +

                  • text (Optional[str]) – The provided text argument of the command (if given)

                  -
                  Raises
                  +
                  Raises:

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

                  -
                  Return type
                  -

                  str

                  +
                  Return type:
                  +

                  str

                  -
                  Returns
                  +
                  Returns:

                  The cleaned version of text, if given, else replied message.

                  diff --git a/v7.5.0/output/botcore.utils.html b/v7.5.0/output/botcore.utils.html index 01d661dc..5665091c 100644 --- a/v7.5.0/output/botcore.utils.html +++ b/v7.5.0/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
                  • - main + main
                  • @@ -356,8 +356,8 @@ that will act as top-level groups rather than being aliases of the command’s g
              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -367,13 +367,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

              -
              Parameters
              -

              name (str) – The module name to unqualify.

              +
              Parameters:
              +

              name (str) – The module name to unqualify.

              -
              Return type
              -

              str

              +
              Return type:
              +

              str

              -
              Returns
              +
              Returns:

              The unqualified module name.

              diff --git a/v7.5.0/output/botcore.utils.interactions.html b/v7.5.0/output/botcore.utils.interactions.html index 65c01bb6..797cca4a 100644 --- a/v7.5.0/output/botcore.utils.interactions.html +++ b/v7.5.0/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
              • - main + main
              • @@ -350,10 +350,10 @@

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

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

                -
                Parameters
                +
                Parameters:

                • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

                  • -

                • label (str) – The label of the button, set to “Delete” if not specified.

                  • +

                • label (str) – The label of the button, set to “Delete” if not specified.

                @@ -367,8 +367,8 @@ async callback(interaction)[source]#

                Delete the original message on button click.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -381,13 +381,13 @@

                Bases: View

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

                -
                Parameters
                +
                Parameters:
                  -

                • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                  • -

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

                • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                  • +

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

                @@ -402,11 +402,11 @@ If Noneasync interaction_check(interaction)[source]#

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

                -
                Parameters
                +
                Parameters:

                interaction (Interaction) – The interaction that occurred.

                -
                Return type
                -

                bool

                +
                Return type:
                +

                bool

                @@ -416,8 +416,8 @@ If Noneasync on_timeout()[source]#

                Remove the view from self.message if set.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                diff --git a/v7.5.0/output/botcore.utils.logging.html b/v7.5.0/output/botcore.utils.logging.html index 4114cffa..075aa525 100644 --- a/v7.5.0/output/botcore.utils.logging.html +++ b/v7.5.0/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
                • - main + main
                • @@ -346,8 +346,8 @@
                  class CustomLogger(name, level=0)[source]#
                  -

                  Bases: Logger

                  -

                  Custom implementation of the logging.Logger class with an added trace method.

                  +

                  Bases: Logger

                  +

                  Custom implementation of the logging.Logger class with an added trace method.

                  trace(msg, *args, **kwargs)[source]#
                  @@ -357,15 +357,15 @@
                  -
                  Parameters
                  +
                  Parameters:
                    -

                  • msg (str) – The message to be logged.

                    • +

                  • msg (str) – The message to be logged.

                  • args – Passed to the base log function as is.

                  • kwargs – Passed to the base log function as is.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -377,13 +377,13 @@ get_logger(name=None)[source]#

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

                  -
                  Parameters
                  -

                  name (Optional[str]) – The name given to the logger.

                  +
                  Parameters:
                  +

                  name (Optional[str]) – The name given to the logger.

                  -
                  Return type
                  +
                  Return type:

                  CustomLogger

                  -
                  Returns
                  +
                  Returns:

                  An instance of the CustomLogger class.

                  diff --git a/v7.5.0/output/botcore.utils.members.html b/v7.5.0/output/botcore.utils.members.html index 2a07817e..b649b389 100644 --- a/v7.5.0/output/botcore.utils.members.html +++ b/v7.5.0/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
                  diff --git a/v7.5.0/output/botcore.utils.regex.html b/v7.5.0/output/botcore.utils.regex.html index 38b1284d..98c690cf 100644 --- a/v7.5.0/output/botcore.utils.regex.html +++ b/v7.5.0/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
                  • - main + main
                  • @@ -351,7 +351,7 @@

                    Warning

                    This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                    +such as urllib.parse.quote().

                    diff --git a/v7.5.0/output/botcore.utils.scheduling.html b/v7.5.0/output/botcore.utils.scheduling.html index 11bccc85..8d19a2d9 100644 --- a/v7.5.0/output/botcore.utils.scheduling.html +++ b/v7.5.0/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -203,7 +203,7 @@
                    • - main + main
                    • @@ -346,7 +346,7 @@
                      class Scheduler(name)[source]#
                      -

                      Bases: object

                      +

                      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 instance’s log messages from other instances. Using the name of the class or module containing @@ -360,16 +360,16 @@ the same ID used to schedule it.

                      __contains__(task_id)[source]#
                      -

                      Return True if a task with the given task_id is currently scheduled.

                      +

                      Return True if a task with the given task_id is currently scheduled.

                      -
                      Parameters
                      -

                      task_id (Hashable) – The task to look for.

                      +
                      Parameters:
                      +

                      task_id (Hashable) – The task to look for.

                      -
                      Return type
                      -

                      bool

                      +
                      Return type:
                      +

                      bool

                      -
                      Returns
                      -

                      True if the task was found.

                      +
                      Returns:
                      +

                      True if the task was found.

                      @@ -379,8 +379,8 @@ the same ID used to schedule it.

                      __init__(name)[source]#

                      Initialize a new Scheduler instance.

                      -
                      Parameters
                      -

                      name (str) – The name of the Scheduler. Used in logging, and namespacing.

                      +
                      Parameters:
                      +

                      name (str) – The name of the Scheduler. Used in logging, and namespacing.

                      @@ -390,11 +390,11 @@ the same ID used to schedule it.

                      cancel(task_id)[source]#

                      Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                      -
                      Parameters
                      -

                      task_id (Hashable) – The task’s unique ID.

                      +
                      Parameters:
                      +

                      task_id (Hashable) – The task’s unique ID.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -404,8 +404,8 @@ the same ID used to schedule it.

                      cancel_all()[source]#

                      Unschedule all known tasks.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -417,14 +417,14 @@ the same ID used to schedule it.

                      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.

                      -
                      Parameters
                      +
                      Parameters:
                        -

                      • task_id (Hashable) – A unique ID to create the task with.

                        • -

                      • coroutine (Coroutine) – The function to be called.

                        • +

                      • task_id (Hashable) – A unique ID to create the task with.

                        • +

                      • coroutine (Coroutine) – The function to be called.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

              @@ -439,15 +439,15 @@ If timeIf 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.

              -
              Parameters
              +
              Parameters:
                -

              • time (datetime) – The time to start the task.

                • -

              • task_id (Hashable) – A unique ID to create the task with.

                • -

              • coroutine (Coroutine) – The function to be called.

                • +

              • time (datetime) – The time to start the task.

                • +

              • task_id (Hashable) – A unique ID to create the task with.

                • +

              • coroutine (Coroutine) – The function to be called.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -459,15 +459,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

              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.

              -
              Parameters
              +
              Parameters:
                -

              • delay (Union[int, float]) – How long to wait before starting the task.

                • -

              • task_id (Hashable) – A unique ID to create the task with.

                • -

              • coroutine (Coroutine) – The function to be called.

                • +

              • delay (Union[int, float]) – How long to wait before starting the task.

                • +

              • task_id (Hashable) – A unique ID to create the task with.

                • +

              • coroutine (Coroutine) – The function to be called.

              -
              Return type
              -

              None

              +
              Return type:
              +

              None

              @@ -477,23 +477,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
              create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
              -

              Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

              +

              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.

              -
              Parameters
              +
              Parameters:
              -
              Returns
              +
              Returns:

              The wrapped task.

              -
              Return type
              -

              asyncio.Task

              +
              Return type:
              +

              asyncio.Task

              diff --git a/v7.5.0/searchindex.js b/v7.5.0/searchindex.js index 4da934b9..fdf4c18c 100644 --- a/v7.5.0/searchindex.js +++ b/v7.5.0/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "5": 0, "0": [0, 7, 10, 11], "23rd": 0, "juli": 0, "2022": 0, "featur": [0, 2], "101": 0, "add": [0, 2], "util": [0, 1, 2, 7, 10, 11], "clean": [0, 9], "string": [0, 5], "referenc": 0, "messag": [0, 2, 9, 10, 11, 14], "": [0, 6, 7, 9, 10, 11, 13, 14], "content": [0, 5, 9], "4": 0, "17th": 0, "106": 0, "an": [0, 2, 3, 5, 6, 7, 8, 11, 14], "option": [0, 2, 3, 5, 7, 9, 10, 11, 12], "attr": 0, "botcor": [0, 1, 10], "interact": [0, 2, 6, 8], "viewwithuserandrolecheck": [0, 2, 6, 10], "On": 0, "view": [0, 10], "timeout": [0, 10], "thi": [0, 2, 6, 8, 10, 12, 13, 14], "ha": [0, 6], "its": [0, 2], "remov": [0, 2, 10], "set": [0, 2, 10], "3": 0, "1": [0, 11], "16th": 0, "bug": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 2, 6, 10], "work": 0, "due": 0, "us": [0, 2, 3, 5, 6, 8, 11, 12, 13, 14], "wrong": 0, "delet": [0, 2, 5, 7, 10], "method": [0, 3, 5, 6, 11], "103": 0, "button": [0, 10], "attach": 0, "parent": [0, 10], "gener": [0, 2, 14], "onli": [0, 2], "allow": [0, 2, 10], "specifi": [0, 10], "user": [0, 10], "role": [0, 2, 10, 12], "2": [0, 2, 10], "9th": 0, "98": 0, "close": [0, 1, 2, 5, 14], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 14], "creat": [0, 2, 3, 7, 14], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 10, 12], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 11, 12, 14], "self": [0, 2, 10], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 14], "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 12], "96": 0, "attempt": [0, 2, 8, 12], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 14], "i": [0, 2, 5, 6, 8, 10, 11, 12, 14], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 12, 14], "28th": 0, "support": [0, 3, 6, 14], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 9, 12, 13], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 14], "new": [0, 3, 5, 7, 14], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 11], "avail": [0, 2], "older": 0, "doc": 0, "version": [0, 9], "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 14], "out": [0, 10], "10th": 0, "break": 0, "75": 0, "invit": [0, 13], "regex": [0, 2, 6], "longer": [0, 10], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 14], "url": [0, 2, 5], "safe": 0, "result": [0, 14], "refer": 0, "document": 0, "handl": [0, 12, 14], "captur": [0, 13], "all": [0, 2, 3, 6, 14], "charact": 0, "up": [0, 2], "whitespac": [0, 13], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 2, 12], "chunk": 0, "base": [0, 2, 3, 5, 7, 10, 11, 14], "number": 0, "so": [0, 6], "should": [0, 2, 5, 10], "actual": 0, "now": [0, 14], "25th": 0, "69": 0, "get": [0, 2, 5, 8, 12], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 14], "t": [0, 9, 14], "load": [0, 2, 6], "modul": [0, 2, 6, 14], "start": [0, 2, 14], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "own": 0, "task": [0, 2, 14], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 14], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 11], "pagin": 0, "also": [0, 6, 10], "basic": [0, 10], "forum": 0, "channel": [0, 2, 6], "18th": 0, "63": 0, "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 10, 14], "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 11, 14], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 14], "event": [0, 2, 3, 14], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 10, 14], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 9, 10, 12], "42": 0, "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8, 9], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 10, 11, 14], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 12, 14], "trace": [0, 6, 11], "import": 0, "can": [0, 10, 14], "function": [0, 2, 7, 8, 11, 12, 14], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 12], "wrapper": [0, 5, 14], "from": [0, 2, 3, 5, 6, 8, 10, 12, 14], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 11, 13], "cach": [0, 2, 6, 8, 12], "logger": [0, 11], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 10, 11], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 13], "block": [0, 13], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 11], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 11], "guild_id": 2, "allowed_rol": [2, 10], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 10, 11, 14], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14], "A": [2, 5, 6, 7, 8, 10, 14], "implement": [2, 3, 7, 10, 11], "python": [2, 14], "initialis": [2, 7], "int": [2, 3, 7, 8, 10, 14], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 14], "id": [2, 8, 10, 14], "list": 2, "mention": 2, "clientsess": [2, 5], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 11, 14], "server": [2, 13], "If": [2, 5, 10, 14], "given": [2, 3, 6, 8, 9, 11, 12, 14], "oper": [2, 14], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 14], "normal": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 14], "instanti": [2, 10, 14], "instead": [2, 14], "connector": 2, "resolv": 2, "save": 2, "them": [2, 14], "all_extens": 2, "ran": 2, "loop": [2, 3, 14], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 14], "dev": 2, "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 14], "servic": 2, "ensur": [2, 10, 13], "thei": 2, "ar": [2, 7, 10, 13], "name": [2, 6, 11, 14], "alia": [2, 6], "individu": 2, "To": [2, 11], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "create_socket": [2, 3], "wait": [2, 14], "until": [2, 13], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 10, 14], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 11, 14], "error": [2, 5, 6, 12], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "clean_text_or_repli": [2, 6, 9], "customlogg": [2, 6, 11], "get_logg": [2, 6, 11], "get_or_fetch_memb": [2, 6, 12], "discord_invit": [2, 6, 13], "formatted_code_regex": [2, 6, 13], "raw_code_regex": [2, 6, 13], "create_task": [2, 6, 14], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 13], "__str__": [2, 5], "transport": 3, "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 14], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 12, 14], "django": 5, "initi": [5, 14], "token": 5, "authent": 5, "keyword": [5, 6, 11], "argument": [5, 6, 7, 9, 11, 12], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 11, 14], "send": [5, 10], "json": 5, "respons": 5, "bool": [5, 8, 10, 14], "whether": [5, 8], "rais": [5, 8, 9, 12, 14], "ok": 5, "ani": [5, 13, 14], "extra": 5, "dict": 5, "204": 5, "No": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 10, 14], "http": [5, 13], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": [5, 9], "represent": 5, "appli": [6, 7], "group": [6, 13], "root_alias": 6, "two": 6, "sequenc": [6, 10], "act": 6, "top": 6, "level": [6, 11], "rather": 6, "than": 6, "being": [6, 12], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "callback": [6, 10], "interaction_check": [6, 10], "on_timeout": [6, 10], "__contains__": [6, 14], "cancel": [6, 14], "cancel_al": [6, 14], "schedule_at": [6, 14], "schedule_lat": [6, 14], "relat": [7, 11], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 12, 14], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 14], "offset": 7, "provid": [7, 9, 14], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 12], "wrap": [7, 14], "target": 7, "how": [7, 14], "item": 7, "helper": [8, 12], "variou": 8, "channel_id": 8, "fetch": [8, 12], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 13], "do": 8, "have": [8, 11], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "ctx": [9, 10], "repli": 9, "context": 9, "badargu": 9, "wasn": 9, "els": 9, "style": 10, "buttonstyl": 10, "secondari": 10, "label": 10, "contain": [10, 14], "click": 10, "itself": 10, "carri": 10, "done": [10, 14], "see": 10, "origin": 10, "allowed_us": 10, "180": 10, "invok": 10, "moder": 10, "who": 10, "float": [10, 14], "last": 10, "ui": 10, "accept": 10, "input": 10, "similar": [10, 13], "after": [10, 14], "occur": 10, "msg": 11, "sever": 11, "exc_info": 11, "valu": 11, "houston": 11, "we": [11, 12], "interest": 11, "problem": 11, "mypi": 11, "recognis": 11, "interactin": 12, "member_id": 12, "failur": 12, "indic": 12, "could": 12, "found": [12, 14], "coro": [12, 14], "sole": 12, "expect": 12, "add_rol": 12, "remove_rol": 12, "modifi": 12, "purpos": 12, "intend": 12, "regular": 13, "express": 13, "pattern": 13, "pleas": 13, "sanitis": 13, "output": 13, "someth": 13, "urllib": 13, "pars": 13, "quot": 13, "format": 13, "raw": 13, "execut": 14, "keep": 14, "track": 14, "must": 14, "distinguish": 14, "other": 14, "suggest": 14, "immedi": 14, "futur": 14, "uniqu": 14, "prematur": 14, "same": 14, "current": 14, "task_id": 14, "hashabl": 14, "look": 14, "unschedul": 14, "identifi": 14, "warn": 14, "doesn": 14, "exist": 14, "known": 14, "alreadi": 14, "prevent": 14, "unawait": 14, "ll": 14, "elsewher": 14, "timezon": 14, "awar": 14, "calcul": 14, "subtract": 14, "na\u00efv": 14, "utc": 14, "past": 14, "datetim": 14, "delai": 14, "union": 14, "long": 14, "suppressed_except": 14, "event_loop": 14, "otherwis": 14, "run": 14, "typevar": 14, "task_return": 14, "tupl": 14}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "commands"], [10, 0, 0, "-", "interactions"], [11, 0, 0, "-", "logging"], [12, 0, 0, "-", "members"], [13, 0, 0, "-", "regex"], [14, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[9, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[10, 1, 1, "", "DeleteMessageButton"], [10, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[10, 2, 1, "", "__init__"], [10, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[10, 2, 1, "", "__init__"], [10, 2, 1, "", "interaction_check"], [10, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[11, 1, 1, "", "CustomLogger"], [11, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[11, 2, 1, "", "trace"]], "botcore.utils.members": [[12, 4, 1, "", "get_or_fetch_member"], [12, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[13, 5, 1, "", "DISCORD_INVITE"], [13, 5, 1, "", "FORMATTED_CODE_REGEX"], [13, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[14, 1, 1, "", "Scheduler"], [14, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[14, 2, 1, "", "__contains__"], [14, 2, 1, "", "__init__"], [14, 2, 1, "", "cancel"], [14, 2, 1, "", "cancel_all"], [14, 2, 1, "", "schedule"], [14, 2, 1, "", "schedule_at"], [14, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "command": 9, "interact": 10, "log": 11, "member": 12, "regex": 13, "schedul": 14}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Utils": [[6, "module-botcore.utils"]], "Submodules": [[6, "submodules"], [2, "submodules"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "async_stats": [[3, "module-botcore.async_stats"]], "Exts": [[4, "module-botcore.exts"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "Changelog": [[0, "changelog"]], "site_api": [[5, "module-botcore.site_api"]], "commands": [[9, "module-botcore.utils.commands"]], "interactions": [[10, "module-botcore.utils.interactions"]], "channel": [[8, "module-botcore.utils.channel"]], "members": [[12, "module-botcore.utils.members"]], "logging": [[11, "module-botcore.utils.logging"]], "caching": [[7, "module-botcore.utils.caching"]], "regex": [[13, "module-botcore.utils.regex"]], "scheduling": [[14, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.commands"], [10, "module-botcore.utils.interactions"], [11, "module-botcore.utils.logging"], [12, "module-botcore.utils.members"], [13, "module-botcore.utils.regex"], [14, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[9, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[9, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[10, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[10, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[10, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[10, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[10, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[10, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[10, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[10, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[11, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[11, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[11, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[11, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[12, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[12, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[12, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[13, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[13, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[13, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[13, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[14, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[14, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[14, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"7": 0, "5": 0, "0": [0, 7, 10, 11], "23rd": 0, "juli": 0, "2022": 0, "featur": [0, 2], "101": 0, "add": [0, 2], "util": [0, 1, 2, 7, 10, 11], "clean": [0, 9], "string": [0, 5], "referenc": 0, "messag": [0, 2, 9, 10, 11, 14], "": [0, 6, 7, 9, 10, 11, 13, 14], "content": [0, 5, 9], "4": 0, "17th": 0, "106": 0, "an": [0, 2, 3, 5, 6, 7, 8, 11, 14], "option": [0, 2, 3, 5, 7, 9, 10, 11, 12], "attr": 0, "botcor": [0, 1, 10], "interact": [0, 2, 6, 8], "viewwithuserandrolecheck": [0, 2, 6, 10], "On": 0, "view": [0, 10], "timeout": [0, 10], "thi": [0, 2, 6, 8, 10, 12, 13, 14], "ha": [0, 6], "its": [0, 2], "remov": [0, 2, 10], "set": [0, 2, 10], "3": 0, "1": [0, 11], "16th": 0, "bug": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 2, 6, 10], "work": 0, "due": 0, "us": [0, 2, 3, 5, 6, 8, 11, 12, 13, 14], "wrong": 0, "delet": [0, 2, 5, 7, 10], "method": [0, 3, 5, 6, 11], "103": 0, "button": [0, 10], "attach": 0, "parent": [0, 10], "gener": [0, 2, 14], "onli": [0, 2], "allow": [0, 2, 10], "specifi": [0, 10], "user": [0, 10], "role": [0, 2, 10, 12], "2": [0, 2, 10], "9th": 0, "98": 0, "close": [0, 1, 2, 5, 14], "botbas": [0, 1, 2], "stat": [0, 3], "_transport": 0, "wa": [0, 8, 14], "creat": [0, 2, 3, 7, 14], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 10, 12], "ping_servic": [0, 1, 2], "some": 0, "case": 0, "pass": [0, 5, 11, 12, 14], "self": [0, 2, 10], "paramet": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 14], "incorrect": 0, "docstr": 0, "member": [0, 2, 6], "handle_role_chang": [0, 2, 6, 12], "96": 0, "attempt": [0, 2, 8, 12], "connect": [0, 2, 3], "statsd_url": [0, 2], "when": [0, 2, 3, 5, 6, 7, 14], "i": [0, 2, 5, 6, 8, 10, 11, 12, 14], "none": [0, 2, 3, 5, 6, 7, 9, 10, 11, 12, 14], "28th": 0, "support": [0, 3, 6, 14], "93": 0, "bump": 0, "discord": [0, 2, 4, 6, 8, 9, 12, 13], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 6, 14], "new": [0, 3, 5, 7, 14], "auto_mod": 0, "message_typ": 0, "need": 0, "our": [0, 6], "filter": 0, "system": 0, "mai": [0, 7], "79": 0, "restor": 0, "site": [0, 5], "sphinx": 0, "multivers": 0, "make": [0, 11], "avail": [0, 2], "older": 0, "doc": 0, "version": [0, 9], "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 8], "resolut": 0, "deal": 0, "time": [0, 14], "out": [0, 10], "10th": 0, "break": 0, "75": 0, "invit": [0, 13], "regex": [0, 2, 6], "longer": [0, 10], "return": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 14], "url": [0, 2, 5], "safe": 0, "result": [0, 14], "refer": 0, "document": 0, "handl": [0, 12, 14], "captur": [0, 13], "all": [0, 2, 3, 6, 14], "charact": 0, "up": [0, 2], "whitespac": [0, 13], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 2], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 2, 12], "chunk": 0, "base": [0, 2, 3, 5, 7, 10, 11, 14], "number": 0, "so": [0, 6], "should": [0, 2, 5, 10], "actual": 0, "now": [0, 14], "25th": 0, "69": 0, "get": [0, 2, 5, 8, 12], "21st": 0, "68": 0, "correct": 0, "pyproject": 0, "toml": 0, "directli": 0, "main": 0, "don": [0, 14], "t": [0, 9, 14], "load": [0, 2, 6], "modul": [0, 2, 6, 14], "start": [0, 2, 14], "_": 0, "66": 0, "each": 0, "cog": [0, 2, 4], "own": 0, "task": [0, 2, 14], "avoid": [0, 2], "singl": 0, "crash": 0, "entir": [0, 2], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 1, 2, 6], "namespac": [0, 14], "bot": [0, 2, 6, 8], "manipul": 0, "extens": [0, 2], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": 0, "help": 0, "command": [0, 2, 6, 8], "behaviour": 0, "broke": 0, "custom": [0, 7, 11], "pagin": 0, "also": [0, 6, 10], "basic": [0, 10], "forum": 0, "channel": [0, 2, 6], "18th": 0, "63": 0, "api_cli": [0, 2], "__init__": [0, 1, 2, 3, 5, 6, 7, 10, 14], "site_api": [0, 1, 2], "apicli": [0, 1, 2, 5], "instanc": [0, 2, 5, 7, 8, 11, 14], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 2, 5], "setup": [0, 2], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 3, 14], "event": [0, 2, 3, 14], "_guild_avail": 0, "within": [0, 2], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 2], "asyncstatsdcli": 0, "befor": [0, 2, 10, 14], "real": 0, "cannot": [0, 2], "made": 0, "init": [0, 2, 3], "2nd": 0, "54": 0, "aiohttp": [0, 2, 5], "asyncresolv": 0, "async": [0, 2, 3, 5, 7, 8, 9, 10, 12], "42": 0, "public": 0, "statsd": [0, 2, 3], "client": [0, 2, 3], "ext": [0, 1, 2, 6, 8, 9], "sub": [0, 2], "class": [0, 2, 3, 5, 7, 10, 11, 14], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": 0, "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 2, 6, 12, 14], "trace": [0, 6, 11], "import": 0, "can": [0, 10, 14], "function": [0, 2, 7, 8, 11, 12, 14], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 1, 2, 6], "februari": 0, "34": 0, "port": [0, 3], "api": [0, 5, 12], "wrapper": [0, 5, 14], "from": [0, 2, 3, 5, 6, 8, 10, 12, 14], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 2, 7], "common": [0, 2, 6, 11, 13], "cach": [0, 2, 6, 8, 12], "logger": [0, 11], "schedul": [0, 2, 6], "monkei": [0, 6], "patch": [0, 2, 5, 6], "ad": [0, 6, 10, 11], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 13], "block": [0, 13], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "core": 0, "packag": [0, 6], "poetri": 0, "lint": 0, "ci": 0, "add_cog": [1, 2], "add_command": [1, 2], "clear": [1, 2, 6, 7], "load_extens": [1, 2], "log_to_dev_log": [1, 2], "on_guild_avail": [1, 2], "on_guild_unavail": [1, 2], "remove_command": [1, 2], "setup_hook": [1, 2], "wait_until_guild_avail": [1, 2], "startuperror": [1, 2], "subpackag": 1, "submodul": 1, "async_stat": [1, 2], "asyncstatscli": [1, 2, 3], "responsecodeerror": [1, 2, 5], "index": 1, "search": 1, "page": 1, "inform": [1, 11], "changelog": 1, "tool": [2, 6], "develop": [2, 6], "arg": [2, 11], "guild_id": 2, "allowed_rol": [2, 10], "http_session": 2, "redis_sess": 2, "kwarg": [2, 5, 10, 11, 14], "sourc": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14], "A": [2, 5, 6, 7, 8, 10, 14], "implement": [2, 3, 7, 10, 11], "python": [2, 14], "initialis": [2, 7], "int": [2, 3, 7, 8, 10, 14], "The": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 14], "id": [2, 8, 10, 14], "list": 2, "mention": 2, "clientsess": [2, 5], "redissess": 2, "async_rediscach": 2, "str": [2, 3, 5, 6, 9, 10, 11, 14], "server": [2, 13], "If": [2, 5, 10, 14], "given": [2, 3, 6, 8, 9, 11, 12, 14], "oper": [2, 14], "type": [2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 14], "normal": 2, "root": [2, 6], "alias": [2, 6], "Not": 2, "re": [2, 14], "instanti": [2, 10, 14], "instead": [2, 14], "connector": 2, "resolv": 2, "save": 2, "them": [2, 14], "all_extens": 2, "ran": 2, "loop": [2, 3, 14], "deadlock": 2, "caus": [2, 6], "wait_for": 2, "call": [2, 14], "dev": 2, "intern": [2, 6], "becom": 2, "appear": 2, "still": 2, "empti": 2, "guild_available_but_cache_empti": 2, "emit": 2, "unavail": 2, "ping": 2, "requir": [2, 14], "servic": 2, "ensur": [2, 10, 13], "thei": 2, "ar": [2, 7, 10, 13], "name": [2, 6, 11, 14], "alia": [2, 6], "individu": 2, "To": [2, 11], "either": 2, "manual": 2, "edit": 2, "all_command": 2, "startup": 2, "create_socket": [2, 3], "wait": [2, 14], "until": [2, 13], "match": 2, "readi": 2, "on_readi": 2, "inadequ": 2, "becaus": 2, "second": [2, 10, 14], "guild_creat": 2, "gatewai": 2, "give": 2, "thu": 2, "popul": 2, "except": [2, 5, 11, 14], "error": [2, 5, 6, 12], "asynccach": [2, 6, 7], "get_or_fetch_channel": [2, 6, 8], "is_in_categori": [2, 6, 8], "clean_text_or_repli": [2, 6, 9], "customlogg": [2, 6, 11], "get_logg": [2, 6, 11], "get_or_fetch_memb": [2, 6, 12], "discord_invit": [2, 6, 13], "formatted_code_regex": [2, 6, 13], "raw_code_regex": [2, 6, 13], "create_task": [2, 6, 14], "maybe_raise_for_statu": [2, 5], "post": [2, 5], "put": [2, 5], "request": [2, 5, 13], "__str__": [2, 5], "transport": 3, "commun": 3, "host": 3, "localhost": 3, "8125": 3, "prefix": 3, "statsclientbas": 3, "abstracteventloop": [3, 14], "create_datagram_endpoint": 3, "socket": 3, "reusabl": 4, "around": 5, "site_api_url": 5, "site_api_token": 5, "session_kwarg": 5, "object": [5, 6, 7, 8, 12, 14], "django": 5, "initi": [5, 14], "token": 5, "authent": 5, "keyword": [5, 6, 11], "argument": [5, 6, 7, 9, 11, 12], "constructor": 5, "endpoint": 5, "raise_for_statu": 5, "true": [5, 11, 14], "send": [5, 10], "json": 5, "respons": 5, "bool": [5, 8, 10, 14], "whether": [5, 8], "rais": [5, 8, 9, 12, 14], "ok": 5, "ani": [5, 13, 14], "extra": 5, "dict": 5, "204": 5, "No": 5, "equival": 5, "static": 5, "should_rais": 5, "non": 5, "clientrespons": 5, "check": [5, 8, 10, 14], "http": [5, 13], "response_json": 5, "response_text": 5, "valueerror": 5, "receiv": [5, 8], "text": [5, 9], "represent": 5, "appli": [6, 7], "group": [6, 13], "root_alias": 6, "two": 6, "sequenc": [6, 10], "act": 6, "top": 6, "level": [6, 11], "rather": 6, "than": 6, "being": [6, 12], "It": 6, "store": [6, 7], "attribut": 6, "send_typ": 6, "ignor": 6, "403": 6, "under": 6, "heavi": 6, "cloudflar": 6, "worker": 6, "rout": 6, "thrown": 6, "qualifi": 6, "__call__": [6, 7], "callback": [6, 10], "interaction_check": [6, 10], "on_timeout": [6, 10], "__contains__": [6, 14], "cancel": [6, 14], "cancel_al": [6, 14], "schedule_at": [6, 14], "schedule_lat": [6, 14], "relat": [7, 11], "max_siz": 7, "128": 7, "lru": 7, "coroutin": [7, 12, 14], "onc": 7, "exce": 7, "maximum": 7, "size": 7, "kei": 7, "fifo": 7, "order": [7, 14], "offset": 7, "provid": [7, 9, 14], "arg_offset": 7, "decor": 7, "posit": 7, "callabl": [7, 12], "wrap": [7, 14], "target": 7, "how": [7, 14], "item": 7, "helper": [8, 12], "variou": 8, "channel_id": 8, "fetch": [8, 12], "invaliddata": 8, "unknown": 8, "httpexcept": 8, "retriev": 8, "fail": 8, "notfound": 8, "invalid": 8, "forbidden": 8, "you": [8, 13], "do": 8, "have": [8, 11], "guildchannel": 8, "category_id": 8, "categori": 8, "textchannel": 8, "depend": 8, "ctx": [9, 10], "repli": 9, "context": 9, "badargu": 9, "wasn": 9, "els": 9, "style": 10, "buttonstyl": 10, "secondari": 10, "label": 10, "contain": [10, 14], "click": 10, "itself": 10, "carri": 10, "done": [10, 14], "see": 10, "origin": 10, "allowed_us": 10, "180": 10, "invok": 10, "moder": 10, "who": 10, "float": [10, 14], "last": 10, "ui": 10, "accept": 10, "input": 10, "similar": [10, 13], "after": [10, 14], "occur": 10, "msg": 11, "sever": 11, "exc_info": 11, "valu": 11, "houston": 11, "we": [11, 12], "interest": 11, "problem": 11, "mypi": 11, "recognis": 11, "interactin": 12, "member_id": 12, "failur": 12, "indic": 12, "could": 12, "found": [12, 14], "coro": [12, 14], "sole": 12, "expect": 12, "add_rol": 12, "remove_rol": 12, "modifi": 12, "purpos": 12, "intend": 12, "regular": 13, "express": 13, "pattern": 13, "pleas": 13, "sanitis": 13, "output": 13, "someth": 13, "urllib": 13, "pars": 13, "quot": 13, "format": 13, "raw": 13, "execut": 14, "keep": 14, "track": 14, "must": 14, "distinguish": 14, "other": 14, "suggest": 14, "immedi": 14, "futur": 14, "uniqu": 14, "prematur": 14, "same": 14, "current": 14, "task_id": 14, "hashabl": 14, "look": 14, "unschedul": 14, "identifi": 14, "warn": 14, "doesn": 14, "exist": 14, "known": 14, "alreadi": 14, "prevent": 14, "unawait": 14, "ll": 14, "elsewher": 14, "timezon": 14, "awar": 14, "calcul": 14, "subtract": 14, "na\u00efv": 14, "utc": 14, "past": 14, "datetim": 14, "delai": 14, "union": 14, "long": 14, "suppressed_except": 14, "event_loop": 14, "otherwis": 14, "run": 14, "typevar": 14, "task_return": 14, "tupl": 14}, "objects": {"": [[2, 0, 0, "-", "botcore"]], "botcore": [[2, 1, 1, "", "BotBase"], [2, 3, 1, "", "StartupError"], [3, 0, 0, "-", "async_stats"], [4, 0, 0, "-", "exts"], [5, 0, 0, "-", "site_api"], [6, 0, 0, "-", "utils"]], "botcore.BotBase": [[2, 2, 1, "", "__init__"], [2, 2, 1, "", "add_cog"], [2, 2, 1, "", "add_command"], [2, 2, 1, "", "clear"], [2, 2, 1, "", "close"], [2, 2, 1, "", "load_extensions"], [2, 2, 1, "", "log_to_dev_log"], [2, 2, 1, "", "on_guild_available"], [2, 2, 1, "", "on_guild_unavailable"], [2, 2, 1, "", "ping_services"], [2, 2, 1, "", "remove_command"], [2, 2, 1, "", "setup_hook"], [2, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[2, 2, 1, "", "__init__"]], "botcore.async_stats": [[3, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "create_socket"]], "botcore.site_api": [[5, 1, 1, "", "APIClient"], [5, 3, 1, "", "ResponseCodeError"]], "botcore.site_api.APIClient": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "close"], [5, 2, 1, "", "delete"], [5, 2, 1, "", "get"], [5, 2, 1, "", "maybe_raise_for_status"], [5, 2, 1, "", "patch"], [5, 2, 1, "", "post"], [5, 2, 1, "", "put"], [5, 2, 1, "", "request"]], "botcore.site_api.ResponseCodeError": [[5, 2, 1, "", "__init__"], [5, 2, 1, "", "__str__"]], "botcore.utils": [[6, 4, 1, "", "apply_monkey_patches"], [7, 0, 0, "-", "caching"], [8, 0, 0, "-", "channel"], [9, 0, 0, "-", "commands"], [10, 0, 0, "-", "interactions"], [11, 0, 0, "-", "logging"], [12, 0, 0, "-", "members"], [13, 0, 0, "-", "regex"], [14, 0, 0, "-", "scheduling"], [6, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[7, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[7, 2, 1, "", "__call__"], [7, 2, 1, "", "__init__"], [7, 2, 1, "", "clear"]], "botcore.utils.channel": [[8, 4, 1, "", "get_or_fetch_channel"], [8, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[9, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[10, 1, 1, "", "DeleteMessageButton"], [10, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[10, 2, 1, "", "__init__"], [10, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[10, 2, 1, "", "__init__"], [10, 2, 1, "", "interaction_check"], [10, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[11, 1, 1, "", "CustomLogger"], [11, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[11, 2, 1, "", "trace"]], "botcore.utils.members": [[12, 4, 1, "", "get_or_fetch_member"], [12, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[13, 5, 1, "", "DISCORD_INVITE"], [13, 5, 1, "", "FORMATTED_CODE_REGEX"], [13, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[14, 1, 1, "", "Scheduler"], [14, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[14, 2, 1, "", "__contains__"], [14, 2, 1, "", "__init__"], [14, 2, 1, "", "cancel"], [14, 2, 1, "", "cancel_all"], [14, 2, 1, "", "schedule"], [14, 2, 1, "", "schedule_at"], [14, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "bot": 1, "core": 1, "project": 1, "document": 1, "refer": 1, "modul": 1, "extra": 1, "botcor": 2, "subpackag": 2, "submodul": [2, 6], "async_stat": 3, "ext": 4, "site_api": 5, "util": 6, "cach": 7, "channel": 8, "command": 9, "interact": 10, "log": 11, "member": 12, "regex": 13, "schedul": 14}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"async_stats": [[3, "module-botcore.async_stats"]], "Utils": [[6, "module-botcore.utils"]], "Submodules": [[6, "submodules"], [2, "submodules"]], "Changelog": [[0, "changelog"]], "Bot Core Project Documentation": [[1, "bot-core-project-documentation"]], "Reference": [[1, "reference"]], "Modules:": [[1, null]], "Extras": [[1, "extras"]], "site_api": [[5, "module-botcore.site_api"]], "Exts": [[4, "module-botcore.exts"]], "Botcore": [[2, "module-botcore"]], "Subpackages": [[2, "subpackages"]], "channel": [[8, "module-botcore.utils.channel"]], "members": [[12, "module-botcore.utils.members"]], "commands": [[9, "module-botcore.utils.commands"]], "caching": [[7, "module-botcore.utils.caching"]], "logging": [[11, "module-botcore.utils.logging"]], "interactions": [[10, "module-botcore.utils.interactions"]], "regex": [[13, "module-botcore.utils.regex"]], "scheduling": [[14, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[2, "botcore.BotBase"]], "startuperror": [[2, "botcore.StartupError"]], "__init__() (botbase method)": [[2, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[2, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[2, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[2, "botcore.BotBase.add_command"]], "botcore": [[2, "module-botcore"]], "clear() (botbase method)": [[2, "botcore.BotBase.clear"]], "close() (botbase method)": [[2, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[2, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[2, "botcore.BotBase.log_to_dev_log"]], "module": [[2, "module-botcore"], [3, "module-botcore.async_stats"], [4, "module-botcore.exts"], [5, "module-botcore.site_api"], [6, "module-botcore.utils"], [7, "module-botcore.utils.caching"], [8, "module-botcore.utils.channel"], [9, "module-botcore.utils.commands"], [10, "module-botcore.utils.interactions"], [11, "module-botcore.utils.logging"], [12, "module-botcore.utils.members"], [13, "module-botcore.utils.regex"], [14, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[2, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[2, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[2, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[2, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[2, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[2, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[3, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[3, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[3, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[4, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[5, "botcore.site_api.APIClient"]], "responsecodeerror": [[5, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[5, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[5, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[5, "module-botcore.site_api"]], "close() (apiclient method)": [[5, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[5, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[5, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[5, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[5, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[5, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[5, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[5, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[6, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[6, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[6, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[7, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[7, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[7, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[8, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[8, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[9, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[9, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[10, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[10, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[10, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[10, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[10, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[10, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[10, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[10, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[11, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[11, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[11, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[11, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[12, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[12, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[12, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[13, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[13, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[13, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[13, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[14, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[14, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[14, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[14, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v8.0.0-beta.1/.buildinfo b/v8.0.0-beta.1/.buildinfo index 99ac4041..59f6ade6 100644 --- a/v8.0.0-beta.1/.buildinfo +++ b/v8.0.0-beta.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: 2bdd07c61f1e9bb53b01db8385a21242 +config: 6f82417935da03efc4cb5ea1c874f385 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v8.0.0-beta.1/_static/basic.css b/v8.0.0-beta.1/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v8.0.0-beta.1/_static/basic.css +++ b/v8.0.0-beta.1/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v8.0.0-beta.1/_static/debug.css b/v8.0.0-beta.1/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v8.0.0-beta.1/_static/debug.css +++ b/v8.0.0-beta.1/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v8.0.0-beta.1/_static/pygments.css b/v8.0.0-beta.1/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v8.0.0-beta.1/_static/pygments.css +++ b/v8.0.0-beta.1/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v8.0.0-beta.1/_static/skeleton.css b/v8.0.0-beta.1/_static/skeleton.css index 01231167..467c878c 100644 --- a/v8.0.0-beta.1/_static/skeleton.css +++ b/v8.0.0-beta.1/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v8.0.0-beta.1/changelog.html b/v8.0.0-beta.1/changelog.html index 43f8110a..b99f7998 100644 --- a/v8.0.0-beta.1/changelog.html +++ b/v8.0.0-beta.1/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.1/development.html b/v8.0.0-beta.1/development.html index cd8560da..01615c3b 100644 --- a/v8.0.0-beta.1/development.html +++ b/v8.0.0-beta.1/development.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.1/index.html b/v8.0.0-beta.1/index.html index d77d4207..d0ac8d2a 100644 --- a/v8.0.0-beta.1/index.html +++ b/v8.0.0-beta.1/index.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.1/output/botcore.async_stats.html b/v8.0.0-beta.1/output/botcore.async_stats.html index 6cdecd4e..71176ed9 100644 --- a/v8.0.0-beta.1/output/botcore.async_stats.html +++ b/v8.0.0-beta.1/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
              • - main + main
              • @@ -354,13 +354,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

                Create a new AsyncStatsClient.

                -
                Parameters
                +
                Parameters:
                @@ -369,10 +369,10 @@
                async create_socket()[source]#
                -

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

                +

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

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                diff --git a/v8.0.0-beta.1/output/botcore.exts.html b/v8.0.0-beta.1/output/botcore.exts.html index a82cfdfe..583b849b 100644 --- a/v8.0.0-beta.1/output/botcore.exts.html +++ b/v8.0.0-beta.1/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                • - main + main
                • diff --git a/v8.0.0-beta.1/output/botcore.html b/v8.0.0-beta.1/output/botcore.html index 27549e7b..1528732a 100644 --- a/v8.0.0-beta.1/output/botcore.html +++ b/v8.0.0-beta.1/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                  • - main + main
                  • @@ -354,14 +354,14 @@ __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
                    +
                    Parameters:
                    @@ -373,8 +373,8 @@ a dummy statsd client will be created.

                    • async add_cog(cog)[source]#

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

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -384,8 +384,8 @@ a dummy statsd client will be created.

                    add_command(command)[source]#

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

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -395,8 +395,8 @@ a dummy statsd client will be created.

                    clear()[source]#

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

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -406,8 +406,8 @@ a dummy statsd client will be created.

                    async close()[source]#

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

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -418,8 +418,8 @@ a dummy statsd client will be created.

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

                    This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -429,8 +429,8 @@ a dummy statsd client will be created.

                    async log_to_dev_log(message)[source]#

                    Log the given message to #dev-log.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -442,8 +442,8 @@ a dummy statsd client will be created.

                    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.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                @@ -453,8 +453,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

                Clear the internal guild available event when self.guild_id becomes unavailable.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -464,8 +464,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

                Ping all required services on setup to ensure they are up before starting.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -477,8 +477,8 @@ will not be set and guild_available_but_cache_empty event will be e

                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
                -

                Optional[Command]

                +
                Return type:
                +

                Optional[Command]

                @@ -491,8 +491,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -504,8 +504,8 @@ and -
                Return type
                -

                None

                +
                Return type:
                +

                None

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

                Bases: Exception

                +

                Bases: Exception

                Exception class for startup errors.

                diff --git a/v8.0.0-beta.1/output/botcore.site_api.html b/v8.0.0-beta.1/output/botcore.site_api.html index 9dc96ed3..bca66af7 100644 --- a/v8.0.0-beta.1/output/botcore.site_api.html +++ b/v8.0.0-beta.1/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                • - main + main
                • @@ -347,17 +347,17 @@
                  class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
                  -

                  Bases: object

                  +

                  Bases: object

                  A wrapper for the Django Site API.

                  __init__(site_api_url, site_api_token, **session_kwargs)[source]#

                  Initialize a new APIClient instance.

                  -
                  Parameters
                  +
                  Parameters:
                    -

                  • site_api_url (str) – The URL of the site API.

                    • -

                  • site_api_token (str) – The token to use for authentication.

                    • +

                  • site_api_url (str) – The URL of the site API.

                    • +

                  • site_api_token (str) – The token to use for authentication.

                  • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

                  @@ -369,8 +369,8 @@ async close()[source]#

                Close the aiohttp session.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -380,17 +380,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

                Send a DELETE request to the site API and return the JSON response.

                -
                Parameters
                +
                Parameters:
                  -

                • endpoint (str) – The endpoint to send the request to.

                  • -

                • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                  • +

                • endpoint (str) – The endpoint to send the request to.

                  • +

                • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                -
                Return type
                -

                Optional[dict]

                +
                Return type:
                +

                Optional[dict]

                -
                Returns
                +
                Returns:

                The JSON response the API returns, or None if the response is 204 No Content.

                @@ -401,8 +401,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                -
                Return type
                -

                dict

                +
                Return type:
                +

                dict

                @@ -412,17 +412,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

                -
                Parameters
                +
                Parameters:

                • response (aiohttp.ClientResponse) – The response to check.

                  • -

                • should_raise (bool) – Whether or not to raise an exception.

                  • +

                • should_raise (bool) – Whether or not to raise an exception.

                -
                Raises
                +
                Raises:

                ResponseCodeError – If the response is not OK and should_raise is True.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -432,8 +432,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                -
                Return type
                -

                dict

                +
                Return type:
                +

                dict

                @@ -443,8 +443,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                -
                Return type
                -

                dict

                +
                Return type:
                +

                dict

                @@ -454,8 +454,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                -
                Return type
                -

                dict

                +
                Return type:
                +

                dict

                @@ -465,21 +465,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

                Send an HTTP request to the site API and return the JSON response.

                -
                Parameters
                +
                Parameters:
                  -

                • method (str) – The HTTP method to use.

                  • -

                • endpoint (str) – The endpoint to send the request to.

                  • -

                • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                  • +

                • method (str) – The HTTP method to use.

                  • +

                • endpoint (str) – The endpoint to send the request to.

                  • +

                • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                -
                Return type
                -

                dict

                +
                Return type:
                +

                dict

                -
                Returns
                +
                Returns:

                The JSON response the API returns.

                -
                Raises
                +
                Raises:

                ResponseCodeError – If the response is not OK and raise_for_status is True.

                @@ -490,18 +490,18 @@
                exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
                -

                Bases: ValueError

                +

                Bases: ValueError

                Raised in APIClient.request() when a non-OK HTTP response is received.

                __init__(response, response_json=None, response_text=None)[source]#

                Initialize a new ResponseCodeError instance.

                -
                Parameters
                +
                Parameters:

                • response (aiohttp.ClientResponse) – The response object from the request.

                  • -

                • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                  • -

                • response_text (Optional[str]) – The text of the request, if any.

                  • +

                • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                  • +

                • response_text (Optional[str]) – The text of the request, if any.

                diff --git a/v8.0.0-beta.1/output/botcore.utils.caching.html b/v8.0.0-beta.1/output/botcore.utils.caching.html index e2cd7df8..bd2ffc0d 100644 --- a/v8.0.0-beta.1/output/botcore.utils.caching.html +++ b/v8.0.0-beta.1/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                • - main + main
                • @@ -347,7 +347,7 @@
                  class AsyncCache(max_size=128)[source]#
                  -

                  Bases: object

                  +

                  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.

                  @@ -356,13 +356,13 @@ __call__(arg_offset=0)[source]#

                  Decorator for async cache.

                  -
                  Parameters
                  -

                  arg_offset (int) – The offset for the position of the key argument.

                  +
                  Parameters:
                  +

                  arg_offset (int) – The offset for the position of the key argument.

                  -
                  Return type
                  -

                  Callable

                  +
                  Return type:
                  +

                  Callable

                  -
                  Returns
                  +
                  Returns:

                  A decorator to wrap the target function.

                  @@ -373,8 +373,8 @@ __init__(max_size=128)[source]#

                  Initialise a new AsyncCache instance.

                  -
                  Parameters
                  -

                  max_size (int) – How many items to store in the cache.

                  +
                  Parameters:
                  +

                  max_size (int) – How many items to store in the cache.

                  @@ -384,8 +384,8 @@ clear()[source]#

                  Clear cache instance.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                diff --git a/v8.0.0-beta.1/output/botcore.utils.channel.html b/v8.0.0-beta.1/output/botcore.utils.channel.html index be779e05..408814b1 100644 --- a/v8.0.0-beta.1/output/botcore.utils.channel.html +++ b/v8.0.0-beta.1/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                • - main + main
                • @@ -349,13 +349,13 @@ 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
                  +
                  Parameters:

                  • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

                    • -

                  • channel_id (int) – The channel to get/fetch.

                    • +

                  • channel_id (int) – The channel to get/fetch.

                  -
                  Raises
                  +
                  Raises:
                  -
                  Return type
                  +
                  Return type:

                  GuildChannel

                  -
                  Returns
                  +
                  Returns:

                  The channel from the ID.

                  @@ -377,16 +377,16 @@ is_in_category(channel, category_id)[source]#

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

                  -
                  Parameters
                  +
                  Parameters:

                  • channel (TextChannel) – The channel to check.

                    • -

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

                    • +

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

                  -
                  Return type
                  -

                  bool

                  +
                  Return type:
                  +

                  bool

                  -
                  Returns
                  +
                  Returns:

                  A bool depending on whether the channel is in the category.

                  diff --git a/v8.0.0-beta.1/output/botcore.utils.commands.html b/v8.0.0-beta.1/output/botcore.utils.commands.html index 9cdff24e..94d8355e 100644 --- a/v8.0.0-beta.1/output/botcore.utils.commands.html +++ b/v8.0.0-beta.1/output/botcore.utils.commands.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                  • - main + main
                  • @@ -348,19 +348,19 @@ async clean_text_or_reply(ctx, text=None)[source]#

                    Cleans a text argument or replied message’s content.

                    -
                    Parameters
                    +
                    Parameters:

                    • ctx (Context) – The command’s context

                      • -

                    • text (Optional[str]) – The provided text argument of the command (if given)

                      • +

                    • text (Optional[str]) – The provided text argument of the command (if given)

                    -
                    Raises
                    +
                    Raises:

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

                    -
                    Return type
                    -

                    str

                    +
                    Return type:
                    +

                    str

                    -
                    Returns
                    +
                    Returns:

                    The cleaned version of text, if given, else replied message.

                    diff --git a/v8.0.0-beta.1/output/botcore.utils.html b/v8.0.0-beta.1/output/botcore.utils.html index 9b955b5a..aa3d8a18 100644 --- a/v8.0.0-beta.1/output/botcore.utils.html +++ b/v8.0.0-beta.1/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    • - main + main
                    • @@ -357,8 +357,8 @@ that will act as top-level groups rather than being aliases of the command’s g
                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -368,13 +368,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

                -
                Parameters
                -

                name (str) – The module name to unqualify.

                +
                Parameters:
                +

                name (str) – The module name to unqualify.

                -
                Return type
                -

                str

                +
                Return type:
                +

                str

                -
                Returns
                +
                Returns:

                The unqualified module name.

                diff --git a/v8.0.0-beta.1/output/botcore.utils.interactions.html b/v8.0.0-beta.1/output/botcore.utils.interactions.html index df92edc0..0e7e10c6 100644 --- a/v8.0.0-beta.1/output/botcore.utils.interactions.html +++ b/v8.0.0-beta.1/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                • - main + main
                • @@ -351,10 +351,10 @@

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

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

                  -
                  Parameters
                  +
                  Parameters:

                  • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

                    • -

                  • label (str) – The label of the button, set to “Delete” if not specified.

                    • +

                  • label (str) – The label of the button, set to “Delete” if not specified.

                  @@ -368,8 +368,8 @@ async callback(interaction)[source]#

                  Delete the original message on button click.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -382,13 +382,13 @@

                  Bases: View

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

                  -
                  Parameters
                  +
                  Parameters:
                    -

                  • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                    • -

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

                  • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                    • +

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

                  @@ -403,11 +403,11 @@ If Noneasync interaction_check(interaction)[source]#

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

                  -
                  Parameters
                  +
                  Parameters:

                  interaction (Interaction) – The interaction that occurred.

                  -
                  Return type
                  -

                  bool

                  +
                  Return type:
                  +

                  bool

                  @@ -417,8 +417,8 @@ If Noneasync on_timeout()[source]#

                  Remove the view from self.message if set.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  diff --git a/v8.0.0-beta.1/output/botcore.utils.logging.html b/v8.0.0-beta.1/output/botcore.utils.logging.html index 81298342..fffc6286 100644 --- a/v8.0.0-beta.1/output/botcore.utils.logging.html +++ b/v8.0.0-beta.1/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                  • - main + main
                  • @@ -347,8 +347,8 @@
                    class CustomLogger(name, level=0)[source]#
                    -

                    Bases: Logger

                    -

                    Custom implementation of the logging.Logger class with an added trace method.

                    +

                    Bases: Logger

                    +

                    Custom implementation of the logging.Logger class with an added trace method.

                    trace(msg, *args, **kwargs)[source]#
                    @@ -358,15 +358,15 @@
                    -
                    Parameters
                    +
                    Parameters:
                      -

                    • msg (str) – The message to be logged.

                      • +

                    • msg (str) – The message to be logged.

                    • args – Passed to the base log function as is.

                    • kwargs – Passed to the base log function as is.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -378,13 +378,13 @@ get_logger(name=None)[source]#

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

                    -
                    Parameters
                    -

                    name (Optional[str]) – The name given to the logger.

                    +
                    Parameters:
                    +

                    name (Optional[str]) – The name given to the logger.

                    -
                    Return type
                    +
                    Return type:

                    CustomLogger

                    -
                    Returns
                    +
                    Returns:

                    An instance of the CustomLogger class.

                    diff --git a/v8.0.0-beta.1/output/botcore.utils.members.html b/v8.0.0-beta.1/output/botcore.utils.members.html index 2ddce18f..deb46d1c 100644 --- a/v8.0.0-beta.1/output/botcore.utils.members.html +++ b/v8.0.0-beta.1/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    diff --git a/v8.0.0-beta.1/output/botcore.utils.regex.html b/v8.0.0-beta.1/output/botcore.utils.regex.html index 00b681ef..414d2aea 100644 --- a/v8.0.0-beta.1/output/botcore.utils.regex.html +++ b/v8.0.0-beta.1/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    • - main + main
                    • @@ -352,7 +352,7 @@

                      Warning

                      This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                      +such as urllib.parse.quote().

                      diff --git a/v8.0.0-beta.1/output/botcore.utils.scheduling.html b/v8.0.0-beta.1/output/botcore.utils.scheduling.html index 59828ab1..f7f51ecb 100644 --- a/v8.0.0-beta.1/output/botcore.utils.scheduling.html +++ b/v8.0.0-beta.1/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • @@ -347,7 +347,7 @@
                        class Scheduler(name)[source]#
                        -

                        Bases: object

                        +

                        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 instance’s log messages from other instances. Using the name of the class or module containing @@ -361,16 +361,16 @@ the same ID used to schedule it.

                        __contains__(task_id)[source]#
                        -

                        Return True if a task with the given task_id is currently scheduled.

                        +

                        Return True if a task with the given task_id is currently scheduled.

                        -
                        Parameters
                        -

                        task_id (Hashable) – The task to look for.

                        +
                        Parameters:
                        +

                        task_id (Hashable) – The task to look for.

                        -
                        Return type
                        -

                        bool

                        +
                        Return type:
                        +

                        bool

                        -
                        Returns
                        -

                        True if the task was found.

                        +
                        Returns:
                        +

                        True if the task was found.

                        @@ -380,8 +380,8 @@ the same ID used to schedule it.

                        __init__(name)[source]#

                        Initialize a new Scheduler instance.

                        -
                        Parameters
                        -

                        name (str) – The name of the Scheduler. Used in logging, and namespacing.

                        +
                        Parameters:
                        +

                        name (str) – The name of the Scheduler. Used in logging, and namespacing.

                        @@ -391,11 +391,11 @@ the same ID used to schedule it.

                        cancel(task_id)[source]#

                        Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                        -
                        Parameters
                        -

                        task_id (Hashable) – The task’s unique ID.

                        +
                        Parameters:
                        +

                        task_id (Hashable) – The task’s unique ID.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -405,8 +405,8 @@ the same ID used to schedule it.

                        cancel_all()[source]#

                        Unschedule all known tasks.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -418,14 +418,14 @@ the same ID used to schedule it.

                        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.

                        -
                        Parameters
                        +
                        Parameters:
                          -

                        • task_id (Hashable) – A unique ID to create the task with.

                          • -

                        • coroutine (Coroutine) – The function to be called.

                          • +

                        • task_id (Hashable) – A unique ID to create the task with.

                          • +

                        • coroutine (Coroutine) – The function to be called.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                @@ -440,15 +440,15 @@ If timeIf 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.

                -
                Parameters
                +
                Parameters:
                  -

                • time (datetime) – The time to start the task.

                  • -

                • task_id (Hashable) – A unique ID to create the task with.

                  • -

                • coroutine (Coroutine) – The function to be called.

                  • +

                • time (datetime) – The time to start the task.

                  • +

                • task_id (Hashable) – A unique ID to create the task with.

                  • +

                • coroutine (Coroutine) – The function to be called.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -460,15 +460,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

                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.

                -
                Parameters
                +
                Parameters:
                  -

                • delay (Union[int, float]) – How long to wait before starting the task.

                  • -

                • task_id (Hashable) – A unique ID to create the task with.

                  • -

                • coroutine (Coroutine) – The function to be called.

                  • +

                • delay (Union[int, float]) – How long to wait before starting the task.

                  • +

                • task_id (Hashable) – A unique ID to create the task with.

                  • +

                • coroutine (Coroutine) – The function to be called.

                -
                Return type
                -

                None

                +
                Return type:
                +

                None

                @@ -478,23 +478,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
                create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
                -

                Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

                +

                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.

                -
                Parameters
                +
                Parameters:
                -
                Returns
                +
                Returns:

                The wrapped task.

                -
                Return type
                -

                asyncio.Task

                +
                Return type:
                +

                asyncio.Task

                diff --git a/v8.0.0-beta.1/searchindex.js b/v8.0.0-beta.1/searchindex.js index 836172ed..7112b00c 100644 --- a/v8.0.0-beta.1/searchindex.js +++ b/v8.0.0-beta.1/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"next": 0, "7": 0, "x": 0, "featur": [0, 1, 3], "releas": 0, "break": 0, "108": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "1": [0, 12], "0": [0, 8, 11, 12], "rc1": 0, "support": [0, 4, 7, 15], "107": 0, "add": [0, 3], "sampl": 0, "project": [0, 1], "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "bugfix": 0, "bug": 0, "declar": 0, "aiodn": 0, "depend": [0, 9], "5": 0, "23rd": 0, "juli": 0, "2022": 0, "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Changelog": [[0, "changelog"]], "Exts": [[5, "module-botcore.exts"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "site_api": [[6, "module-botcore.site_api"]], "async_stats": [[4, "module-botcore.async_stats"]], "Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "logging": [[12, "module-botcore.utils.logging"]], "members": [[13, "module-botcore.utils.members"]], "regex": [[14, "module-botcore.utils.regex"]], "interactions": [[11, "module-botcore.utils.interactions"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "commands": [[10, "module-botcore.utils.commands"]], "caching": [[8, "module-botcore.utils.caching"]], "channel": [[9, "module-botcore.utils.channel"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"next": 0, "7": 0, "x": 0, "featur": [0, 1, 3], "releas": 0, "break": 0, "108": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "1": [0, 12], "0": [0, 8, 11, 12], "rc1": 0, "support": [0, 4, 7, 15], "107": 0, "add": [0, 3], "sampl": 0, "project": [0, 1], "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "bugfix": 0, "bug": 0, "declar": 0, "aiodn": 0, "depend": [0, 9], "5": 0, "23rd": 0, "juli": 0, "2022": 0, "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Exts": [[5, "module-botcore.exts"]], "Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "site_api": [[6, "module-botcore.site_api"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Changelog": [[0, "changelog"]], "async_stats": [[4, "module-botcore.async_stats"]], "channel": [[9, "module-botcore.utils.channel"]], "interactions": [[11, "module-botcore.utils.interactions"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "caching": [[8, "module-botcore.utils.caching"]], "commands": [[10, "module-botcore.utils.commands"]], "regex": [[14, "module-botcore.utils.regex"]], "logging": [[12, "module-botcore.utils.logging"]], "members": [[13, "module-botcore.utils.members"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v8.0.0-beta.2/.buildinfo b/v8.0.0-beta.2/.buildinfo index 8d2bcd29..d8eec2d0 100644 --- a/v8.0.0-beta.2/.buildinfo +++ b/v8.0.0-beta.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: 8ad3817724afb150b64fa21a24335af6 +config: 8f790a09d6b127e93aea76be6fa130a3 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v8.0.0-beta.2/_static/basic.css b/v8.0.0-beta.2/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v8.0.0-beta.2/_static/basic.css +++ b/v8.0.0-beta.2/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v8.0.0-beta.2/_static/debug.css b/v8.0.0-beta.2/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v8.0.0-beta.2/_static/debug.css +++ b/v8.0.0-beta.2/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v8.0.0-beta.2/_static/pygments.css b/v8.0.0-beta.2/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v8.0.0-beta.2/_static/pygments.css +++ b/v8.0.0-beta.2/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v8.0.0-beta.2/_static/skeleton.css b/v8.0.0-beta.2/_static/skeleton.css index 01231167..467c878c 100644 --- a/v8.0.0-beta.2/_static/skeleton.css +++ b/v8.0.0-beta.2/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v8.0.0-beta.2/changelog.html b/v8.0.0-beta.2/changelog.html index c7ec7dc8..93e10c5f 100644 --- a/v8.0.0-beta.2/changelog.html +++ b/v8.0.0-beta.2/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.2/development.html b/v8.0.0-beta.2/development.html index 99ec43a4..f4cdfd8d 100644 --- a/v8.0.0-beta.2/development.html +++ b/v8.0.0-beta.2/development.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.2/index.html b/v8.0.0-beta.2/index.html index 50c5fca1..19780c31 100644 --- a/v8.0.0-beta.2/index.html +++ b/v8.0.0-beta.2/index.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.2/output/botcore.async_stats.html b/v8.0.0-beta.2/output/botcore.async_stats.html index 90e7dd7b..b7ad397c 100644 --- a/v8.0.0-beta.2/output/botcore.async_stats.html +++ b/v8.0.0-beta.2/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                • - main + main
                • @@ -354,13 +354,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

                  Create a new AsyncStatsClient.

                  -
                  Parameters
                  +
                  Parameters:
                  @@ -369,10 +369,10 @@
                  async create_socket()[source]#
                  -

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

                  +

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

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  diff --git a/v8.0.0-beta.2/output/botcore.exts.html b/v8.0.0-beta.2/output/botcore.exts.html index 58fef954..dc0d3bd1 100644 --- a/v8.0.0-beta.2/output/botcore.exts.html +++ b/v8.0.0-beta.2/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                  • - main + main
                  • diff --git a/v8.0.0-beta.2/output/botcore.html b/v8.0.0-beta.2/output/botcore.html index 025e5a45..cd08a2f5 100644 --- a/v8.0.0-beta.2/output/botcore.html +++ b/v8.0.0-beta.2/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    • - main + main
                    • @@ -354,14 +354,14 @@ __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
                      +
                      Parameters:
                      @@ -373,8 +373,8 @@ a dummy statsd client will be created.

                      • async add_cog(cog)[source]#

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

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -384,8 +384,8 @@ a dummy statsd client will be created.

                      add_command(command)[source]#

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

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -395,8 +395,8 @@ a dummy statsd client will be created.

                      clear()[source]#

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

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -406,8 +406,8 @@ a dummy statsd client will be created.

                      async close()[source]#

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

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -418,8 +418,8 @@ a dummy statsd client will be created.

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

                      This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -429,8 +429,8 @@ a dummy statsd client will be created.

                      async log_to_dev_log(message)[source]#

                      Log the given message to #dev-log.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -442,8 +442,8 @@ a dummy statsd client will be created.

                      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.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                  @@ -453,8 +453,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

                  Clear the internal guild available event when self.guild_id becomes unavailable.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -464,8 +464,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

                  Ping all required services on setup to ensure they are up before starting.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -477,8 +477,8 @@ will not be set and guild_available_but_cache_empty event will be e

                  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
                  -

                  Optional[Command]

                  +
                  Return type:
                  +

                  Optional[Command]

                  @@ -491,8 +491,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -504,8 +504,8 @@ and -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

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

                  Bases: Exception

                  +

                  Bases: Exception

                  Exception class for startup errors.

                  diff --git a/v8.0.0-beta.2/output/botcore.site_api.html b/v8.0.0-beta.2/output/botcore.site_api.html index 1dc9ec2c..03ec0146 100644 --- a/v8.0.0-beta.2/output/botcore.site_api.html +++ b/v8.0.0-beta.2/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                  • - main + main
                  • @@ -347,17 +347,17 @@
                    class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
                    -

                    Bases: object

                    +

                    Bases: object

                    A wrapper for the Django Site API.

                    __init__(site_api_url, site_api_token, **session_kwargs)[source]#

                    Initialize a new APIClient instance.

                    -
                    Parameters
                    +
                    Parameters:
                      -

                    • site_api_url (str) – The URL of the site API.

                      • -

                    • site_api_token (str) – The token to use for authentication.

                      • +

                    • site_api_url (str) – The URL of the site API.

                      • +

                    • site_api_token (str) – The token to use for authentication.

                    • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

                    @@ -369,8 +369,8 @@ async close()[source]#

                  Close the aiohttp session.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -380,17 +380,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

                  Send a DELETE request to the site API and return the JSON response.

                  -
                  Parameters
                  +
                  Parameters:
                    -

                  • endpoint (str) – The endpoint to send the request to.

                    • -

                  • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                    • +

                  • endpoint (str) – The endpoint to send the request to.

                    • +

                  • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                  • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                  -
                  Return type
                  -

                  Optional[dict]

                  +
                  Return type:
                  +

                  Optional[dict]

                  -
                  Returns
                  +
                  Returns:

                  The JSON response the API returns, or None if the response is 204 No Content.

                  @@ -401,8 +401,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                  -
                  Return type
                  -

                  dict

                  +
                  Return type:
                  +

                  dict

                  @@ -412,17 +412,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

                  -
                  Parameters
                  +
                  Parameters:

                  • response (aiohttp.ClientResponse) – The response to check.

                    • -

                  • should_raise (bool) – Whether or not to raise an exception.

                    • +

                  • should_raise (bool) – Whether or not to raise an exception.

                  -
                  Raises
                  +
                  Raises:

                  ResponseCodeError – If the response is not OK and should_raise is True.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -432,8 +432,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                  -
                  Return type
                  -

                  dict

                  +
                  Return type:
                  +

                  dict

                  @@ -443,8 +443,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                  -
                  Return type
                  -

                  dict

                  +
                  Return type:
                  +

                  dict

                  @@ -454,8 +454,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                  -
                  Return type
                  -

                  dict

                  +
                  Return type:
                  +

                  dict

                  @@ -465,21 +465,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

                  Send an HTTP request to the site API and return the JSON response.

                  -
                  Parameters
                  +
                  Parameters:
                    -

                  • method (str) – The HTTP method to use.

                    • -

                  • endpoint (str) – The endpoint to send the request to.

                    • -

                  • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                    • +

                  • method (str) – The HTTP method to use.

                    • +

                  • endpoint (str) – The endpoint to send the request to.

                    • +

                  • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                  • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                  -
                  Return type
                  -

                  dict

                  +
                  Return type:
                  +

                  dict

                  -
                  Returns
                  +
                  Returns:

                  The JSON response the API returns.

                  -
                  Raises
                  +
                  Raises:

                  ResponseCodeError – If the response is not OK and raise_for_status is True.

                  @@ -490,18 +490,18 @@
                  exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
                  -

                  Bases: ValueError

                  +

                  Bases: ValueError

                  Raised in APIClient.request() when a non-OK HTTP response is received.

                  __init__(response, response_json=None, response_text=None)[source]#

                  Initialize a new ResponseCodeError instance.

                  -
                  Parameters
                  +
                  Parameters:

                  • response (aiohttp.ClientResponse) – The response object from the request.

                    • -

                  • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                    • -

                  • response_text (Optional[str]) – The text of the request, if any.

                    • +

                  • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                    • +

                  • response_text (Optional[str]) – The text of the request, if any.

                  diff --git a/v8.0.0-beta.2/output/botcore.utils.caching.html b/v8.0.0-beta.2/output/botcore.utils.caching.html index d270bfee..0f5a18d4 100644 --- a/v8.0.0-beta.2/output/botcore.utils.caching.html +++ b/v8.0.0-beta.2/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                  • - main + main
                  • @@ -347,7 +347,7 @@
                    class AsyncCache(max_size=128)[source]#
                    -

                    Bases: object

                    +

                    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.

                    @@ -356,13 +356,13 @@ __call__(arg_offset=0)[source]#

                    Decorator for async cache.

                    -
                    Parameters
                    -

                    arg_offset (int) – The offset for the position of the key argument.

                    +
                    Parameters:
                    +

                    arg_offset (int) – The offset for the position of the key argument.

                    -
                    Return type
                    -

                    Callable

                    +
                    Return type:
                    +

                    Callable

                    -
                    Returns
                    +
                    Returns:

                    A decorator to wrap the target function.

                    @@ -373,8 +373,8 @@ __init__(max_size=128)[source]#

                    Initialise a new AsyncCache instance.

                    -
                    Parameters
                    -

                    max_size (int) – How many items to store in the cache.

                    +
                    Parameters:
                    +

                    max_size (int) – How many items to store in the cache.

                    @@ -384,8 +384,8 @@ clear()[source]#

                    Clear cache instance.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                  diff --git a/v8.0.0-beta.2/output/botcore.utils.channel.html b/v8.0.0-beta.2/output/botcore.utils.channel.html index 7ef94b2d..bb34245a 100644 --- a/v8.0.0-beta.2/output/botcore.utils.channel.html +++ b/v8.0.0-beta.2/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                  • - main + main
                  • @@ -349,13 +349,13 @@ 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
                    +
                    Parameters:

                    • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

                      • -

                    • channel_id (int) – The channel to get/fetch.

                      • +

                    • channel_id (int) – The channel to get/fetch.

                    -
                    Raises
                    +
                    Raises:
                    -
                    Return type
                    +
                    Return type:

                    GuildChannel

                    -
                    Returns
                    +
                    Returns:

                    The channel from the ID.

                    @@ -377,16 +377,16 @@ is_in_category(channel, category_id)[source]#

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

                    -
                    Parameters
                    +
                    Parameters:

                    • channel (TextChannel) – The channel to check.

                      • -

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

                      • +

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

                    -
                    Return type
                    -

                    bool

                    +
                    Return type:
                    +

                    bool

                    -
                    Returns
                    +
                    Returns:

                    A bool depending on whether the channel is in the category.

                    diff --git a/v8.0.0-beta.2/output/botcore.utils.commands.html b/v8.0.0-beta.2/output/botcore.utils.commands.html index 2fa3cc1b..df4047e8 100644 --- a/v8.0.0-beta.2/output/botcore.utils.commands.html +++ b/v8.0.0-beta.2/output/botcore.utils.commands.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    • - main + main
                    • @@ -348,19 +348,19 @@ async clean_text_or_reply(ctx, text=None)[source]#

                      Cleans a text argument or replied message’s content.

                      -
                      Parameters
                      +
                      Parameters:

                      • ctx (Context) – The command’s context

                        • -

                      • text (Optional[str]) – The provided text argument of the command (if given)

                        • +

                      • text (Optional[str]) – The provided text argument of the command (if given)

                      -
                      Raises
                      +
                      Raises:

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

                      -
                      Return type
                      -

                      str

                      +
                      Return type:
                      +

                      str

                      -
                      Returns
                      +
                      Returns:

                      The cleaned version of text, if given, else replied message.

                      diff --git a/v8.0.0-beta.2/output/botcore.utils.html b/v8.0.0-beta.2/output/botcore.utils.html index 3912927b..83b6e3b1 100644 --- a/v8.0.0-beta.2/output/botcore.utils.html +++ b/v8.0.0-beta.2/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • @@ -357,8 +357,8 @@ that will act as top-level groups rather than being aliases of the command’s g
                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -368,13 +368,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

                  -
                  Parameters
                  -

                  name (str) – The module name to unqualify.

                  +
                  Parameters:
                  +

                  name (str) – The module name to unqualify.

                  -
                  Return type
                  -

                  str

                  +
                  Return type:
                  +

                  str

                  -
                  Returns
                  +
                  Returns:

                  The unqualified module name.

                  diff --git a/v8.0.0-beta.2/output/botcore.utils.interactions.html b/v8.0.0-beta.2/output/botcore.utils.interactions.html index 6d61fe58..c42b7205 100644 --- a/v8.0.0-beta.2/output/botcore.utils.interactions.html +++ b/v8.0.0-beta.2/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                  • - main + main
                  • @@ -351,10 +351,10 @@

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

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

                    -
                    Parameters
                    +
                    Parameters:

                    • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

                      • -

                    • label (str) – The label of the button, set to “Delete” if not specified.

                      • +

                    • label (str) – The label of the button, set to “Delete” if not specified.

                    @@ -368,8 +368,8 @@ async callback(interaction)[source]#

                    Delete the original message on button click.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -382,13 +382,13 @@

                    Bases: View

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

                    -
                    Parameters
                    +
                    Parameters:
                      -

                    • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                      • -

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

                    • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                      • +

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

                    @@ -403,11 +403,11 @@ If Noneasync interaction_check(interaction)[source]#

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

                    -
                    Parameters
                    +
                    Parameters:

                    interaction (Interaction) – The interaction that occurred.

                    -
                    Return type
                    -

                    bool

                    +
                    Return type:
                    +

                    bool

                    @@ -417,8 +417,8 @@ If Noneasync on_timeout()[source]#

                    Remove the view from self.message if set.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    diff --git a/v8.0.0-beta.2/output/botcore.utils.logging.html b/v8.0.0-beta.2/output/botcore.utils.logging.html index b6ccc2a4..fb85852c 100644 --- a/v8.0.0-beta.2/output/botcore.utils.logging.html +++ b/v8.0.0-beta.2/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    • - main + main
                    • @@ -347,8 +347,8 @@
                      class CustomLogger(name, level=0)[source]#
                      -

                      Bases: Logger

                      -

                      Custom implementation of the logging.Logger class with an added trace method.

                      +

                      Bases: Logger

                      +

                      Custom implementation of the logging.Logger class with an added trace method.

                      trace(msg, *args, **kwargs)[source]#
                      @@ -358,15 +358,15 @@
                      -
                      Parameters
                      +
                      Parameters:
                        -

                      • msg (str) – The message to be logged.

                        • +

                      • msg (str) – The message to be logged.

                      • args – Passed to the base log function as is.

                      • kwargs – Passed to the base log function as is.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -378,13 +378,13 @@ get_logger(name=None)[source]#

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

                      -
                      Parameters
                      -

                      name (Optional[str]) – The name given to the logger.

                      +
                      Parameters:
                      +

                      name (Optional[str]) – The name given to the logger.

                      -
                      Return type
                      +
                      Return type:

                      CustomLogger

                      -
                      Returns
                      +
                      Returns:

                      An instance of the CustomLogger class.

                      diff --git a/v8.0.0-beta.2/output/botcore.utils.members.html b/v8.0.0-beta.2/output/botcore.utils.members.html index 9abc322d..fbcfad09 100644 --- a/v8.0.0-beta.2/output/botcore.utils.members.html +++ b/v8.0.0-beta.2/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      diff --git a/v8.0.0-beta.2/output/botcore.utils.regex.html b/v8.0.0-beta.2/output/botcore.utils.regex.html index d879672e..503d96aa 100644 --- a/v8.0.0-beta.2/output/botcore.utils.regex.html +++ b/v8.0.0-beta.2/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • @@ -352,7 +352,7 @@

                        Warning

                        This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                        +such as urllib.parse.quote().

                        diff --git a/v8.0.0-beta.2/output/botcore.utils.scheduling.html b/v8.0.0-beta.2/output/botcore.utils.scheduling.html index da55c4dc..dd8ceaa8 100644 --- a/v8.0.0-beta.2/output/botcore.utils.scheduling.html +++ b/v8.0.0-beta.2/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • @@ -347,7 +347,7 @@
                          class Scheduler(name)[source]#
                          -

                          Bases: object

                          +

                          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 instance’s log messages from other instances. Using the name of the class or module containing @@ -361,16 +361,16 @@ the same ID used to schedule it.

                          __contains__(task_id)[source]#
                          -

                          Return True if a task with the given task_id is currently scheduled.

                          +

                          Return True if a task with the given task_id is currently scheduled.

                          -
                          Parameters
                          -

                          task_id (Hashable) – The task to look for.

                          +
                          Parameters:
                          +

                          task_id (Hashable) – The task to look for.

                          -
                          Return type
                          -

                          bool

                          +
                          Return type:
                          +

                          bool

                          -
                          Returns
                          -

                          True if the task was found.

                          +
                          Returns:
                          +

                          True if the task was found.

                          @@ -380,8 +380,8 @@ the same ID used to schedule it.

                          __init__(name)[source]#

                          Initialize a new Scheduler instance.

                          -
                          Parameters
                          -

                          name (str) – The name of the Scheduler. Used in logging, and namespacing.

                          +
                          Parameters:
                          +

                          name (str) – The name of the Scheduler. Used in logging, and namespacing.

                          @@ -391,11 +391,11 @@ the same ID used to schedule it.

                          cancel(task_id)[source]#

                          Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                          -
                          Parameters
                          -

                          task_id (Hashable) – The task’s unique ID.

                          +
                          Parameters:
                          +

                          task_id (Hashable) – The task’s unique ID.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -405,8 +405,8 @@ the same ID used to schedule it.

                          cancel_all()[source]#

                          Unschedule all known tasks.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -418,14 +418,14 @@ the same ID used to schedule it.

                          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.

                          -
                          Parameters
                          +
                          Parameters:
                            -

                          • task_id (Hashable) – A unique ID to create the task with.

                            • -

                          • coroutine (Coroutine) – The function to be called.

                            • +

                          • task_id (Hashable) – A unique ID to create the task with.

                            • +

                          • coroutine (Coroutine) – The function to be called.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                  @@ -440,15 +440,15 @@ If timeIf 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.

                  -
                  Parameters
                  +
                  Parameters:
                    -

                  • time (datetime) – The time to start the task.

                    • -

                  • task_id (Hashable) – A unique ID to create the task with.

                    • -

                  • coroutine (Coroutine) – The function to be called.

                    • +

                  • time (datetime) – The time to start the task.

                    • +

                  • task_id (Hashable) – A unique ID to create the task with.

                    • +

                  • coroutine (Coroutine) – The function to be called.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -460,15 +460,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

                  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.

                  -
                  Parameters
                  +
                  Parameters:
                    -

                  • delay (Union[int, float]) – How long to wait before starting the task.

                    • -

                  • task_id (Hashable) – A unique ID to create the task with.

                    • -

                  • coroutine (Coroutine) – The function to be called.

                    • +

                  • delay (Union[int, float]) – How long to wait before starting the task.

                    • +

                  • task_id (Hashable) – A unique ID to create the task with.

                    • +

                  • coroutine (Coroutine) – The function to be called.

                  -
                  Return type
                  -

                  None

                  +
                  Return type:
                  +

                  None

                  @@ -478,23 +478,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
                  create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
                  -

                  Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

                  +

                  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.

                  -
                  Parameters
                  +
                  Parameters:
                  -
                  Returns
                  +
                  Returns:

                  The wrapped task.

                  -
                  Return type
                  -

                  asyncio.Task

                  +
                  Return type:
                  +

                  asyncio.Task

                  diff --git a/v8.0.0-beta.2/searchindex.js b/v8.0.0-beta.2/searchindex.js index c1fe8fdd..e961bf74 100644 --- a/v8.0.0-beta.2/searchindex.js +++ b/v8.0.0-beta.2/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"next": 0, "7": 0, "x": 0, "featur": [0, 1, 3], "releas": 0, "support": [0, 4, 7, 15], "107": 0, "add": [0, 3], "sampl": 0, "project": [0, 1], "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "bump": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "bugfix": 0, "bug": 0, "declar": 0, "aiodn": 0, "depend": [0, 9], "5": 0, "0": [0, 8, 11, 12], "23rd": 0, "juli": 0, "2022": 0, "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "1": [0, 12], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "break": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "site_api": [[6, "module-botcore.site_api"]], "Exts": [[5, "module-botcore.exts"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Changelog": [[0, "changelog"]], "async_stats": [[4, "module-botcore.async_stats"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "commands": [[10, "module-botcore.utils.commands"]], "channel": [[9, "module-botcore.utils.channel"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "logging": [[12, "module-botcore.utils.logging"]], "regex": [[14, "module-botcore.utils.regex"]], "caching": [[8, "module-botcore.utils.caching"]], "members": [[13, "module-botcore.utils.members"]], "interactions": [[11, "module-botcore.utils.interactions"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"next": 0, "7": 0, "x": 0, "featur": [0, 1, 3], "releas": 0, "support": [0, 4, 7, 15], "107": 0, "add": [0, 3], "sampl": 0, "project": [0, 1], "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "bump": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "bugfix": 0, "bug": 0, "declar": 0, "aiodn": 0, "depend": [0, 9], "5": 0, "0": [0, 8, 11, 12], "23rd": 0, "juli": 0, "2022": 0, "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "1": [0, 12], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "break": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Submodules": [[3, "submodules"], [7, "submodules"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Exts": [[5, "module-botcore.exts"]], "async_stats": [[4, "module-botcore.async_stats"]], "site_api": [[6, "module-botcore.site_api"]], "Utils": [[7, "module-botcore.utils"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Changelog": [[0, "changelog"]], "commands": [[10, "module-botcore.utils.commands"]], "members": [[13, "module-botcore.utils.members"]], "channel": [[9, "module-botcore.utils.channel"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "regex": [[14, "module-botcore.utils.regex"]], "logging": [[12, "module-botcore.utils.logging"]], "interactions": [[11, "module-botcore.utils.interactions"]], "caching": [[8, "module-botcore.utils.caching"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v8.0.0-beta.3/.buildinfo b/v8.0.0-beta.3/.buildinfo index 0fa07bc9..ce638082 100644 --- a/v8.0.0-beta.3/.buildinfo +++ b/v8.0.0-beta.3/.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: 35c1db6f19929067d33979fc2077448f +config: bfdfff1d8cdbb63d4479bd7c23e5d6eb tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v8.0.0-beta.3/_static/basic.css b/v8.0.0-beta.3/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v8.0.0-beta.3/_static/basic.css +++ b/v8.0.0-beta.3/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v8.0.0-beta.3/_static/debug.css b/v8.0.0-beta.3/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v8.0.0-beta.3/_static/debug.css +++ b/v8.0.0-beta.3/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v8.0.0-beta.3/_static/pygments.css b/v8.0.0-beta.3/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v8.0.0-beta.3/_static/pygments.css +++ b/v8.0.0-beta.3/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v8.0.0-beta.3/_static/skeleton.css b/v8.0.0-beta.3/_static/skeleton.css index 01231167..467c878c 100644 --- a/v8.0.0-beta.3/_static/skeleton.css +++ b/v8.0.0-beta.3/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v8.0.0-beta.3/changelog.html b/v8.0.0-beta.3/changelog.html index b957268d..f5b4231d 100644 --- a/v8.0.0-beta.3/changelog.html +++ b/v8.0.0-beta.3/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.3/development.html b/v8.0.0-beta.3/development.html index 471d9989..96481fc7 100644 --- a/v8.0.0-beta.3/development.html +++ b/v8.0.0-beta.3/development.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.3/index.html b/v8.0.0-beta.3/index.html index 98266d1e..a17d7a21 100644 --- a/v8.0.0-beta.3/index.html +++ b/v8.0.0-beta.3/index.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.3/output/botcore.async_stats.html b/v8.0.0-beta.3/output/botcore.async_stats.html index 8195dfcb..3a6305e6 100644 --- a/v8.0.0-beta.3/output/botcore.async_stats.html +++ b/v8.0.0-beta.3/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                  • - main + main
                  • @@ -354,13 +354,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

                    Create a new AsyncStatsClient.

                    -
                    Parameters
                    +
                    Parameters:
                    @@ -369,10 +369,10 @@
                    async create_socket()[source]#
                    -

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

                    +

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

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    diff --git a/v8.0.0-beta.3/output/botcore.exts.html b/v8.0.0-beta.3/output/botcore.exts.html index df814d2f..fa810ed0 100644 --- a/v8.0.0-beta.3/output/botcore.exts.html +++ b/v8.0.0-beta.3/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    • - main + main
                    • diff --git a/v8.0.0-beta.3/output/botcore.html b/v8.0.0-beta.3/output/botcore.html index 923d9ef8..9545f9cf 100644 --- a/v8.0.0-beta.3/output/botcore.html +++ b/v8.0.0-beta.3/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • @@ -354,14 +354,14 @@ __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
                        +
                        Parameters:
                        @@ -373,8 +373,8 @@ a dummy statsd client will be created.

                        • async add_cog(cog)[source]#

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

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -384,8 +384,8 @@ a dummy statsd client will be created.

                        add_command(command)[source]#

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

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -395,8 +395,8 @@ a dummy statsd client will be created.

                        clear()[source]#

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

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -406,8 +406,8 @@ a dummy statsd client will be created.

                        async close()[source]#

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

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -418,8 +418,8 @@ a dummy statsd client will be created.

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

                        This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -429,8 +429,8 @@ a dummy statsd client will be created.

                        async log_to_dev_log(message)[source]#

                        Log the given message to #dev-log.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -442,8 +442,8 @@ a dummy statsd client will be created.

                        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.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                    @@ -453,8 +453,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

                    Clear the internal guild available event when self.guild_id becomes unavailable.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -464,8 +464,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

                    Ping all required services on setup to ensure they are up before starting.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -477,8 +477,8 @@ will not be set and guild_available_but_cache_empty event will be e

                    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
                    -

                    Optional[Command]

                    +
                    Return type:
                    +

                    Optional[Command]

                    @@ -491,8 +491,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -504,8 +504,8 @@ and -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

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

                    Bases: Exception

                    +

                    Bases: Exception

                    Exception class for startup errors.

                    diff --git a/v8.0.0-beta.3/output/botcore.site_api.html b/v8.0.0-beta.3/output/botcore.site_api.html index eccfab8d..623b544c 100644 --- a/v8.0.0-beta.3/output/botcore.site_api.html +++ b/v8.0.0-beta.3/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    • - main + main
                    • @@ -347,17 +347,17 @@
                      class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
                      -

                      Bases: object

                      +

                      Bases: object

                      A wrapper for the Django Site API.

                      __init__(site_api_url, site_api_token, **session_kwargs)[source]#

                      Initialize a new APIClient instance.

                      -
                      Parameters
                      +
                      Parameters:
                        -

                      • site_api_url (str) – The URL of the site API.

                        • -

                      • site_api_token (str) – The token to use for authentication.

                        • +

                      • site_api_url (str) – The URL of the site API.

                        • +

                      • site_api_token (str) – The token to use for authentication.

                      • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

                      @@ -369,8 +369,8 @@ async close()[source]#

                    Close the aiohttp session.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -380,17 +380,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

                    Send a DELETE request to the site API and return the JSON response.

                    -
                    Parameters
                    +
                    Parameters:
                      -

                    • endpoint (str) – The endpoint to send the request to.

                      • -

                    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                      • +

                    • endpoint (str) – The endpoint to send the request to.

                      • +

                    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                    • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                    -
                    Return type
                    -

                    Optional[dict]

                    +
                    Return type:
                    +

                    Optional[dict]

                    -
                    Returns
                    +
                    Returns:

                    The JSON response the API returns, or None if the response is 204 No Content.

                    @@ -401,8 +401,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                    -
                    Return type
                    -

                    dict

                    +
                    Return type:
                    +

                    dict

                    @@ -412,17 +412,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

                    -
                    Parameters
                    +
                    Parameters:

                    • response (aiohttp.ClientResponse) – The response to check.

                      • -

                    • should_raise (bool) – Whether or not to raise an exception.

                      • +

                    • should_raise (bool) – Whether or not to raise an exception.

                    -
                    Raises
                    +
                    Raises:

                    ResponseCodeError – If the response is not OK and should_raise is True.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -432,8 +432,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                    -
                    Return type
                    -

                    dict

                    +
                    Return type:
                    +

                    dict

                    @@ -443,8 +443,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                    -
                    Return type
                    -

                    dict

                    +
                    Return type:
                    +

                    dict

                    @@ -454,8 +454,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                    -
                    Return type
                    -

                    dict

                    +
                    Return type:
                    +

                    dict

                    @@ -465,21 +465,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

                    Send an HTTP request to the site API and return the JSON response.

                    -
                    Parameters
                    +
                    Parameters:
                      -

                    • method (str) – The HTTP method to use.

                      • -

                    • endpoint (str) – The endpoint to send the request to.

                      • -

                    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                      • +

                    • method (str) – The HTTP method to use.

                      • +

                    • endpoint (str) – The endpoint to send the request to.

                      • +

                    • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                    • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                    -
                    Return type
                    -

                    dict

                    +
                    Return type:
                    +

                    dict

                    -
                    Returns
                    +
                    Returns:

                    The JSON response the API returns.

                    -
                    Raises
                    +
                    Raises:

                    ResponseCodeError – If the response is not OK and raise_for_status is True.

                    @@ -490,18 +490,18 @@
                    exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
                    -

                    Bases: ValueError

                    +

                    Bases: ValueError

                    Raised in APIClient.request() when a non-OK HTTP response is received.

                    __init__(response, response_json=None, response_text=None)[source]#

                    Initialize a new ResponseCodeError instance.

                    -
                    Parameters
                    +
                    Parameters:

                    • response (aiohttp.ClientResponse) – The response object from the request.

                      • -

                    • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                      • -

                    • response_text (Optional[str]) – The text of the request, if any.

                      • +

                    • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                      • +

                    • response_text (Optional[str]) – The text of the request, if any.

                    diff --git a/v8.0.0-beta.3/output/botcore.utils.caching.html b/v8.0.0-beta.3/output/botcore.utils.caching.html index 623c02fd..daf6957e 100644 --- a/v8.0.0-beta.3/output/botcore.utils.caching.html +++ b/v8.0.0-beta.3/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    • - main + main
                    • @@ -347,7 +347,7 @@
                      class AsyncCache(max_size=128)[source]#
                      -

                      Bases: object

                      +

                      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.

                      @@ -356,13 +356,13 @@ __call__(arg_offset=0)[source]#

                      Decorator for async cache.

                      -
                      Parameters
                      -

                      arg_offset (int) – The offset for the position of the key argument.

                      +
                      Parameters:
                      +

                      arg_offset (int) – The offset for the position of the key argument.

                      -
                      Return type
                      -

                      Callable

                      +
                      Return type:
                      +

                      Callable

                      -
                      Returns
                      +
                      Returns:

                      A decorator to wrap the target function.

                      @@ -373,8 +373,8 @@ __init__(max_size=128)[source]#

                      Initialise a new AsyncCache instance.

                      -
                      Parameters
                      -

                      max_size (int) – How many items to store in the cache.

                      +
                      Parameters:
                      +

                      max_size (int) – How many items to store in the cache.

                      @@ -384,8 +384,8 @@ clear()[source]#

                      Clear cache instance.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                    diff --git a/v8.0.0-beta.3/output/botcore.utils.channel.html b/v8.0.0-beta.3/output/botcore.utils.channel.html index c11c3174..086ff558 100644 --- a/v8.0.0-beta.3/output/botcore.utils.channel.html +++ b/v8.0.0-beta.3/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    • - main + main
                    • @@ -349,13 +349,13 @@ 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
                      +
                      Parameters:

                      • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

                        • -

                      • channel_id (int) – The channel to get/fetch.

                        • +

                      • channel_id (int) – The channel to get/fetch.

                      -
                      Raises
                      +
                      Raises:
                      -
                      Return type
                      +
                      Return type:

                      GuildChannel

                      -
                      Returns
                      +
                      Returns:

                      The channel from the ID.

                      @@ -377,16 +377,16 @@ is_in_category(channel, category_id)[source]#

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

                      -
                      Parameters
                      +
                      Parameters:

                      • channel (TextChannel) – The channel to check.

                        • -

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

                        • +

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

                      -
                      Return type
                      -

                      bool

                      +
                      Return type:
                      +

                      bool

                      -
                      Returns
                      +
                      Returns:

                      A bool depending on whether the channel is in the category.

                      diff --git a/v8.0.0-beta.3/output/botcore.utils.commands.html b/v8.0.0-beta.3/output/botcore.utils.commands.html index 45bcec78..20232485 100644 --- a/v8.0.0-beta.3/output/botcore.utils.commands.html +++ b/v8.0.0-beta.3/output/botcore.utils.commands.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • @@ -348,19 +348,19 @@ async clean_text_or_reply(ctx, text=None)[source]#

                        Cleans a text argument or replied message’s content.

                        -
                        Parameters
                        +
                        Parameters:

                        • ctx (Context) – The command’s context

                          • -

                        • text (Optional[str]) – The provided text argument of the command (if given)

                          • +

                        • text (Optional[str]) – The provided text argument of the command (if given)

                        -
                        Raises
                        +
                        Raises:

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

                        -
                        Return type
                        -

                        str

                        +
                        Return type:
                        +

                        str

                        -
                        Returns
                        +
                        Returns:

                        The cleaned version of text, if given, else replied message.

                        diff --git a/v8.0.0-beta.3/output/botcore.utils.html b/v8.0.0-beta.3/output/botcore.utils.html index 8a4a0e3e..3cfdd12b 100644 --- a/v8.0.0-beta.3/output/botcore.utils.html +++ b/v8.0.0-beta.3/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • @@ -357,8 +357,8 @@ that will act as top-level groups rather than being aliases of the command’s g
                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -368,13 +368,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

                    -
                    Parameters
                    -

                    name (str) – The module name to unqualify.

                    +
                    Parameters:
                    +

                    name (str) – The module name to unqualify.

                    -
                    Return type
                    -

                    str

                    +
                    Return type:
                    +

                    str

                    -
                    Returns
                    +
                    Returns:

                    The unqualified module name.

                    diff --git a/v8.0.0-beta.3/output/botcore.utils.interactions.html b/v8.0.0-beta.3/output/botcore.utils.interactions.html index 5b92b4f1..98b6596f 100644 --- a/v8.0.0-beta.3/output/botcore.utils.interactions.html +++ b/v8.0.0-beta.3/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    • - main + main
                    • @@ -351,10 +351,10 @@

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

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

                      -
                      Parameters
                      +
                      Parameters:

                      • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

                        • -

                      • label (str) – The label of the button, set to “Delete” if not specified.

                        • +

                      • label (str) – The label of the button, set to “Delete” if not specified.

                      @@ -368,8 +368,8 @@ async callback(interaction)[source]#

                      Delete the original message on button click.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -382,13 +382,13 @@

                      Bases: View

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

                      -
                      Parameters
                      +
                      Parameters:
                        -

                      • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                        • -

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

                      • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                        • +

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

                      @@ -403,11 +403,11 @@ If Noneasync interaction_check(interaction)[source]#

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

                      -
                      Parameters
                      +
                      Parameters:

                      interaction (Interaction) – The interaction that occurred.

                      -
                      Return type
                      -

                      bool

                      +
                      Return type:
                      +

                      bool

                      @@ -417,8 +417,8 @@ If Noneasync on_timeout()[source]#

                      Remove the view from self.message if set.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      diff --git a/v8.0.0-beta.3/output/botcore.utils.logging.html b/v8.0.0-beta.3/output/botcore.utils.logging.html index df7b1511..8f31d5e7 100644 --- a/v8.0.0-beta.3/output/botcore.utils.logging.html +++ b/v8.0.0-beta.3/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • @@ -347,8 +347,8 @@
                        class CustomLogger(name, level=0)[source]#
                        -

                        Bases: Logger

                        -

                        Custom implementation of the logging.Logger class with an added trace method.

                        +

                        Bases: Logger

                        +

                        Custom implementation of the logging.Logger class with an added trace method.

                        trace(msg, *args, **kwargs)[source]#
                        @@ -358,15 +358,15 @@
                        -
                        Parameters
                        +
                        Parameters:
                          -

                        • msg (str) – The message to be logged.

                          • +

                        • msg (str) – The message to be logged.

                        • args – Passed to the base log function as is.

                        • kwargs – Passed to the base log function as is.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -378,13 +378,13 @@ get_logger(name=None)[source]#

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

                        -
                        Parameters
                        -

                        name (Optional[str]) – The name given to the logger.

                        +
                        Parameters:
                        +

                        name (Optional[str]) – The name given to the logger.

                        -
                        Return type
                        +
                        Return type:

                        CustomLogger

                        -
                        Returns
                        +
                        Returns:

                        An instance of the CustomLogger class.

                        diff --git a/v8.0.0-beta.3/output/botcore.utils.members.html b/v8.0.0-beta.3/output/botcore.utils.members.html index 802d35d6..ce39d474 100644 --- a/v8.0.0-beta.3/output/botcore.utils.members.html +++ b/v8.0.0-beta.3/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        diff --git a/v8.0.0-beta.3/output/botcore.utils.regex.html b/v8.0.0-beta.3/output/botcore.utils.regex.html index f4bc55a4..b35540f0 100644 --- a/v8.0.0-beta.3/output/botcore.utils.regex.html +++ b/v8.0.0-beta.3/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • @@ -352,7 +352,7 @@

                          Warning

                          This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                          +such as urllib.parse.quote().

                          diff --git a/v8.0.0-beta.3/output/botcore.utils.scheduling.html b/v8.0.0-beta.3/output/botcore.utils.scheduling.html index 281ef3ee..76b8b1d7 100644 --- a/v8.0.0-beta.3/output/botcore.utils.scheduling.html +++ b/v8.0.0-beta.3/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • @@ -347,7 +347,7 @@
                            class Scheduler(name)[source]#
                            -

                            Bases: object

                            +

                            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 instance’s log messages from other instances. Using the name of the class or module containing @@ -361,16 +361,16 @@ the same ID used to schedule it.

                            __contains__(task_id)[source]#
                            -

                            Return True if a task with the given task_id is currently scheduled.

                            +

                            Return True if a task with the given task_id is currently scheduled.

                            -
                            Parameters
                            -

                            task_id (Hashable) – The task to look for.

                            +
                            Parameters:
                            +

                            task_id (Hashable) – The task to look for.

                            -
                            Return type
                            -

                            bool

                            +
                            Return type:
                            +

                            bool

                            -
                            Returns
                            -

                            True if the task was found.

                            +
                            Returns:
                            +

                            True if the task was found.

                            @@ -380,8 +380,8 @@ the same ID used to schedule it.

                            __init__(name)[source]#

                            Initialize a new Scheduler instance.

                            -
                            Parameters
                            -

                            name (str) – The name of the Scheduler. Used in logging, and namespacing.

                            +
                            Parameters:
                            +

                            name (str) – The name of the Scheduler. Used in logging, and namespacing.

                            @@ -391,11 +391,11 @@ the same ID used to schedule it.

                            cancel(task_id)[source]#

                            Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                            -
                            Parameters
                            -

                            task_id (Hashable) – The task’s unique ID.

                            +
                            Parameters:
                            +

                            task_id (Hashable) – The task’s unique ID.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -405,8 +405,8 @@ the same ID used to schedule it.

                            cancel_all()[source]#

                            Unschedule all known tasks.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -418,14 +418,14 @@ the same ID used to schedule it.

                            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.

                            -
                            Parameters
                            +
                            Parameters:
                              -

                            • task_id (Hashable) – A unique ID to create the task with.

                              • -

                            • coroutine (Coroutine) – The function to be called.

                              • +

                            • task_id (Hashable) – A unique ID to create the task with.

                              • +

                            • coroutine (Coroutine) – The function to be called.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                    @@ -440,15 +440,15 @@ If timeIf 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.

                    -
                    Parameters
                    +
                    Parameters:
                      -

                    • time (datetime) – The time to start the task.

                      • -

                    • task_id (Hashable) – A unique ID to create the task with.

                      • -

                    • coroutine (Coroutine) – The function to be called.

                      • +

                    • time (datetime) – The time to start the task.

                      • +

                    • task_id (Hashable) – A unique ID to create the task with.

                      • +

                    • coroutine (Coroutine) – The function to be called.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -460,15 +460,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

                    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.

                    -
                    Parameters
                    +
                    Parameters:
                      -

                    • delay (Union[int, float]) – How long to wait before starting the task.

                      • -

                    • task_id (Hashable) – A unique ID to create the task with.

                      • -

                    • coroutine (Coroutine) – The function to be called.

                      • +

                    • delay (Union[int, float]) – How long to wait before starting the task.

                      • +

                    • task_id (Hashable) – A unique ID to create the task with.

                      • +

                    • coroutine (Coroutine) – The function to be called.

                    -
                    Return type
                    -

                    None

                    +
                    Return type:
                    +

                    None

                    @@ -478,23 +478,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
                    create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
                    -

                    Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

                    +

                    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.

                    -
                    Parameters
                    +
                    Parameters:
                    -
                    Returns
                    +
                    Returns:

                    The wrapped task.

                    -
                    Return type
                    -

                    asyncio.Task

                    +
                    Return type:
                    +

                    asyncio.Task

                    diff --git a/v8.0.0-beta.3/searchindex.js b/v8.0.0-beta.3/searchindex.js index af179818..c7ce0d10 100644 --- a/v8.0.0-beta.3/searchindex.js +++ b/v8.0.0-beta.3/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"next": 0, "7": 0, "x": 0, "featur": [0, 1, 3], "releas": 0, "break": 0, "110": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "0": [0, 8, 11, 12], "rc2": 0, "support": [0, 4, 7, 15], "107": 0, "add": [0, 3], "sampl": 0, "project": [0, 1], "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "bugfix": 0, "bug": 0, "declar": 0, "aiodn": 0, "depend": [0, 9], "5": 0, "23rd": 0, "juli": 0, "2022": 0, "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "1": [0, 12], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Exts": [[5, "module-botcore.exts"]], "Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Changelog": [[0, "changelog"]], "site_api": [[6, "module-botcore.site_api"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "async_stats": [[4, "module-botcore.async_stats"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "regex": [[14, "module-botcore.utils.regex"]], "channel": [[9, "module-botcore.utils.channel"]], "logging": [[12, "module-botcore.utils.logging"]], "caching": [[8, "module-botcore.utils.caching"]], "members": [[13, "module-botcore.utils.members"]], "commands": [[10, "module-botcore.utils.commands"]], "interactions": [[11, "module-botcore.utils.interactions"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"next": 0, "7": 0, "x": 0, "featur": [0, 1, 3], "releas": 0, "break": 0, "110": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "0": [0, 8, 11, 12], "rc2": 0, "support": [0, 4, 7, 15], "107": 0, "add": [0, 3], "sampl": 0, "project": [0, 1], "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "bugfix": 0, "bug": 0, "declar": 0, "aiodn": 0, "depend": [0, 9], "5": 0, "23rd": 0, "juli": 0, "2022": 0, "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "1": [0, 12], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "site_api": [[6, "module-botcore.site_api"]], "async_stats": [[4, "module-botcore.async_stats"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Changelog": [[0, "changelog"]], "Exts": [[5, "module-botcore.exts"]], "logging": [[12, "module-botcore.utils.logging"]], "commands": [[10, "module-botcore.utils.commands"]], "members": [[13, "module-botcore.utils.members"]], "interactions": [[11, "module-botcore.utils.interactions"]], "channel": [[9, "module-botcore.utils.channel"]], "regex": [[14, "module-botcore.utils.regex"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "caching": [[8, "module-botcore.utils.caching"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v8.0.0-beta.4/.buildinfo b/v8.0.0-beta.4/.buildinfo index dd33a0ca..4f1d4488 100644 --- a/v8.0.0-beta.4/.buildinfo +++ b/v8.0.0-beta.4/.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: bf2661e1c8e636c2e24b85ba51b238f1 +config: 6398cad12a1cd4f96dd082ee3abd8f93 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v8.0.0-beta.4/_static/basic.css b/v8.0.0-beta.4/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v8.0.0-beta.4/_static/basic.css +++ b/v8.0.0-beta.4/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v8.0.0-beta.4/_static/debug.css b/v8.0.0-beta.4/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v8.0.0-beta.4/_static/debug.css +++ b/v8.0.0-beta.4/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v8.0.0-beta.4/_static/pygments.css b/v8.0.0-beta.4/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v8.0.0-beta.4/_static/pygments.css +++ b/v8.0.0-beta.4/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v8.0.0-beta.4/_static/skeleton.css b/v8.0.0-beta.4/_static/skeleton.css index 01231167..467c878c 100644 --- a/v8.0.0-beta.4/_static/skeleton.css +++ b/v8.0.0-beta.4/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v8.0.0-beta.4/changelog.html b/v8.0.0-beta.4/changelog.html index ba82fb78..9b95503d 100644 --- a/v8.0.0-beta.4/changelog.html +++ b/v8.0.0-beta.4/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.4/development.html b/v8.0.0-beta.4/development.html index ccbb8cfa..c1c36ed0 100644 --- a/v8.0.0-beta.4/development.html +++ b/v8.0.0-beta.4/development.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.4/index.html b/v8.0.0-beta.4/index.html index 8c93c37e..211a6d48 100644 --- a/v8.0.0-beta.4/index.html +++ b/v8.0.0-beta.4/index.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0-beta.4/output/botcore.async_stats.html b/v8.0.0-beta.4/output/botcore.async_stats.html index 867b069c..ea3ca94d 100644 --- a/v8.0.0-beta.4/output/botcore.async_stats.html +++ b/v8.0.0-beta.4/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                    • - main + main
                    • @@ -354,13 +354,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

                      Create a new AsyncStatsClient.

                      -
                      Parameters
                      +
                      Parameters:
                      @@ -369,10 +369,10 @@
                      async create_socket()[source]#
                      -

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

                      +

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

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      diff --git a/v8.0.0-beta.4/output/botcore.exts.html b/v8.0.0-beta.4/output/botcore.exts.html index 2a3c87f7..46c4ae66 100644 --- a/v8.0.0-beta.4/output/botcore.exts.html +++ b/v8.0.0-beta.4/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • diff --git a/v8.0.0-beta.4/output/botcore.html b/v8.0.0-beta.4/output/botcore.html index 59e56390..e34838ff 100644 --- a/v8.0.0-beta.4/output/botcore.html +++ b/v8.0.0-beta.4/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • @@ -354,14 +354,14 @@ __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
                          +
                          Parameters:
                          @@ -373,8 +373,8 @@ a dummy statsd client will be created.

                          • async add_cog(cog)[source]#

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

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -384,8 +384,8 @@ a dummy statsd client will be created.

                          add_command(command)[source]#

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

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -395,8 +395,8 @@ a dummy statsd client will be created.

                          clear()[source]#

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

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -406,8 +406,8 @@ a dummy statsd client will be created.

                          async close()[source]#

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

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -418,8 +418,8 @@ a dummy statsd client will be created.

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

                          This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -429,8 +429,8 @@ a dummy statsd client will be created.

                          async log_to_dev_log(message)[source]#

                          Log the given message to #dev-log.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -442,8 +442,8 @@ a dummy statsd client will be created.

                          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.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                      @@ -453,8 +453,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

                      Clear the internal guild available event when self.guild_id becomes unavailable.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -464,8 +464,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

                      Ping all required services on setup to ensure they are up before starting.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -477,8 +477,8 @@ will not be set and guild_available_but_cache_empty event will be e

                      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
                      -

                      Optional[Command]

                      +
                      Return type:
                      +

                      Optional[Command]

                      @@ -491,8 +491,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -504,8 +504,8 @@ and -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

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

                      Bases: Exception

                      +

                      Bases: Exception

                      Exception class for startup errors.

                      diff --git a/v8.0.0-beta.4/output/botcore.site_api.html b/v8.0.0-beta.4/output/botcore.site_api.html index 887b4afb..45982ecc 100644 --- a/v8.0.0-beta.4/output/botcore.site_api.html +++ b/v8.0.0-beta.4/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • @@ -347,17 +347,17 @@
                        class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
                        -

                        Bases: object

                        +

                        Bases: object

                        A wrapper for the Django Site API.

                        __init__(site_api_url, site_api_token, **session_kwargs)[source]#

                        Initialize a new APIClient instance.

                        -
                        Parameters
                        +
                        Parameters:
                          -

                        • site_api_url (str) – The URL of the site API.

                          • -

                        • site_api_token (str) – The token to use for authentication.

                          • +

                        • site_api_url (str) – The URL of the site API.

                          • +

                        • site_api_token (str) – The token to use for authentication.

                        • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

                        @@ -369,8 +369,8 @@ async close()[source]#

                      Close the aiohttp session.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -380,17 +380,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

                      Send a DELETE request to the site API and return the JSON response.

                      -
                      Parameters
                      +
                      Parameters:
                        -

                      • endpoint (str) – The endpoint to send the request to.

                        • -

                      • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                        • +

                      • endpoint (str) – The endpoint to send the request to.

                        • +

                      • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                      • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                      -
                      Return type
                      -

                      Optional[dict]

                      +
                      Return type:
                      +

                      Optional[dict]

                      -
                      Returns
                      +
                      Returns:

                      The JSON response the API returns, or None if the response is 204 No Content.

                      @@ -401,8 +401,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                      -
                      Return type
                      -

                      dict

                      +
                      Return type:
                      +

                      dict

                      @@ -412,17 +412,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

                      -
                      Parameters
                      +
                      Parameters:

                      • response (aiohttp.ClientResponse) – The response to check.

                        • -

                      • should_raise (bool) – Whether or not to raise an exception.

                        • +

                      • should_raise (bool) – Whether or not to raise an exception.

                      -
                      Raises
                      +
                      Raises:

                      ResponseCodeError – If the response is not OK and should_raise is True.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -432,8 +432,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                      -
                      Return type
                      -

                      dict

                      +
                      Return type:
                      +

                      dict

                      @@ -443,8 +443,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                      -
                      Return type
                      -

                      dict

                      +
                      Return type:
                      +

                      dict

                      @@ -454,8 +454,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                      -
                      Return type
                      -

                      dict

                      +
                      Return type:
                      +

                      dict

                      @@ -465,21 +465,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

                      Send an HTTP request to the site API and return the JSON response.

                      -
                      Parameters
                      +
                      Parameters:
                        -

                      • method (str) – The HTTP method to use.

                        • -

                      • endpoint (str) – The endpoint to send the request to.

                        • -

                      • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                        • +

                      • method (str) – The HTTP method to use.

                        • +

                      • endpoint (str) – The endpoint to send the request to.

                        • +

                      • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                      • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                      -
                      Return type
                      -

                      dict

                      +
                      Return type:
                      +

                      dict

                      -
                      Returns
                      +
                      Returns:

                      The JSON response the API returns.

                      -
                      Raises
                      +
                      Raises:

                      ResponseCodeError – If the response is not OK and raise_for_status is True.

                      @@ -490,18 +490,18 @@
                      exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
                      -

                      Bases: ValueError

                      +

                      Bases: ValueError

                      Raised in APIClient.request() when a non-OK HTTP response is received.

                      __init__(response, response_json=None, response_text=None)[source]#

                      Initialize a new ResponseCodeError instance.

                      -
                      Parameters
                      +
                      Parameters:

                      • response (aiohttp.ClientResponse) – The response object from the request.

                        • -

                      • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                        • -

                      • response_text (Optional[str]) – The text of the request, if any.

                        • +

                      • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                        • +

                      • response_text (Optional[str]) – The text of the request, if any.

                      diff --git a/v8.0.0-beta.4/output/botcore.utils.caching.html b/v8.0.0-beta.4/output/botcore.utils.caching.html index 3a69a192..91b37069 100644 --- a/v8.0.0-beta.4/output/botcore.utils.caching.html +++ b/v8.0.0-beta.4/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • @@ -347,7 +347,7 @@
                        class AsyncCache(max_size=128)[source]#
                        -

                        Bases: object

                        +

                        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.

                        @@ -356,13 +356,13 @@ __call__(arg_offset=0)[source]#

                        Decorator for async cache.

                        -
                        Parameters
                        -

                        arg_offset (int) – The offset for the position of the key argument.

                        +
                        Parameters:
                        +

                        arg_offset (int) – The offset for the position of the key argument.

                        -
                        Return type
                        -

                        Callable

                        +
                        Return type:
                        +

                        Callable

                        -
                        Returns
                        +
                        Returns:

                        A decorator to wrap the target function.

                        @@ -373,8 +373,8 @@ __init__(max_size=128)[source]#

                        Initialise a new AsyncCache instance.

                        -
                        Parameters
                        -

                        max_size (int) – How many items to store in the cache.

                        +
                        Parameters:
                        +

                        max_size (int) – How many items to store in the cache.

                        @@ -384,8 +384,8 @@ clear()[source]#

                        Clear cache instance.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                      diff --git a/v8.0.0-beta.4/output/botcore.utils.channel.html b/v8.0.0-beta.4/output/botcore.utils.channel.html index 7724101d..3de1903f 100644 --- a/v8.0.0-beta.4/output/botcore.utils.channel.html +++ b/v8.0.0-beta.4/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • @@ -349,13 +349,13 @@ 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
                        +
                        Parameters:

                        • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

                          • -

                        • channel_id (int) – The channel to get/fetch.

                          • +

                        • channel_id (int) – The channel to get/fetch.

                        -
                        Raises
                        +
                        Raises:
                        -
                        Return type
                        +
                        Return type:

                        GuildChannel

                        -
                        Returns
                        +
                        Returns:

                        The channel from the ID.

                        @@ -377,16 +377,16 @@ is_in_category(channel, category_id)[source]#

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

                        -
                        Parameters
                        +
                        Parameters:

                        • channel (TextChannel) – The channel to check.

                          • -

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

                          • +

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

                        -
                        Return type
                        -

                        bool

                        +
                        Return type:
                        +

                        bool

                        -
                        Returns
                        +
                        Returns:

                        A bool depending on whether the channel is in the category.

                        diff --git a/v8.0.0-beta.4/output/botcore.utils.commands.html b/v8.0.0-beta.4/output/botcore.utils.commands.html index 049a9252..f04ab688 100644 --- a/v8.0.0-beta.4/output/botcore.utils.commands.html +++ b/v8.0.0-beta.4/output/botcore.utils.commands.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • @@ -348,19 +348,19 @@ async clean_text_or_reply(ctx, text=None)[source]#

                          Cleans a text argument or replied message’s content.

                          -
                          Parameters
                          +
                          Parameters:

                          • ctx (Context) – The command’s context

                            • -

                          • text (Optional[str]) – The provided text argument of the command (if given)

                            • +

                          • text (Optional[str]) – The provided text argument of the command (if given)

                          -
                          Raises
                          +
                          Raises:

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

                          -
                          Return type
                          -

                          str

                          +
                          Return type:
                          +

                          str

                          -
                          Returns
                          +
                          Returns:

                          The cleaned version of text, if given, else replied message.

                          diff --git a/v8.0.0-beta.4/output/botcore.utils.html b/v8.0.0-beta.4/output/botcore.utils.html index 9d428cc0..5aa8d1af 100644 --- a/v8.0.0-beta.4/output/botcore.utils.html +++ b/v8.0.0-beta.4/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • @@ -357,8 +357,8 @@ that will act as top-level groups rather than being aliases of the command’s g
                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -368,13 +368,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

                      -
                      Parameters
                      -

                      name (str) – The module name to unqualify.

                      +
                      Parameters:
                      +

                      name (str) – The module name to unqualify.

                      -
                      Return type
                      -

                      str

                      +
                      Return type:
                      +

                      str

                      -
                      Returns
                      +
                      Returns:

                      The unqualified module name.

                      diff --git a/v8.0.0-beta.4/output/botcore.utils.interactions.html b/v8.0.0-beta.4/output/botcore.utils.interactions.html index fb68b62c..eb012e2a 100644 --- a/v8.0.0-beta.4/output/botcore.utils.interactions.html +++ b/v8.0.0-beta.4/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • @@ -351,10 +351,10 @@

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

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

                        -
                        Parameters
                        +
                        Parameters:

                        • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

                          • -

                        • label (str) – The label of the button, set to “Delete” if not specified.

                          • +

                        • label (str) – The label of the button, set to “Delete” if not specified.

                        @@ -368,8 +368,8 @@ async callback(interaction)[source]#

                        Delete the original message on button click.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -382,13 +382,13 @@

                        Bases: View

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

                        -
                        Parameters
                        +
                        Parameters:
                          -

                        • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                          • -

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

                        • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                          • +

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

                        @@ -403,11 +403,11 @@ If Noneasync interaction_check(interaction)[source]#

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

                        -
                        Parameters
                        +
                        Parameters:

                        interaction (Interaction) – The interaction that occurred.

                        -
                        Return type
                        -

                        bool

                        +
                        Return type:
                        +

                        bool

                        @@ -417,8 +417,8 @@ If Noneasync on_timeout()[source]#

                        Remove the view from self.message if set.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        diff --git a/v8.0.0-beta.4/output/botcore.utils.logging.html b/v8.0.0-beta.4/output/botcore.utils.logging.html index 70a39aa7..7c80eded 100644 --- a/v8.0.0-beta.4/output/botcore.utils.logging.html +++ b/v8.0.0-beta.4/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • @@ -347,8 +347,8 @@
                          class CustomLogger(name, level=0)[source]#
                          -

                          Bases: Logger

                          -

                          Custom implementation of the logging.Logger class with an added trace method.

                          +

                          Bases: Logger

                          +

                          Custom implementation of the logging.Logger class with an added trace method.

                          trace(msg, *args, **kwargs)[source]#
                          @@ -358,15 +358,15 @@
                          -
                          Parameters
                          +
                          Parameters:
                            -

                          • msg (str) – The message to be logged.

                            • +

                          • msg (str) – The message to be logged.

                          • args – Passed to the base log function as is.

                          • kwargs – Passed to the base log function as is.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -378,13 +378,13 @@ get_logger(name=None)[source]#

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

                          -
                          Parameters
                          -

                          name (Optional[str]) – The name given to the logger.

                          +
                          Parameters:
                          +

                          name (Optional[str]) – The name given to the logger.

                          -
                          Return type
                          +
                          Return type:

                          CustomLogger

                          -
                          Returns
                          +
                          Returns:

                          An instance of the CustomLogger class.

                          diff --git a/v8.0.0-beta.4/output/botcore.utils.members.html b/v8.0.0-beta.4/output/botcore.utils.members.html index 45c98e57..6648e4bd 100644 --- a/v8.0.0-beta.4/output/botcore.utils.members.html +++ b/v8.0.0-beta.4/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          diff --git a/v8.0.0-beta.4/output/botcore.utils.regex.html b/v8.0.0-beta.4/output/botcore.utils.regex.html index 8ab5ef2f..158c384f 100644 --- a/v8.0.0-beta.4/output/botcore.utils.regex.html +++ b/v8.0.0-beta.4/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • @@ -352,7 +352,7 @@

                            Warning

                            This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                            +such as urllib.parse.quote().

                            diff --git a/v8.0.0-beta.4/output/botcore.utils.scheduling.html b/v8.0.0-beta.4/output/botcore.utils.scheduling.html index 5fb79a11..af53d004 100644 --- a/v8.0.0-beta.4/output/botcore.utils.scheduling.html +++ b/v8.0.0-beta.4/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • @@ -347,7 +347,7 @@
                              class Scheduler(name)[source]#
                              -

                              Bases: object

                              +

                              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 instance’s log messages from other instances. Using the name of the class or module containing @@ -361,16 +361,16 @@ the same ID used to schedule it.

                              __contains__(task_id)[source]#
                              -

                              Return True if a task with the given task_id is currently scheduled.

                              +

                              Return True if a task with the given task_id is currently scheduled.

                              -
                              Parameters
                              -

                              task_id (Hashable) – The task to look for.

                              +
                              Parameters:
                              +

                              task_id (Hashable) – The task to look for.

                              -
                              Return type
                              -

                              bool

                              +
                              Return type:
                              +

                              bool

                              -
                              Returns
                              -

                              True if the task was found.

                              +
                              Returns:
                              +

                              True if the task was found.

                              @@ -380,8 +380,8 @@ the same ID used to schedule it.

                              __init__(name)[source]#

                              Initialize a new Scheduler instance.

                              -
                              Parameters
                              -

                              name (str) – The name of the Scheduler. Used in logging, and namespacing.

                              +
                              Parameters:
                              +

                              name (str) – The name of the Scheduler. Used in logging, and namespacing.

                              @@ -391,11 +391,11 @@ the same ID used to schedule it.

                              cancel(task_id)[source]#

                              Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                              -
                              Parameters
                              -

                              task_id (Hashable) – The task’s unique ID.

                              +
                              Parameters:
                              +

                              task_id (Hashable) – The task’s unique ID.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -405,8 +405,8 @@ the same ID used to schedule it.

                              cancel_all()[source]#

                              Unschedule all known tasks.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -418,14 +418,14 @@ the same ID used to schedule it.

                              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.

                              -
                              Parameters
                              +
                              Parameters:
                                -

                              • task_id (Hashable) – A unique ID to create the task with.

                                • -

                              • coroutine (Coroutine) – The function to be called.

                                • +

                              • task_id (Hashable) – A unique ID to create the task with.

                                • +

                              • coroutine (Coroutine) – The function to be called.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                      @@ -440,15 +440,15 @@ If timeIf 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.

                      -
                      Parameters
                      +
                      Parameters:
                        -

                      • time (datetime) – The time to start the task.

                        • -

                      • task_id (Hashable) – A unique ID to create the task with.

                        • -

                      • coroutine (Coroutine) – The function to be called.

                        • +

                      • time (datetime) – The time to start the task.

                        • +

                      • task_id (Hashable) – A unique ID to create the task with.

                        • +

                      • coroutine (Coroutine) – The function to be called.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -460,15 +460,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

                      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.

                      -
                      Parameters
                      +
                      Parameters:
                        -

                      • delay (Union[int, float]) – How long to wait before starting the task.

                        • -

                      • task_id (Hashable) – A unique ID to create the task with.

                        • -

                      • coroutine (Coroutine) – The function to be called.

                        • +

                      • delay (Union[int, float]) – How long to wait before starting the task.

                        • +

                      • task_id (Hashable) – A unique ID to create the task with.

                        • +

                      • coroutine (Coroutine) – The function to be called.

                      -
                      Return type
                      -

                      None

                      +
                      Return type:
                      +

                      None

                      @@ -478,23 +478,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
                      create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
                      -

                      Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

                      +

                      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.

                      -
                      Parameters
                      +
                      Parameters:
                      -
                      Returns
                      +
                      Returns:

                      The wrapped task.

                      -
                      Return type
                      -

                      asyncio.Task

                      +
                      Return type:
                      +

                      asyncio.Task

                      diff --git a/v8.0.0-beta.4/searchindex.js b/v8.0.0-beta.4/searchindex.js index d81f5a99..db6d736e 100644 --- a/v8.0.0-beta.4/searchindex.js +++ b/v8.0.0-beta.4/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"next": 0, "7": 0, "x": 0, "featur": [0, 1, 3], "releas": 0, "break": 0, "110": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "0": [0, 8, 11, 12], "rc2": 0, "support": [0, 4, 7, 15], "107": 0, "add": [0, 3], "sampl": 0, "project": [0, 1], "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "bugfix": 0, "bug": 0, "declar": 0, "aiodn": 0, "depend": [0, 9], "5": 0, "23rd": 0, "juli": 0, "2022": 0, "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "1": [0, 12], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Changelog": [[0, "changelog"]], "site_api": [[6, "module-botcore.site_api"]], "Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Exts": [[5, "module-botcore.exts"]], "async_stats": [[4, "module-botcore.async_stats"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "caching": [[8, "module-botcore.utils.caching"]], "commands": [[10, "module-botcore.utils.commands"]], "members": [[13, "module-botcore.utils.members"]], "logging": [[12, "module-botcore.utils.logging"]], "regex": [[14, "module-botcore.utils.regex"]], "interactions": [[11, "module-botcore.utils.interactions"]], "channel": [[9, "module-botcore.utils.channel"]], "scheduling": [[15, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"next": 0, "7": 0, "x": 0, "featur": [0, 1, 3], "releas": 0, "break": 0, "110": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "0": [0, 8, 11, 12], "rc2": 0, "support": [0, 4, 7, 15], "107": 0, "add": [0, 3], "sampl": 0, "project": [0, 1], "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "bugfix": 0, "bug": 0, "declar": 0, "aiodn": 0, "depend": [0, 9], "5": 0, "23rd": 0, "juli": 0, "2022": 0, "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "1": [0, 12], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Exts": [[5, "module-botcore.exts"]], "site_api": [[6, "module-botcore.site_api"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Changelog": [[0, "changelog"]], "async_stats": [[4, "module-botcore.async_stats"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "caching": [[8, "module-botcore.utils.caching"]], "channel": [[9, "module-botcore.utils.channel"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "logging": [[12, "module-botcore.utils.logging"]], "commands": [[10, "module-botcore.utils.commands"]], "members": [[13, "module-botcore.utils.members"]], "regex": [[14, "module-botcore.utils.regex"]], "interactions": [[11, "module-botcore.utils.interactions"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v8.0.0/.buildinfo b/v8.0.0/.buildinfo index e436f54a..86ebda9a 100644 --- a/v8.0.0/.buildinfo +++ b/v8.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: 017ff62d3d554f9c070c7a0be65f35bb +config: 76056bd37b80c0c6844e8f39df3a6418 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v8.0.0/_static/basic.css b/v8.0.0/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v8.0.0/_static/basic.css +++ b/v8.0.0/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v8.0.0/_static/debug.css b/v8.0.0/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v8.0.0/_static/debug.css +++ b/v8.0.0/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v8.0.0/_static/pygments.css b/v8.0.0/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v8.0.0/_static/pygments.css +++ b/v8.0.0/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v8.0.0/_static/skeleton.css b/v8.0.0/_static/skeleton.css index 01231167..467c878c 100644 --- a/v8.0.0/_static/skeleton.css +++ b/v8.0.0/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v8.0.0/changelog.html b/v8.0.0/changelog.html index dda217e1..c775963e 100644 --- a/v8.0.0/changelog.html +++ b/v8.0.0/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0/development.html b/v8.0.0/development.html index 199fa84a..7172b2aa 100644 --- a/v8.0.0/development.html +++ b/v8.0.0/development.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0/index.html b/v8.0.0/index.html index 534aee52..8179acbb 100644 --- a/v8.0.0/index.html +++ b/v8.0.0/index.html @@ -2,7 +2,7 @@ - + diff --git a/v8.0.0/output/botcore.async_stats.html b/v8.0.0/output/botcore.async_stats.html index 5264e9a0..3d18b207 100644 --- a/v8.0.0/output/botcore.async_stats.html +++ b/v8.0.0/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                      • - main + main
                      • @@ -354,13 +354,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

                        Create a new AsyncStatsClient.

                        -
                        Parameters
                        +
                        Parameters:
                        @@ -369,10 +369,10 @@
                        async create_socket()[source]#
                        -

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

                        +

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

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        diff --git a/v8.0.0/output/botcore.exts.html b/v8.0.0/output/botcore.exts.html index 4156cf66..f39da69f 100644 --- a/v8.0.0/output/botcore.exts.html +++ b/v8.0.0/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • diff --git a/v8.0.0/output/botcore.html b/v8.0.0/output/botcore.html index cc6b7c81..efaa2257 100644 --- a/v8.0.0/output/botcore.html +++ b/v8.0.0/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • @@ -354,14 +354,14 @@ __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
                            +
                            Parameters:
                            @@ -373,8 +373,8 @@ a dummy statsd client will be created.

                            • async add_cog(cog)[source]#

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

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -384,8 +384,8 @@ a dummy statsd client will be created.

                            add_command(command)[source]#

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

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -395,8 +395,8 @@ a dummy statsd client will be created.

                            clear()[source]#

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

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -406,8 +406,8 @@ a dummy statsd client will be created.

                            async close()[source]#

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

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -418,8 +418,8 @@ a dummy statsd client will be created.

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

                            This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -429,8 +429,8 @@ a dummy statsd client will be created.

                            async log_to_dev_log(message)[source]#

                            Log the given message to #dev-log.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -442,8 +442,8 @@ a dummy statsd client will be created.

                            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.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                        @@ -453,8 +453,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

                        Clear the internal guild available event when self.guild_id becomes unavailable.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -464,8 +464,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

                        Ping all required services on setup to ensure they are up before starting.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -477,8 +477,8 @@ will not be set and guild_available_but_cache_empty event will be e

                        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
                        -

                        Optional[Command]

                        +
                        Return type:
                        +

                        Optional[Command]

                        @@ -491,8 +491,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -504,8 +504,8 @@ and -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

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

                        Bases: Exception

                        +

                        Bases: Exception

                        Exception class for startup errors.

                        diff --git a/v8.0.0/output/botcore.site_api.html b/v8.0.0/output/botcore.site_api.html index 3e1ed7bc..2cfe61ff 100644 --- a/v8.0.0/output/botcore.site_api.html +++ b/v8.0.0/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • @@ -347,17 +347,17 @@
                          class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
                          -

                          Bases: object

                          +

                          Bases: object

                          A wrapper for the Django Site API.

                          __init__(site_api_url, site_api_token, **session_kwargs)[source]#

                          Initialize a new APIClient instance.

                          -
                          Parameters
                          +
                          Parameters:
                            -

                          • site_api_url (str) – The URL of the site API.

                            • -

                          • site_api_token (str) – The token to use for authentication.

                            • +

                          • site_api_url (str) – The URL of the site API.

                            • +

                          • site_api_token (str) – The token to use for authentication.

                          • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

                          @@ -369,8 +369,8 @@ async close()[source]#

                        Close the aiohttp session.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -380,17 +380,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

                        Send a DELETE request to the site API and return the JSON response.

                        -
                        Parameters
                        +
                        Parameters:
                          -

                        • endpoint (str) – The endpoint to send the request to.

                          • -

                        • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                          • +

                        • endpoint (str) – The endpoint to send the request to.

                          • +

                        • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                        • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                        -
                        Return type
                        -

                        Optional[dict]

                        +
                        Return type:
                        +

                        Optional[dict]

                        -
                        Returns
                        +
                        Returns:

                        The JSON response the API returns, or None if the response is 204 No Content.

                        @@ -401,8 +401,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                        -
                        Return type
                        -

                        dict

                        +
                        Return type:
                        +

                        dict

                        @@ -412,17 +412,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

                        -
                        Parameters
                        +
                        Parameters:

                        • response (aiohttp.ClientResponse) – The response to check.

                          • -

                        • should_raise (bool) – Whether or not to raise an exception.

                          • +

                        • should_raise (bool) – Whether or not to raise an exception.

                        -
                        Raises
                        +
                        Raises:

                        ResponseCodeError – If the response is not OK and should_raise is True.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -432,8 +432,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                        -
                        Return type
                        -

                        dict

                        +
                        Return type:
                        +

                        dict

                        @@ -443,8 +443,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                        -
                        Return type
                        -

                        dict

                        +
                        Return type:
                        +

                        dict

                        @@ -454,8 +454,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                        -
                        Return type
                        -

                        dict

                        +
                        Return type:
                        +

                        dict

                        @@ -465,21 +465,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

                        Send an HTTP request to the site API and return the JSON response.

                        -
                        Parameters
                        +
                        Parameters:
                          -

                        • method (str) – The HTTP method to use.

                          • -

                        • endpoint (str) – The endpoint to send the request to.

                          • -

                        • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                          • +

                        • method (str) – The HTTP method to use.

                          • +

                        • endpoint (str) – The endpoint to send the request to.

                          • +

                        • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                        • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                        -
                        Return type
                        -

                        dict

                        +
                        Return type:
                        +

                        dict

                        -
                        Returns
                        +
                        Returns:

                        The JSON response the API returns.

                        -
                        Raises
                        +
                        Raises:

                        ResponseCodeError – If the response is not OK and raise_for_status is True.

                        @@ -490,18 +490,18 @@
                        exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
                        -

                        Bases: ValueError

                        +

                        Bases: ValueError

                        Raised in APIClient.request() when a non-OK HTTP response is received.

                        __init__(response, response_json=None, response_text=None)[source]#

                        Initialize a new ResponseCodeError instance.

                        -
                        Parameters
                        +
                        Parameters:

                        • response (aiohttp.ClientResponse) – The response object from the request.

                          • -

                        • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                          • -

                        • response_text (Optional[str]) – The text of the request, if any.

                          • +

                        • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                          • +

                        • response_text (Optional[str]) – The text of the request, if any.

                        diff --git a/v8.0.0/output/botcore.utils.caching.html b/v8.0.0/output/botcore.utils.caching.html index ed9fc0be..829f3bcb 100644 --- a/v8.0.0/output/botcore.utils.caching.html +++ b/v8.0.0/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • @@ -347,7 +347,7 @@
                          class AsyncCache(max_size=128)[source]#
                          -

                          Bases: object

                          +

                          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.

                          @@ -356,13 +356,13 @@ __call__(arg_offset=0)[source]#

                          Decorator for async cache.

                          -
                          Parameters
                          -

                          arg_offset (int) – The offset for the position of the key argument.

                          +
                          Parameters:
                          +

                          arg_offset (int) – The offset for the position of the key argument.

                          -
                          Return type
                          -

                          Callable

                          +
                          Return type:
                          +

                          Callable

                          -
                          Returns
                          +
                          Returns:

                          A decorator to wrap the target function.

                          @@ -373,8 +373,8 @@ __init__(max_size=128)[source]#

                          Initialise a new AsyncCache instance.

                          -
                          Parameters
                          -

                          max_size (int) – How many items to store in the cache.

                          +
                          Parameters:
                          +

                          max_size (int) – How many items to store in the cache.

                          @@ -384,8 +384,8 @@ clear()[source]#

                          Clear cache instance.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                        diff --git a/v8.0.0/output/botcore.utils.channel.html b/v8.0.0/output/botcore.utils.channel.html index 35533e3e..dd3796fa 100644 --- a/v8.0.0/output/botcore.utils.channel.html +++ b/v8.0.0/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • @@ -349,13 +349,13 @@ 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
                          +
                          Parameters:

                          • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

                            • -

                          • channel_id (int) – The channel to get/fetch.

                            • +

                          • channel_id (int) – The channel to get/fetch.

                          -
                          Raises
                          +
                          Raises:
                          -
                          Return type
                          +
                          Return type:

                          GuildChannel

                          -
                          Returns
                          +
                          Returns:

                          The channel from the ID.

                          @@ -377,16 +377,16 @@ is_in_category(channel, category_id)[source]#

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

                          -
                          Parameters
                          +
                          Parameters:

                          • channel (TextChannel) – The channel to check.

                            • -

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

                            • +

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

                          -
                          Return type
                          -

                          bool

                          +
                          Return type:
                          +

                          bool

                          -
                          Returns
                          +
                          Returns:

                          A bool depending on whether the channel is in the category.

                          diff --git a/v8.0.0/output/botcore.utils.commands.html b/v8.0.0/output/botcore.utils.commands.html index 28d3e6e9..6b13b3e9 100644 --- a/v8.0.0/output/botcore.utils.commands.html +++ b/v8.0.0/output/botcore.utils.commands.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • @@ -348,19 +348,19 @@ async clean_text_or_reply(ctx, text=None)[source]#

                            Cleans a text argument or replied message’s content.

                            -
                            Parameters
                            +
                            Parameters:

                            • ctx (Context) – The command’s context

                              • -

                            • text (Optional[str]) – The provided text argument of the command (if given)

                              • +

                            • text (Optional[str]) – The provided text argument of the command (if given)

                            -
                            Raises
                            +
                            Raises:

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

                            -
                            Return type
                            -

                            str

                            +
                            Return type:
                            +

                            str

                            -
                            Returns
                            +
                            Returns:

                            The cleaned version of text, if given, else replied message.

                            diff --git a/v8.0.0/output/botcore.utils.html b/v8.0.0/output/botcore.utils.html index 99c9d28b..4eda03ac 100644 --- a/v8.0.0/output/botcore.utils.html +++ b/v8.0.0/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • @@ -357,8 +357,8 @@ that will act as top-level groups rather than being aliases of the command’s g
                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -368,13 +368,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

                        -
                        Parameters
                        -

                        name (str) – The module name to unqualify.

                        +
                        Parameters:
                        +

                        name (str) – The module name to unqualify.

                        -
                        Return type
                        -

                        str

                        +
                        Return type:
                        +

                        str

                        -
                        Returns
                        +
                        Returns:

                        The unqualified module name.

                        diff --git a/v8.0.0/output/botcore.utils.interactions.html b/v8.0.0/output/botcore.utils.interactions.html index 52c6d6cb..0236271f 100644 --- a/v8.0.0/output/botcore.utils.interactions.html +++ b/v8.0.0/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • @@ -351,10 +351,10 @@

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

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

                          -
                          Parameters
                          +
                          Parameters:

                          • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

                            • -

                          • label (str) – The label of the button, set to “Delete” if not specified.

                            • +

                          • label (str) – The label of the button, set to “Delete” if not specified.

                          @@ -368,8 +368,8 @@ async callback(interaction)[source]#

                          Delete the original message on button click.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -382,13 +382,13 @@

                          Bases: View

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

                          -
                          Parameters
                          +
                          Parameters:
                            -

                          • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                            • -

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

                          • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                            • +

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

                          @@ -403,11 +403,11 @@ If Noneasync interaction_check(interaction)[source]#

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

                          -
                          Parameters
                          +
                          Parameters:

                          interaction (Interaction) – The interaction that occurred.

                          -
                          Return type
                          -

                          bool

                          +
                          Return type:
                          +

                          bool

                          @@ -417,8 +417,8 @@ If Noneasync on_timeout()[source]#

                          Remove the view from self.message if set.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          diff --git a/v8.0.0/output/botcore.utils.logging.html b/v8.0.0/output/botcore.utils.logging.html index 5bf302de..3c13a97a 100644 --- a/v8.0.0/output/botcore.utils.logging.html +++ b/v8.0.0/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • @@ -347,8 +347,8 @@
                            class CustomLogger(name, level=0)[source]#
                            -

                            Bases: Logger

                            -

                            Custom implementation of the logging.Logger class with an added trace method.

                            +

                            Bases: Logger

                            +

                            Custom implementation of the logging.Logger class with an added trace method.

                            trace(msg, *args, **kwargs)[source]#
                            @@ -358,15 +358,15 @@
                            -
                            Parameters
                            +
                            Parameters:
                              -

                            • msg (str) – The message to be logged.

                              • +

                            • msg (str) – The message to be logged.

                            • args – Passed to the base log function as is.

                            • kwargs – Passed to the base log function as is.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -378,13 +378,13 @@ get_logger(name=None)[source]#

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

                            -
                            Parameters
                            -

                            name (Optional[str]) – The name given to the logger.

                            +
                            Parameters:
                            +

                            name (Optional[str]) – The name given to the logger.

                            -
                            Return type
                            +
                            Return type:

                            CustomLogger

                            -
                            Returns
                            +
                            Returns:

                            An instance of the CustomLogger class.

                            diff --git a/v8.0.0/output/botcore.utils.members.html b/v8.0.0/output/botcore.utils.members.html index c8c95ca3..74b05b45 100644 --- a/v8.0.0/output/botcore.utils.members.html +++ b/v8.0.0/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            diff --git a/v8.0.0/output/botcore.utils.regex.html b/v8.0.0/output/botcore.utils.regex.html index 4c555070..34d1d3d8 100644 --- a/v8.0.0/output/botcore.utils.regex.html +++ b/v8.0.0/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • @@ -352,7 +352,7 @@

                              Warning

                              This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                              +such as urllib.parse.quote().

                              diff --git a/v8.0.0/output/botcore.utils.scheduling.html b/v8.0.0/output/botcore.utils.scheduling.html index ec566366..7817e4f1 100644 --- a/v8.0.0/output/botcore.utils.scheduling.html +++ b/v8.0.0/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              • - main + main
                              • @@ -347,7 +347,7 @@
                                class Scheduler(name)[source]#
                                -

                                Bases: object

                                +

                                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 instance’s log messages from other instances. Using the name of the class or module containing @@ -361,16 +361,16 @@ the same ID used to schedule it.

                                __contains__(task_id)[source]#
                                -

                                Return True if a task with the given task_id is currently scheduled.

                                +

                                Return True if a task with the given task_id is currently scheduled.

                                -
                                Parameters
                                -

                                task_id (Hashable) – The task to look for.

                                +
                                Parameters:
                                +

                                task_id (Hashable) – The task to look for.

                                -
                                Return type
                                -

                                bool

                                +
                                Return type:
                                +

                                bool

                                -
                                Returns
                                -

                                True if the task was found.

                                +
                                Returns:
                                +

                                True if the task was found.

                                @@ -380,8 +380,8 @@ the same ID used to schedule it.

                                __init__(name)[source]#

                                Initialize a new Scheduler instance.

                                -
                                Parameters
                                -

                                name (str) – The name of the Scheduler. Used in logging, and namespacing.

                                +
                                Parameters:
                                +

                                name (str) – The name of the Scheduler. Used in logging, and namespacing.

                                @@ -391,11 +391,11 @@ the same ID used to schedule it.

                                cancel(task_id)[source]#

                                Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                                -
                                Parameters
                                -

                                task_id (Hashable) – The task’s unique ID.

                                +
                                Parameters:
                                +

                                task_id (Hashable) – The task’s unique ID.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -405,8 +405,8 @@ the same ID used to schedule it.

                                cancel_all()[source]#

                                Unschedule all known tasks.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -418,14 +418,14 @@ the same ID used to schedule it.

                                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.

                                -
                                Parameters
                                +
                                Parameters:
                                  -

                                • task_id (Hashable) – A unique ID to create the task with.

                                  • -

                                • coroutine (Coroutine) – The function to be called.

                                  • +

                                • task_id (Hashable) – A unique ID to create the task with.

                                  • +

                                • coroutine (Coroutine) – The function to be called.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                        @@ -440,15 +440,15 @@ If timeIf 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.

                        -
                        Parameters
                        +
                        Parameters:
                          -

                        • time (datetime) – The time to start the task.

                          • -

                        • task_id (Hashable) – A unique ID to create the task with.

                          • -

                        • coroutine (Coroutine) – The function to be called.

                          • +

                        • time (datetime) – The time to start the task.

                          • +

                        • task_id (Hashable) – A unique ID to create the task with.

                          • +

                        • coroutine (Coroutine) – The function to be called.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -460,15 +460,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

                        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.

                        -
                        Parameters
                        +
                        Parameters:
                          -

                        • delay (Union[int, float]) – How long to wait before starting the task.

                          • -

                        • task_id (Hashable) – A unique ID to create the task with.

                          • -

                        • coroutine (Coroutine) – The function to be called.

                          • +

                        • delay (Union[int, float]) – How long to wait before starting the task.

                          • +

                        • task_id (Hashable) – A unique ID to create the task with.

                          • +

                        • coroutine (Coroutine) – The function to be called.

                        -
                        Return type
                        -

                        None

                        +
                        Return type:
                        +

                        None

                        @@ -478,23 +478,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
                        create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
                        -

                        Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

                        +

                        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.

                        -
                        Parameters
                        +
                        Parameters:
                        -
                        Returns
                        +
                        Returns:

                        The wrapped task.

                        -
                        Return type
                        -

                        asyncio.Task

                        +
                        Return type:
                        +

                        asyncio.Task

                        diff --git a/v8.0.0/searchindex.js b/v8.0.0/searchindex.js index 67ad5e23..d4cad635 100644 --- a/v8.0.0/searchindex.js +++ b/v8.0.0/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "0": [0, 8, 11, 12], "27th": 0, "juli": 0, "2022": 0, "break": 0, "110": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "rc2": 0, "bug": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "support": [0, 4, 7, 15], "add": [0, 3], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "7": 0, "5": 0, "23rd": 0, "featur": [0, 1, 3], "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "1": [0, 12], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Exts": [[5, "module-botcore.exts"]], "site_api": [[6, "module-botcore.site_api"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Changelog": [[0, "changelog"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "async_stats": [[4, "module-botcore.async_stats"]], "channel": [[9, "module-botcore.utils.channel"]], "caching": [[8, "module-botcore.utils.caching"]], "members": [[13, "module-botcore.utils.members"]], "regex": [[14, "module-botcore.utils.regex"]], "commands": [[10, "module-botcore.utils.commands"]], "interactions": [[11, "module-botcore.utils.interactions"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "logging": [[12, "module-botcore.utils.logging"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "0": [0, 8, 11, 12], "27th": 0, "juli": 0, "2022": 0, "break": 0, "110": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "rc2": 0, "bug": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "support": [0, 4, 7, 15], "add": [0, 3], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "7": 0, "5": 0, "23rd": 0, "featur": [0, 1, 3], "101": 0, "util": [0, 1, 2, 3, 8, 11, 12], "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "attr": 0, "botcor": [0, 1, 2, 11], "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "1": [0, 12], "16th": 0, "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "regex": [0, 3, 7], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "match": 3, "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "discord_invit": [3, 7, 14], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "http": [6, 14], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Changelog": [[0, "changelog"]], "site_api": [[6, "module-botcore.site_api"]], "Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Exts": [[5, "module-botcore.exts"]], "async_stats": [[4, "module-botcore.async_stats"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "regex": [[14, "module-botcore.utils.regex"]], "commands": [[10, "module-botcore.utils.commands"]], "interactions": [[11, "module-botcore.utils.interactions"]], "caching": [[8, "module-botcore.utils.caching"]], "channel": [[9, "module-botcore.utils.channel"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "logging": [[12, "module-botcore.utils.logging"]], "members": [[13, "module-botcore.utils.members"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v8.1.0/.buildinfo b/v8.1.0/.buildinfo index e8c4c154..126ba39e 100644 --- a/v8.1.0/.buildinfo +++ b/v8.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: 9f507852017fea643a2d376376f371d2 +config: 8e581e0785fa57551e1ab168a938d8b5 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v8.1.0/_static/basic.css b/v8.1.0/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v8.1.0/_static/basic.css +++ b/v8.1.0/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v8.1.0/_static/debug.css b/v8.1.0/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v8.1.0/_static/debug.css +++ b/v8.1.0/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v8.1.0/_static/pygments.css b/v8.1.0/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v8.1.0/_static/pygments.css +++ b/v8.1.0/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v8.1.0/_static/skeleton.css b/v8.1.0/_static/skeleton.css index 01231167..467c878c 100644 --- a/v8.1.0/_static/skeleton.css +++ b/v8.1.0/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v8.1.0/changelog.html b/v8.1.0/changelog.html index 1052c8bb..b6241c56 100644 --- a/v8.1.0/changelog.html +++ b/v8.1.0/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v8.1.0/development.html b/v8.1.0/development.html index 47846974..b842f9a9 100644 --- a/v8.1.0/development.html +++ b/v8.1.0/development.html @@ -2,7 +2,7 @@ - + diff --git a/v8.1.0/index.html b/v8.1.0/index.html index 8e085cb2..63fdf839 100644 --- a/v8.1.0/index.html +++ b/v8.1.0/index.html @@ -2,7 +2,7 @@ - + diff --git a/v8.1.0/output/botcore.async_stats.html b/v8.1.0/output/botcore.async_stats.html index af109ca4..f8fcb563 100644 --- a/v8.1.0/output/botcore.async_stats.html +++ b/v8.1.0/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                        • - main + main
                        • @@ -354,13 +354,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

                          Create a new AsyncStatsClient.

                          -
                          Parameters
                          +
                          Parameters:
                          @@ -369,10 +369,10 @@
                          async create_socket()[source]#
                          -

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

                          +

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

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          diff --git a/v8.1.0/output/botcore.exts.html b/v8.1.0/output/botcore.exts.html index 98676470..cdc72e10 100644 --- a/v8.1.0/output/botcore.exts.html +++ b/v8.1.0/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • diff --git a/v8.1.0/output/botcore.html b/v8.1.0/output/botcore.html index 71bcda1e..a7c66638 100644 --- a/v8.1.0/output/botcore.html +++ b/v8.1.0/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • @@ -354,14 +354,14 @@ __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
                              +
                              Parameters:
                              @@ -373,8 +373,8 @@ a dummy statsd client will be created.

                              • async add_cog(cog)[source]#

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

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -384,8 +384,8 @@ a dummy statsd client will be created.

                              add_command(command)[source]#

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

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -395,8 +395,8 @@ a dummy statsd client will be created.

                              clear()[source]#

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

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -406,8 +406,8 @@ a dummy statsd client will be created.

                              async close()[source]#

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

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -418,8 +418,8 @@ a dummy statsd client will be created.

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

                              This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -429,8 +429,8 @@ a dummy statsd client will be created.

                              async log_to_dev_log(message)[source]#

                              Log the given message to #dev-log.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -442,8 +442,8 @@ a dummy statsd client will be created.

                              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.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                          @@ -453,8 +453,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

                          Clear the internal guild available event when self.guild_id becomes unavailable.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -464,8 +464,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

                          Ping all required services on setup to ensure they are up before starting.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -477,8 +477,8 @@ will not be set and guild_available_but_cache_empty event will be e

                          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
                          -

                          Optional[Command]

                          +
                          Return type:
                          +

                          Optional[Command]

                          @@ -491,8 +491,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -504,8 +504,8 @@ and -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

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

                          Bases: Exception

                          +

                          Bases: Exception

                          Exception class for startup errors.

                          diff --git a/v8.1.0/output/botcore.site_api.html b/v8.1.0/output/botcore.site_api.html index a7ef14eb..3e18bd88 100644 --- a/v8.1.0/output/botcore.site_api.html +++ b/v8.1.0/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • @@ -347,17 +347,17 @@
                            class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
                            -

                            Bases: object

                            +

                            Bases: object

                            A wrapper for the Django Site API.

                            __init__(site_api_url, site_api_token, **session_kwargs)[source]#

                            Initialize a new APIClient instance.

                            -
                            Parameters
                            +
                            Parameters:
                              -

                            • site_api_url (str) – The URL of the site API.

                              • -

                            • site_api_token (str) – The token to use for authentication.

                              • +

                            • site_api_url (str) – The URL of the site API.

                              • +

                            • site_api_token (str) – The token to use for authentication.

                            • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

                            @@ -369,8 +369,8 @@ async close()[source]#

                          Close the aiohttp session.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -380,17 +380,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

                          Send a DELETE request to the site API and return the JSON response.

                          -
                          Parameters
                          +
                          Parameters:
                            -

                          • endpoint (str) – The endpoint to send the request to.

                            • -

                          • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                            • +

                          • endpoint (str) – The endpoint to send the request to.

                            • +

                          • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                          • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                          -
                          Return type
                          -

                          Optional[dict]

                          +
                          Return type:
                          +

                          Optional[dict]

                          -
                          Returns
                          +
                          Returns:

                          The JSON response the API returns, or None if the response is 204 No Content.

                          @@ -401,8 +401,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                          -
                          Return type
                          -

                          dict

                          +
                          Return type:
                          +

                          dict

                          @@ -412,17 +412,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

                          -
                          Parameters
                          +
                          Parameters:

                          • response (aiohttp.ClientResponse) – The response to check.

                            • -

                          • should_raise (bool) – Whether or not to raise an exception.

                            • +

                          • should_raise (bool) – Whether or not to raise an exception.

                          -
                          Raises
                          +
                          Raises:

                          ResponseCodeError – If the response is not OK and should_raise is True.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -432,8 +432,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                          -
                          Return type
                          -

                          dict

                          +
                          Return type:
                          +

                          dict

                          @@ -443,8 +443,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                          -
                          Return type
                          -

                          dict

                          +
                          Return type:
                          +

                          dict

                          @@ -454,8 +454,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                          -
                          Return type
                          -

                          dict

                          +
                          Return type:
                          +

                          dict

                          @@ -465,21 +465,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

                          Send an HTTP request to the site API and return the JSON response.

                          -
                          Parameters
                          +
                          Parameters:
                            -

                          • method (str) – The HTTP method to use.

                            • -

                          • endpoint (str) – The endpoint to send the request to.

                            • -

                          • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                            • +

                          • method (str) – The HTTP method to use.

                            • +

                          • endpoint (str) – The endpoint to send the request to.

                            • +

                          • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                          • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                          -
                          Return type
                          -

                          dict

                          +
                          Return type:
                          +

                          dict

                          -
                          Returns
                          +
                          Returns:

                          The JSON response the API returns.

                          -
                          Raises
                          +
                          Raises:

                          ResponseCodeError – If the response is not OK and raise_for_status is True.

                          @@ -490,18 +490,18 @@
                          exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
                          -

                          Bases: ValueError

                          +

                          Bases: ValueError

                          Raised in APIClient.request() when a non-OK HTTP response is received.

                          __init__(response, response_json=None, response_text=None)[source]#

                          Initialize a new ResponseCodeError instance.

                          -
                          Parameters
                          +
                          Parameters:

                          • response (aiohttp.ClientResponse) – The response object from the request.

                            • -

                          • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                            • -

                          • response_text (Optional[str]) – The text of the request, if any.

                            • +

                          • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                            • +

                          • response_text (Optional[str]) – The text of the request, if any.

                          diff --git a/v8.1.0/output/botcore.utils.caching.html b/v8.1.0/output/botcore.utils.caching.html index f754d0f6..083b1769 100644 --- a/v8.1.0/output/botcore.utils.caching.html +++ b/v8.1.0/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • @@ -347,7 +347,7 @@
                            class AsyncCache(max_size=128)[source]#
                            -

                            Bases: object

                            +

                            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.

                            @@ -356,13 +356,13 @@ __call__(arg_offset=0)[source]#

                            Decorator for async cache.

                            -
                            Parameters
                            -

                            arg_offset (int) – The offset for the position of the key argument.

                            +
                            Parameters:
                            +

                            arg_offset (int) – The offset for the position of the key argument.

                            -
                            Return type
                            -

                            Callable

                            +
                            Return type:
                            +

                            Callable

                            -
                            Returns
                            +
                            Returns:

                            A decorator to wrap the target function.

                            @@ -373,8 +373,8 @@ __init__(max_size=128)[source]#

                            Initialise a new AsyncCache instance.

                            -
                            Parameters
                            -

                            max_size (int) – How many items to store in the cache.

                            +
                            Parameters:
                            +

                            max_size (int) – How many items to store in the cache.

                            @@ -384,8 +384,8 @@ clear()[source]#

                            Clear cache instance.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                          diff --git a/v8.1.0/output/botcore.utils.channel.html b/v8.1.0/output/botcore.utils.channel.html index 9626f50c..4e75e228 100644 --- a/v8.1.0/output/botcore.utils.channel.html +++ b/v8.1.0/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • @@ -349,13 +349,13 @@ 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
                            +
                            Parameters:

                            • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

                              • -

                            • channel_id (int) – The channel to get/fetch.

                              • +

                            • channel_id (int) – The channel to get/fetch.

                            -
                            Raises
                            +
                            Raises:
                            -
                            Return type
                            +
                            Return type:

                            GuildChannel

                            -
                            Returns
                            +
                            Returns:

                            The channel from the ID.

                            @@ -377,16 +377,16 @@ is_in_category(channel, category_id)[source]#

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

                            -
                            Parameters
                            +
                            Parameters:

                            • channel (TextChannel) – The channel to check.

                              • -

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

                              • +

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

                            -
                            Return type
                            -

                            bool

                            +
                            Return type:
                            +

                            bool

                            -
                            Returns
                            +
                            Returns:

                            A bool depending on whether the channel is in the category.

                            diff --git a/v8.1.0/output/botcore.utils.commands.html b/v8.1.0/output/botcore.utils.commands.html index c0fc6d5f..4ad44180 100644 --- a/v8.1.0/output/botcore.utils.commands.html +++ b/v8.1.0/output/botcore.utils.commands.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • @@ -348,19 +348,19 @@ async clean_text_or_reply(ctx, text=None)[source]#

                              Cleans a text argument or replied message’s content.

                              -
                              Parameters
                              +
                              Parameters:

                              • ctx (Context) – The command’s context

                                • -

                              • text (Optional[str]) – The provided text argument of the command (if given)

                                • +

                              • text (Optional[str]) – The provided text argument of the command (if given)

                              -
                              Raises
                              +
                              Raises:

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

                              -
                              Return type
                              -

                              str

                              +
                              Return type:
                              +

                              str

                              -
                              Returns
                              +
                              Returns:

                              The cleaned version of text, if given, else replied message.

                              diff --git a/v8.1.0/output/botcore.utils.html b/v8.1.0/output/botcore.utils.html index decf4400..922a41c4 100644 --- a/v8.1.0/output/botcore.utils.html +++ b/v8.1.0/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              • - main + main
                              • @@ -357,8 +357,8 @@ that will act as top-level groups rather than being aliases of the command’s g
                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -368,13 +368,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

                          -
                          Parameters
                          -

                          name (str) – The module name to unqualify.

                          +
                          Parameters:
                          +

                          name (str) – The module name to unqualify.

                          -
                          Return type
                          -

                          str

                          +
                          Return type:
                          +

                          str

                          -
                          Returns
                          +
                          Returns:

                          The unqualified module name.

                          diff --git a/v8.1.0/output/botcore.utils.interactions.html b/v8.1.0/output/botcore.utils.interactions.html index 6c0cf2d0..a32e15d4 100644 --- a/v8.1.0/output/botcore.utils.interactions.html +++ b/v8.1.0/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • @@ -351,10 +351,10 @@

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

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

                            -
                            Parameters
                            +
                            Parameters:

                            • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

                              • -

                            • label (str) – The label of the button, set to “Delete” if not specified.

                              • +

                            • label (str) – The label of the button, set to “Delete” if not specified.

                            @@ -368,8 +368,8 @@ async callback(interaction)[source]#

                            Delete the original message on button click.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -382,13 +382,13 @@

                            Bases: View

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

                            -
                            Parameters
                            +
                            Parameters:
                              -

                            • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                              • -

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

                            • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                              • +

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

                            @@ -403,11 +403,11 @@ If Noneasync interaction_check(interaction)[source]#

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

                            -
                            Parameters
                            +
                            Parameters:

                            interaction (Interaction) – The interaction that occurred.

                            -
                            Return type
                            -

                            bool

                            +
                            Return type:
                            +

                            bool

                            @@ -417,8 +417,8 @@ If Noneasync on_timeout()[source]#

                            Remove the view from self.message if set.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            diff --git a/v8.1.0/output/botcore.utils.logging.html b/v8.1.0/output/botcore.utils.logging.html index dc3e6e43..f9c4ef0f 100644 --- a/v8.1.0/output/botcore.utils.logging.html +++ b/v8.1.0/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • @@ -347,8 +347,8 @@
                              class CustomLogger(name, level=0)[source]#
                              -

                              Bases: Logger

                              -

                              Custom implementation of the logging.Logger class with an added trace method.

                              +

                              Bases: Logger

                              +

                              Custom implementation of the logging.Logger class with an added trace method.

                              trace(msg, *args, **kwargs)[source]#
                              @@ -358,15 +358,15 @@
                              -
                              Parameters
                              +
                              Parameters:
                                -

                              • msg (str) – The message to be logged.

                                • +

                              • msg (str) – The message to be logged.

                              • args – Passed to the base log function as is.

                              • kwargs – Passed to the base log function as is.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -378,13 +378,13 @@ get_logger(name=None)[source]#

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

                              -
                              Parameters
                              -

                              name (Optional[str]) – The name given to the logger.

                              +
                              Parameters:
                              +

                              name (Optional[str]) – The name given to the logger.

                              -
                              Return type
                              +
                              Return type:

                              CustomLogger

                              -
                              Returns
                              +
                              Returns:

                              An instance of the CustomLogger class.

                              diff --git a/v8.1.0/output/botcore.utils.members.html b/v8.1.0/output/botcore.utils.members.html index 605d2a87..b3c6d4cd 100644 --- a/v8.1.0/output/botcore.utils.members.html +++ b/v8.1.0/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              diff --git a/v8.1.0/output/botcore.utils.regex.html b/v8.1.0/output/botcore.utils.regex.html index 74414e8d..66b188b1 100644 --- a/v8.1.0/output/botcore.utils.regex.html +++ b/v8.1.0/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              • - main + main
                              • @@ -352,7 +352,7 @@

                                Warning

                                This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                                +such as urllib.parse.quote().

                                diff --git a/v8.1.0/output/botcore.utils.scheduling.html b/v8.1.0/output/botcore.utils.scheduling.html index fa021e03..8963948b 100644 --- a/v8.1.0/output/botcore.utils.scheduling.html +++ b/v8.1.0/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                • - main + main
                                • @@ -347,7 +347,7 @@
                                  class Scheduler(name)[source]#
                                  -

                                  Bases: object

                                  +

                                  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 instance’s log messages from other instances. Using the name of the class or module containing @@ -361,16 +361,16 @@ the same ID used to schedule it.

                                  __contains__(task_id)[source]#
                                  -

                                  Return True if a task with the given task_id is currently scheduled.

                                  +

                                  Return True if a task with the given task_id is currently scheduled.

                                  -
                                  Parameters
                                  -

                                  task_id (Hashable) – The task to look for.

                                  +
                                  Parameters:
                                  +

                                  task_id (Hashable) – The task to look for.

                                  -
                                  Return type
                                  -

                                  bool

                                  +
                                  Return type:
                                  +

                                  bool

                                  -
                                  Returns
                                  -

                                  True if the task was found.

                                  +
                                  Returns:
                                  +

                                  True if the task was found.

                                  @@ -380,8 +380,8 @@ the same ID used to schedule it.

                                  __init__(name)[source]#

                                  Initialize a new Scheduler instance.

                                  -
                                  Parameters
                                  -

                                  name (str) – The name of the Scheduler. Used in logging, and namespacing.

                                  +
                                  Parameters:
                                  +

                                  name (str) – The name of the Scheduler. Used in logging, and namespacing.

                                  @@ -391,11 +391,11 @@ the same ID used to schedule it.

                                  cancel(task_id)[source]#

                                  Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                                  -
                                  Parameters
                                  -

                                  task_id (Hashable) – The task’s unique ID.

                                  +
                                  Parameters:
                                  +

                                  task_id (Hashable) – The task’s unique ID.

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                  @@ -405,8 +405,8 @@ the same ID used to schedule it.

                                  cancel_all()[source]#

                                  Unschedule all known tasks.

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                  @@ -418,14 +418,14 @@ the same ID used to schedule it.

                                  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.

                                  -
                                  Parameters
                                  +
                                  Parameters:
                                    -

                                  • task_id (Hashable) – A unique ID to create the task with.

                                    • -

                                  • coroutine (Coroutine) – The function to be called.

                                    • +

                                  • task_id (Hashable) – A unique ID to create the task with.

                                    • +

                                  • coroutine (Coroutine) – The function to be called.

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                          @@ -440,15 +440,15 @@ If timeIf 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.

                          -
                          Parameters
                          +
                          Parameters:
                            -

                          • time (datetime) – The time to start the task.

                            • -

                          • task_id (Hashable) – A unique ID to create the task with.

                            • -

                          • coroutine (Coroutine) – The function to be called.

                            • +

                          • time (datetime) – The time to start the task.

                            • +

                          • task_id (Hashable) – A unique ID to create the task with.

                            • +

                          • coroutine (Coroutine) – The function to be called.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -460,15 +460,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

                          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.

                          -
                          Parameters
                          +
                          Parameters:
                            -

                          • delay (Union[int, float]) – How long to wait before starting the task.

                            • -

                          • task_id (Hashable) – A unique ID to create the task with.

                            • -

                          • coroutine (Coroutine) – The function to be called.

                            • +

                          • delay (Union[int, float]) – How long to wait before starting the task.

                            • +

                          • task_id (Hashable) – A unique ID to create the task with.

                            • +

                          • coroutine (Coroutine) – The function to be called.

                          -
                          Return type
                          -

                          None

                          +
                          Return type:
                          +

                          None

                          @@ -478,23 +478,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
                          create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
                          -

                          Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

                          +

                          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.

                          -
                          Parameters
                          +
                          Parameters:
                          -
                          Returns
                          +
                          Returns:

                          The wrapped task.

                          -
                          Return type
                          -

                          asyncio.Task

                          +
                          Return type:
                          +

                          asyncio.Task

                          diff --git a/v8.1.0/searchindex.js b/v8.1.0/searchindex.js index 04ca5f4f..085d9ccb 100644 --- a/v8.1.0/searchindex.js +++ b/v8.1.0/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "1": [0, 12], "0": [0, 8, 11, 12], "16th": 0, "august": 0, "2022": 0, "support": [0, 4, 7, 15], "124": 0, "updat": 0, "botcor": [0, 1, 2, 11], "util": [0, 1, 2, 3, 8, 11, 12], "regex": [0, 3, 7], "discord_invit": [0, 3, 7, 14], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "match": [0, 3], "lead": 0, "http": [0, 6, 14], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "www": 0, "27th": 0, "juli": 0, "break": 0, "110": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "rc2": 0, "bug": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "add": [0, 3], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "7": 0, "5": 0, "23rd": 0, "featur": [0, 1, 3], "101": 0, "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "attr": 0, "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "async_stats": [[4, "module-botcore.async_stats"]], "site_api": [[6, "module-botcore.site_api"]], "Exts": [[5, "module-botcore.exts"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Changelog": [[0, "changelog"]], "members": [[13, "module-botcore.utils.members"]], "channel": [[9, "module-botcore.utils.channel"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "caching": [[8, "module-botcore.utils.caching"]], "interactions": [[11, "module-botcore.utils.interactions"]], "commands": [[10, "module-botcore.utils.commands"]], "regex": [[14, "module-botcore.utils.regex"]], "logging": [[12, "module-botcore.utils.logging"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "1": [0, 12], "0": [0, 8, 11, 12], "16th": 0, "august": 0, "2022": 0, "support": [0, 4, 7, 15], "124": 0, "updat": 0, "botcor": [0, 1, 2, 11], "util": [0, 1, 2, 3, 8, 11, 12], "regex": [0, 3, 7], "discord_invit": [0, 3, 7, 14], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "match": [0, 3], "lead": 0, "http": [0, 6, 14], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "www": 0, "27th": 0, "juli": 0, "break": 0, "110": 0, "bump": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "rc2": 0, "bug": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "add": [0, 3], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "7": 0, "5": 0, "23rd": 0, "featur": [0, 1, 3], "101": 0, "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "attr": 0, "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "2": [0, 3, 11], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "18th": 0, "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"async_stats": [[4, "module-botcore.async_stats"]], "Changelog": [[0, "changelog"]], "Exts": [[5, "module-botcore.exts"]], "Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "site_api": [[6, "module-botcore.site_api"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "logging": [[12, "module-botcore.utils.logging"]], "interactions": [[11, "module-botcore.utils.interactions"]], "channel": [[9, "module-botcore.utils.channel"]], "caching": [[8, "module-botcore.utils.caching"]], "regex": [[14, "module-botcore.utils.regex"]], "commands": [[10, "module-botcore.utils.commands"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "members": [[13, "module-botcore.utils.members"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v8.2.0/.buildinfo b/v8.2.0/.buildinfo index ff956c0b..c286f598 100644 --- a/v8.2.0/.buildinfo +++ b/v8.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: 53d11d0d3ca130606bc98a51887a759b +config: 2aa2c4c5be1e8e8976898eab02c6c209 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v8.2.0/_static/basic.css b/v8.2.0/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v8.2.0/_static/basic.css +++ b/v8.2.0/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v8.2.0/_static/debug.css b/v8.2.0/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v8.2.0/_static/debug.css +++ b/v8.2.0/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v8.2.0/_static/pygments.css b/v8.2.0/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v8.2.0/_static/pygments.css +++ b/v8.2.0/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v8.2.0/_static/skeleton.css b/v8.2.0/_static/skeleton.css index 01231167..467c878c 100644 --- a/v8.2.0/_static/skeleton.css +++ b/v8.2.0/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v8.2.0/changelog.html b/v8.2.0/changelog.html index ae79291b..5979f795 100644 --- a/v8.2.0/changelog.html +++ b/v8.2.0/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v8.2.0/development.html b/v8.2.0/development.html index 0012fa5d..c6e1f61a 100644 --- a/v8.2.0/development.html +++ b/v8.2.0/development.html @@ -2,7 +2,7 @@ - + diff --git a/v8.2.0/index.html b/v8.2.0/index.html index d13b507c..ff5b20ab 100644 --- a/v8.2.0/index.html +++ b/v8.2.0/index.html @@ -2,7 +2,7 @@ - + diff --git a/v8.2.0/output/botcore.async_stats.html b/v8.2.0/output/botcore.async_stats.html index bb8b0904..85861c14 100644 --- a/v8.2.0/output/botcore.async_stats.html +++ b/v8.2.0/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                          • - main + main
                          • @@ -354,13 +354,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

                            Create a new AsyncStatsClient.

                            -
                            Parameters
                            +
                            Parameters:
                            @@ -369,10 +369,10 @@
                            async create_socket()[source]#
                            -

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

                            +

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

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            diff --git a/v8.2.0/output/botcore.exts.html b/v8.2.0/output/botcore.exts.html index ad6d4bf5..74a0a179 100644 --- a/v8.2.0/output/botcore.exts.html +++ b/v8.2.0/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • diff --git a/v8.2.0/output/botcore.html b/v8.2.0/output/botcore.html index ff9da80b..2d11a04f 100644 --- a/v8.2.0/output/botcore.html +++ b/v8.2.0/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              • - main + main
                              • @@ -354,14 +354,14 @@ __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
                                +
                                Parameters:
                                @@ -373,8 +373,8 @@ a dummy statsd client will be created.

                                • async add_cog(cog)[source]#

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

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -384,8 +384,8 @@ a dummy statsd client will be created.

                                add_command(command)[source]#

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

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -395,8 +395,8 @@ a dummy statsd client will be created.

                                clear()[source]#

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

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -406,8 +406,8 @@ a dummy statsd client will be created.

                                async close()[source]#

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

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -418,8 +418,8 @@ a dummy statsd client will be created.

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

                                This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -429,8 +429,8 @@ a dummy statsd client will be created.

                                async log_to_dev_log(message)[source]#

                                Log the given message to #dev-log.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -442,8 +442,8 @@ a dummy statsd client will be created.

                                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.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                            @@ -453,8 +453,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

                            Clear the internal guild available event when self.guild_id becomes unavailable.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -464,8 +464,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

                            Ping all required services on setup to ensure they are up before starting.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -477,8 +477,8 @@ will not be set and guild_available_but_cache_empty event will be e

                            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
                            -

                            Optional[Command]

                            +
                            Return type:
                            +

                            Optional[Command]

                            @@ -491,8 +491,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -504,8 +504,8 @@ and -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

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

                            Bases: Exception

                            +

                            Bases: Exception

                            Exception class for startup errors.

                            diff --git a/v8.2.0/output/botcore.site_api.html b/v8.2.0/output/botcore.site_api.html index 87ac7166..68583233 100644 --- a/v8.2.0/output/botcore.site_api.html +++ b/v8.2.0/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • @@ -347,17 +347,17 @@
                              class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
                              -

                              Bases: object

                              +

                              Bases: object

                              A wrapper for the Django Site API.

                              __init__(site_api_url, site_api_token, **session_kwargs)[source]#

                              Initialize a new APIClient instance.

                              -
                              Parameters
                              +
                              Parameters:
                                -

                              • site_api_url (str) – The URL of the site API.

                                • -

                              • site_api_token (str) – The token to use for authentication.

                                • +

                              • site_api_url (str) – The URL of the site API.

                                • +

                              • site_api_token (str) – The token to use for authentication.

                              • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

                              @@ -369,8 +369,8 @@ async close()[source]#

                            Close the aiohttp session.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -380,17 +380,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

                            Send a DELETE request to the site API and return the JSON response.

                            -
                            Parameters
                            +
                            Parameters:
                              -

                            • endpoint (str) – The endpoint to send the request to.

                              • -

                            • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                              • +

                            • endpoint (str) – The endpoint to send the request to.

                              • +

                            • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                            • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                            -
                            Return type
                            -

                            Optional[dict]

                            +
                            Return type:
                            +

                            Optional[dict]

                            -
                            Returns
                            +
                            Returns:

                            The JSON response the API returns, or None if the response is 204 No Content.

                            @@ -401,8 +401,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                            -
                            Return type
                            -

                            dict

                            +
                            Return type:
                            +

                            dict

                            @@ -412,17 +412,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

                            -
                            Parameters
                            +
                            Parameters:

                            • response (aiohttp.ClientResponse) – The response to check.

                              • -

                            • should_raise (bool) – Whether or not to raise an exception.

                              • +

                            • should_raise (bool) – Whether or not to raise an exception.

                            -
                            Raises
                            +
                            Raises:

                            ResponseCodeError – If the response is not OK and should_raise is True.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -432,8 +432,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                            -
                            Return type
                            -

                            dict

                            +
                            Return type:
                            +

                            dict

                            @@ -443,8 +443,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                            -
                            Return type
                            -

                            dict

                            +
                            Return type:
                            +

                            dict

                            @@ -454,8 +454,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                            -
                            Return type
                            -

                            dict

                            +
                            Return type:
                            +

                            dict

                            @@ -465,21 +465,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

                            Send an HTTP request to the site API and return the JSON response.

                            -
                            Parameters
                            +
                            Parameters:
                              -

                            • method (str) – The HTTP method to use.

                              • -

                            • endpoint (str) – The endpoint to send the request to.

                              • -

                            • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                              • +

                            • method (str) – The HTTP method to use.

                              • +

                            • endpoint (str) – The endpoint to send the request to.

                              • +

                            • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                            • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                            -
                            Return type
                            -

                            dict

                            +
                            Return type:
                            +

                            dict

                            -
                            Returns
                            +
                            Returns:

                            The JSON response the API returns.

                            -
                            Raises
                            +
                            Raises:

                            ResponseCodeError – If the response is not OK and raise_for_status is True.

                            @@ -490,18 +490,18 @@
                            exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
                            -

                            Bases: ValueError

                            +

                            Bases: ValueError

                            Raised in APIClient.request() when a non-OK HTTP response is received.

                            __init__(response, response_json=None, response_text=None)[source]#

                            Initialize a new ResponseCodeError instance.

                            -
                            Parameters
                            +
                            Parameters:

                            • response (aiohttp.ClientResponse) – The response object from the request.

                              • -

                            • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                              • -

                            • response_text (Optional[str]) – The text of the request, if any.

                              • +

                            • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                              • +

                            • response_text (Optional[str]) – The text of the request, if any.

                            diff --git a/v8.2.0/output/botcore.utils.caching.html b/v8.2.0/output/botcore.utils.caching.html index 2daf5e75..14877831 100644 --- a/v8.2.0/output/botcore.utils.caching.html +++ b/v8.2.0/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • @@ -347,7 +347,7 @@
                              class AsyncCache(max_size=128)[source]#
                              -

                              Bases: object

                              +

                              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.

                              @@ -356,13 +356,13 @@ __call__(arg_offset=0)[source]#

                              Decorator for async cache.

                              -
                              Parameters
                              -

                              arg_offset (int) – The offset for the position of the key argument.

                              +
                              Parameters:
                              +

                              arg_offset (int) – The offset for the position of the key argument.

                              -
                              Return type
                              -

                              Callable

                              +
                              Return type:
                              +

                              Callable

                              -
                              Returns
                              +
                              Returns:

                              A decorator to wrap the target function.

                              @@ -373,8 +373,8 @@ __init__(max_size=128)[source]#

                              Initialise a new AsyncCache instance.

                              -
                              Parameters
                              -

                              max_size (int) – How many items to store in the cache.

                              +
                              Parameters:
                              +

                              max_size (int) – How many items to store in the cache.

                              @@ -384,8 +384,8 @@ clear()[source]#

                              Clear cache instance.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                            diff --git a/v8.2.0/output/botcore.utils.channel.html b/v8.2.0/output/botcore.utils.channel.html index 025aa89a..48ae48ed 100644 --- a/v8.2.0/output/botcore.utils.channel.html +++ b/v8.2.0/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • @@ -349,13 +349,13 @@ 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
                              +
                              Parameters:

                              • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

                                • -

                              • channel_id (int) – The channel to get/fetch.

                                • +

                              • channel_id (int) – The channel to get/fetch.

                              -
                              Raises
                              +
                              Raises:
                              -
                              Return type
                              +
                              Return type:

                              GuildChannel

                              -
                              Returns
                              +
                              Returns:

                              The channel from the ID.

                              @@ -377,16 +377,16 @@ is_in_category(channel, category_id)[source]#

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

                              -
                              Parameters
                              +
                              Parameters:

                              • channel (TextChannel) – The channel to check.

                                • -

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

                                • +

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

                              -
                              Return type
                              -

                              bool

                              +
                              Return type:
                              +

                              bool

                              -
                              Returns
                              +
                              Returns:

                              A bool depending on whether the channel is in the category.

                              diff --git a/v8.2.0/output/botcore.utils.commands.html b/v8.2.0/output/botcore.utils.commands.html index cef6b351..6fc19a0f 100644 --- a/v8.2.0/output/botcore.utils.commands.html +++ b/v8.2.0/output/botcore.utils.commands.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              • - main + main
                              • @@ -348,19 +348,19 @@ async clean_text_or_reply(ctx, text=None)[source]#

                                Cleans a text argument or replied message’s content.

                                -
                                Parameters
                                +
                                Parameters:

                                • ctx (Context) – The command’s context

                                  • -

                                • text (Optional[str]) – The provided text argument of the command (if given)

                                  • +

                                • text (Optional[str]) – The provided text argument of the command (if given)

                                -
                                Raises
                                +
                                Raises:

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

                                -
                                Return type
                                -

                                str

                                +
                                Return type:
                                +

                                str

                                -
                                Returns
                                +
                                Returns:

                                The cleaned version of text, if given, else replied message.

                                diff --git a/v8.2.0/output/botcore.utils.html b/v8.2.0/output/botcore.utils.html index 93045c41..fc8be2ee 100644 --- a/v8.2.0/output/botcore.utils.html +++ b/v8.2.0/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                • - main + main
                                • @@ -357,8 +357,8 @@ that will act as top-level groups rather than being aliases of the command’s g
                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -368,13 +368,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

                            -
                            Parameters
                            -

                            name (str) – The module name to unqualify.

                            +
                            Parameters:
                            +

                            name (str) – The module name to unqualify.

                            -
                            Return type
                            -

                            str

                            +
                            Return type:
                            +

                            str

                            -
                            Returns
                            +
                            Returns:

                            The unqualified module name.

                            diff --git a/v8.2.0/output/botcore.utils.interactions.html b/v8.2.0/output/botcore.utils.interactions.html index 1e0732e3..b8981114 100644 --- a/v8.2.0/output/botcore.utils.interactions.html +++ b/v8.2.0/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • @@ -351,10 +351,10 @@

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

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

                              -
                              Parameters
                              +
                              Parameters:

                              • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

                                • -

                              • label (str) – The label of the button, set to “Delete” if not specified.

                                • +

                              • label (str) – The label of the button, set to “Delete” if not specified.

                              @@ -368,8 +368,8 @@ async callback(interaction)[source]#

                              Delete the original message on button click.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -382,13 +382,13 @@

                              Bases: View

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

                              -
                              Parameters
                              +
                              Parameters:
                                -

                              • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                                • -

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

                              • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                                • +

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

                              @@ -403,11 +403,11 @@ If Noneasync interaction_check(interaction)[source]#

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

                              -
                              Parameters
                              +
                              Parameters:

                              interaction (Interaction) – The interaction that occurred.

                              -
                              Return type
                              -

                              bool

                              +
                              Return type:
                              +

                              bool

                              @@ -417,8 +417,8 @@ If Noneasync on_timeout()[source]#

                              Remove the view from self.message if set.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              diff --git a/v8.2.0/output/botcore.utils.logging.html b/v8.2.0/output/botcore.utils.logging.html index 8f00777e..b83082ed 100644 --- a/v8.2.0/output/botcore.utils.logging.html +++ b/v8.2.0/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              • - main + main
                              • @@ -347,8 +347,8 @@
                                class CustomLogger(name, level=0)[source]#
                                -

                                Bases: Logger

                                -

                                Custom implementation of the logging.Logger class with an added trace method.

                                +

                                Bases: Logger

                                +

                                Custom implementation of the logging.Logger class with an added trace method.

                                trace(msg, *args, **kwargs)[source]#
                                @@ -358,15 +358,15 @@
                                -
                                Parameters
                                +
                                Parameters:
                                  -

                                • msg (str) – The message to be logged.

                                  • +

                                • msg (str) – The message to be logged.

                                • args – Passed to the base log function as is.

                                • kwargs – Passed to the base log function as is.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -378,13 +378,13 @@ get_logger(name=None)[source]#

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

                                -
                                Parameters
                                -

                                name (Optional[str]) – The name given to the logger.

                                +
                                Parameters:
                                +

                                name (Optional[str]) – The name given to the logger.

                                -
                                Return type
                                +
                                Return type:

                                CustomLogger

                                -
                                Returns
                                +
                                Returns:

                                An instance of the CustomLogger class.

                                diff --git a/v8.2.0/output/botcore.utils.members.html b/v8.2.0/output/botcore.utils.members.html index 438fc7c9..d9888c9c 100644 --- a/v8.2.0/output/botcore.utils.members.html +++ b/v8.2.0/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                diff --git a/v8.2.0/output/botcore.utils.regex.html b/v8.2.0/output/botcore.utils.regex.html index d3460b86..df1c6571 100644 --- a/v8.2.0/output/botcore.utils.regex.html +++ b/v8.2.0/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                • - main + main
                                • @@ -352,7 +352,7 @@

                                  Warning

                                  This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                                  +such as urllib.parse.quote().

                                  diff --git a/v8.2.0/output/botcore.utils.scheduling.html b/v8.2.0/output/botcore.utils.scheduling.html index 49606f9d..ffd8eb9b 100644 --- a/v8.2.0/output/botcore.utils.scheduling.html +++ b/v8.2.0/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                  • - main + main
                                  • @@ -347,7 +347,7 @@
                                    class Scheduler(name)[source]#
                                    -

                                    Bases: object

                                    +

                                    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 instance’s log messages from other instances. Using the name of the class or module containing @@ -361,16 +361,16 @@ the same ID used to schedule it.

                                    __contains__(task_id)[source]#
                                    -

                                    Return True if a task with the given task_id is currently scheduled.

                                    +

                                    Return True if a task with the given task_id is currently scheduled.

                                    -
                                    Parameters
                                    -

                                    task_id (Hashable) – The task to look for.

                                    +
                                    Parameters:
                                    +

                                    task_id (Hashable) – The task to look for.

                                    -
                                    Return type
                                    -

                                    bool

                                    +
                                    Return type:
                                    +

                                    bool

                                    -
                                    Returns
                                    -

                                    True if the task was found.

                                    +
                                    Returns:
                                    +

                                    True if the task was found.

                                    @@ -380,8 +380,8 @@ the same ID used to schedule it.

                                    __init__(name)[source]#

                                    Initialize a new Scheduler instance.

                                    -
                                    Parameters
                                    -

                                    name (str) – The name of the Scheduler. Used in logging, and namespacing.

                                    +
                                    Parameters:
                                    +

                                    name (str) – The name of the Scheduler. Used in logging, and namespacing.

                                    @@ -391,11 +391,11 @@ the same ID used to schedule it.

                                    cancel(task_id)[source]#

                                    Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                                    -
                                    Parameters
                                    -

                                    task_id (Hashable) – The task’s unique ID.

                                    +
                                    Parameters:
                                    +

                                    task_id (Hashable) – The task’s unique ID.

                                    -
                                    Return type
                                    -

                                    None

                                    +
                                    Return type:
                                    +

                                    None

                                    @@ -405,8 +405,8 @@ the same ID used to schedule it.

                                    cancel_all()[source]#

                                    Unschedule all known tasks.

                                    -
                                    Return type
                                    -

                                    None

                                    +
                                    Return type:
                                    +

                                    None

                                    @@ -418,14 +418,14 @@ the same ID used to schedule it.

                                    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.

                                    -
                                    Parameters
                                    +
                                    Parameters:
                                      -

                                    • task_id (Hashable) – A unique ID to create the task with.

                                      • -

                                    • coroutine (Coroutine) – The function to be called.

                                      • +

                                    • task_id (Hashable) – A unique ID to create the task with.

                                      • +

                                    • coroutine (Coroutine) – The function to be called.

                                    -
                                    Return type
                                    -

                                    None

                                    +
                                    Return type:
                                    +

                                    None

                            @@ -440,15 +440,15 @@ If timeIf 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.

                            -
                            Parameters
                            +
                            Parameters:
                              -

                            • time (datetime) – The time to start the task.

                              • -

                            • task_id (Hashable) – A unique ID to create the task with.

                              • -

                            • coroutine (Coroutine) – The function to be called.

                              • +

                            • time (datetime) – The time to start the task.

                              • +

                            • task_id (Hashable) – A unique ID to create the task with.

                              • +

                            • coroutine (Coroutine) – The function to be called.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -460,15 +460,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

                            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.

                            -
                            Parameters
                            +
                            Parameters:
                              -

                            • delay (Union[int, float]) – How long to wait before starting the task.

                              • -

                            • task_id (Hashable) – A unique ID to create the task with.

                              • -

                            • coroutine (Coroutine) – The function to be called.

                              • +

                            • delay (Union[int, float]) – How long to wait before starting the task.

                              • +

                            • task_id (Hashable) – A unique ID to create the task with.

                              • +

                            • coroutine (Coroutine) – The function to be called.

                            -
                            Return type
                            -

                            None

                            +
                            Return type:
                            +

                            None

                            @@ -478,23 +478,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
                            create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
                            -

                            Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

                            +

                            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.

                            -
                            Parameters
                            +
                            Parameters:
                            -
                            Returns
                            +
                            Returns:

                            The wrapped task.

                            -
                            Return type
                            -

                            asyncio.Task

                            +
                            Return type:
                            +

                            asyncio.Task

                            diff --git a/v8.2.0/searchindex.js b/v8.2.0/searchindex.js index c8365230..b81f9d13 100644 --- a/v8.2.0/searchindex.js +++ b/v8.2.0/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "2": [0, 3, 11], "0": [0, 8, 11, 12], "18th": 0, "august": 0, "2022": 0, "support": [0, 4, 7, 15], "125": 0, "bump": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "stabl": 0, "releas": 0, "1": [0, 12], "16th": 0, "124": 0, "updat": 0, "botcor": [0, 1, 2, 11], "util": [0, 1, 2, 3, 8, 11, 12], "regex": [0, 3, 7], "discord_invit": [0, 3, 7, 14], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "match": [0, 3], "lead": 0, "http": [0, 6, 14], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "www": 0, "27th": 0, "juli": 0, "break": 0, "110": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "rc2": 0, "bug": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "add": [0, 3], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "7": 0, "5": 0, "23rd": 0, "featur": [0, 1, 3], "101": 0, "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "attr": 0, "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "async_stats": [[4, "module-botcore.async_stats"]], "Changelog": [[0, "changelog"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Exts": [[5, "module-botcore.exts"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "site_api": [[6, "module-botcore.site_api"]], "regex": [[14, "module-botcore.utils.regex"]], "interactions": [[11, "module-botcore.utils.interactions"]], "logging": [[12, "module-botcore.utils.logging"]], "caching": [[8, "module-botcore.utils.caching"]], "members": [[13, "module-botcore.utils.members"]], "commands": [[10, "module-botcore.utils.commands"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "channel": [[9, "module-botcore.utils.channel"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "2": [0, 3, 11], "0": [0, 8, 11, 12], "18th": 0, "august": 0, "2022": 0, "support": [0, 4, 7, 15], "125": 0, "bump": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "stabl": 0, "releas": 0, "1": [0, 12], "16th": 0, "124": 0, "updat": 0, "botcor": [0, 1, 2, 11], "util": [0, 1, 2, 3, 8, 11, 12], "regex": [0, 3, 7], "discord_invit": [0, 3, 7, 14], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "match": [0, 3], "lead": 0, "http": [0, 6, 14], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "www": 0, "27th": 0, "juli": 0, "break": 0, "110": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "rc2": 0, "bug": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "add": [0, 3], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "7": 0, "5": 0, "23rd": 0, "featur": [0, 1, 3], "101": 0, "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "attr": 0, "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Exts": [[5, "module-botcore.exts"]], "async_stats": [[4, "module-botcore.async_stats"]], "site_api": [[6, "module-botcore.site_api"]], "Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Changelog": [[0, "changelog"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "commands": [[10, "module-botcore.utils.commands"]], "logging": [[12, "module-botcore.utils.logging"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "regex": [[14, "module-botcore.utils.regex"]], "channel": [[9, "module-botcore.utils.channel"]], "members": [[13, "module-botcore.utils.members"]], "interactions": [[11, "module-botcore.utils.interactions"]], "caching": [[8, "module-botcore.utils.caching"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v8.2.1/.buildinfo b/v8.2.1/.buildinfo index eeb52902..1f8b56d3 100644 --- a/v8.2.1/.buildinfo +++ b/v8.2.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: 9c6050a5d6fb4deea780c05b65577545 +config: 19117476584dae1e0c41cadec850930f tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v8.2.1/_static/basic.css b/v8.2.1/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v8.2.1/_static/basic.css +++ b/v8.2.1/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v8.2.1/_static/debug.css b/v8.2.1/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v8.2.1/_static/debug.css +++ b/v8.2.1/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v8.2.1/_static/pygments.css b/v8.2.1/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v8.2.1/_static/pygments.css +++ b/v8.2.1/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v8.2.1/_static/skeleton.css b/v8.2.1/_static/skeleton.css index 01231167..467c878c 100644 --- a/v8.2.1/_static/skeleton.css +++ b/v8.2.1/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v8.2.1/changelog.html b/v8.2.1/changelog.html index 7670fdd5..bb2a9a91 100644 --- a/v8.2.1/changelog.html +++ b/v8.2.1/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v8.2.1/development.html b/v8.2.1/development.html index e226a528..01609608 100644 --- a/v8.2.1/development.html +++ b/v8.2.1/development.html @@ -2,7 +2,7 @@ - + diff --git a/v8.2.1/index.html b/v8.2.1/index.html index 4d1cf126..ca0bc4fd 100644 --- a/v8.2.1/index.html +++ b/v8.2.1/index.html @@ -2,7 +2,7 @@ - + diff --git a/v8.2.1/output/botcore.async_stats.html b/v8.2.1/output/botcore.async_stats.html index b85f5480..219aea1d 100644 --- a/v8.2.1/output/botcore.async_stats.html +++ b/v8.2.1/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                            • - main + main
                            • @@ -354,13 +354,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

                              Create a new AsyncStatsClient.

                              -
                              Parameters
                              +
                              Parameters:
                              @@ -369,10 +369,10 @@
                              async create_socket()[source]#
                              -

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

                              +

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

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              diff --git a/v8.2.1/output/botcore.exts.html b/v8.2.1/output/botcore.exts.html index c01f6991..25ec94ee 100644 --- a/v8.2.1/output/botcore.exts.html +++ b/v8.2.1/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              • - main + main
                              • diff --git a/v8.2.1/output/botcore.html b/v8.2.1/output/botcore.html index 646eaa7f..edc99d6e 100644 --- a/v8.2.1/output/botcore.html +++ b/v8.2.1/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                • - main + main
                                • @@ -354,14 +354,14 @@ __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
                                  +
                                  Parameters:
                                  @@ -373,8 +373,8 @@ a dummy statsd client will be created.

                                  • async add_cog(cog)[source]#

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

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                  @@ -384,8 +384,8 @@ a dummy statsd client will be created.

                                  add_command(command)[source]#

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

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                  @@ -395,8 +395,8 @@ a dummy statsd client will be created.

                                  clear()[source]#

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

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                  @@ -406,8 +406,8 @@ a dummy statsd client will be created.

                                  async close()[source]#

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

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                  @@ -418,8 +418,8 @@ a dummy statsd client will be created.

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

                                  This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                  @@ -429,8 +429,8 @@ a dummy statsd client will be created.

                                  async log_to_dev_log(message)[source]#

                                  Log the given message to #dev-log.

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                  @@ -442,8 +442,8 @@ a dummy statsd client will be created.

                                  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.

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                              @@ -453,8 +453,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

                              Clear the internal guild available event when self.guild_id becomes unavailable.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -464,8 +464,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

                              Ping all required services on setup to ensure they are up before starting.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -477,8 +477,8 @@ will not be set and guild_available_but_cache_empty event will be e

                              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
                              -

                              Optional[Command]

                              +
                              Return type:
                              +

                              Optional[Command]

                              @@ -491,8 +491,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -504,8 +504,8 @@ and -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

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

                              Bases: Exception

                              +

                              Bases: Exception

                              Exception class for startup errors.

                              diff --git a/v8.2.1/output/botcore.site_api.html b/v8.2.1/output/botcore.site_api.html index 9c5c28ef..f6557351 100644 --- a/v8.2.1/output/botcore.site_api.html +++ b/v8.2.1/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              • - main + main
                              • @@ -347,17 +347,17 @@
                                class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
                                -

                                Bases: object

                                +

                                Bases: object

                                A wrapper for the Django Site API.

                                __init__(site_api_url, site_api_token, **session_kwargs)[source]#

                                Initialize a new APIClient instance.

                                -
                                Parameters
                                +
                                Parameters:
                                  -

                                • site_api_url (str) – The URL of the site API.

                                  • -

                                • site_api_token (str) – The token to use for authentication.

                                  • +

                                • site_api_url (str) – The URL of the site API.

                                  • +

                                • site_api_token (str) – The token to use for authentication.

                                • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

                                @@ -369,8 +369,8 @@ async close()[source]#

                              Close the aiohttp session.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -380,17 +380,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

                              Send a DELETE request to the site API and return the JSON response.

                              -
                              Parameters
                              +
                              Parameters:
                                -

                              • endpoint (str) – The endpoint to send the request to.

                                • -

                              • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                                • +

                              • endpoint (str) – The endpoint to send the request to.

                                • +

                              • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                              • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                              -
                              Return type
                              -

                              Optional[dict]

                              +
                              Return type:
                              +

                              Optional[dict]

                              -
                              Returns
                              +
                              Returns:

                              The JSON response the API returns, or None if the response is 204 No Content.

                              @@ -401,8 +401,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                              -
                              Return type
                              -

                              dict

                              +
                              Return type:
                              +

                              dict

                              @@ -412,17 +412,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

                              -
                              Parameters
                              +
                              Parameters:

                              • response (aiohttp.ClientResponse) – The response to check.

                                • -

                              • should_raise (bool) – Whether or not to raise an exception.

                                • +

                              • should_raise (bool) – Whether or not to raise an exception.

                              -
                              Raises
                              +
                              Raises:

                              ResponseCodeError – If the response is not OK and should_raise is True.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -432,8 +432,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                              -
                              Return type
                              -

                              dict

                              +
                              Return type:
                              +

                              dict

                              @@ -443,8 +443,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                              -
                              Return type
                              -

                              dict

                              +
                              Return type:
                              +

                              dict

                              @@ -454,8 +454,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                              -
                              Return type
                              -

                              dict

                              +
                              Return type:
                              +

                              dict

                              @@ -465,21 +465,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

                              Send an HTTP request to the site API and return the JSON response.

                              -
                              Parameters
                              +
                              Parameters:
                                -

                              • method (str) – The HTTP method to use.

                                • -

                              • endpoint (str) – The endpoint to send the request to.

                                • -

                              • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                                • +

                              • method (str) – The HTTP method to use.

                                • +

                              • endpoint (str) – The endpoint to send the request to.

                                • +

                              • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                              • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                              -
                              Return type
                              -

                              dict

                              +
                              Return type:
                              +

                              dict

                              -
                              Returns
                              +
                              Returns:

                              The JSON response the API returns.

                              -
                              Raises
                              +
                              Raises:

                              ResponseCodeError – If the response is not OK and raise_for_status is True.

                              @@ -490,18 +490,18 @@
                              exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
                              -

                              Bases: ValueError

                              +

                              Bases: ValueError

                              Raised in APIClient.request() when a non-OK HTTP response is received.

                              __init__(response, response_json=None, response_text=None)[source]#

                              Initialize a new ResponseCodeError instance.

                              -
                              Parameters
                              +
                              Parameters:

                              • response (aiohttp.ClientResponse) – The response object from the request.

                                • -

                              • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                                • -

                              • response_text (Optional[str]) – The text of the request, if any.

                                • +

                              • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                                • +

                              • response_text (Optional[str]) – The text of the request, if any.

                              diff --git a/v8.2.1/output/botcore.utils.caching.html b/v8.2.1/output/botcore.utils.caching.html index ea94a10b..d283a013 100644 --- a/v8.2.1/output/botcore.utils.caching.html +++ b/v8.2.1/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              • - main + main
                              • @@ -347,7 +347,7 @@
                                class AsyncCache(max_size=128)[source]#
                                -

                                Bases: object

                                +

                                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.

                                @@ -356,13 +356,13 @@ __call__(arg_offset=0)[source]#

                                Decorator for async cache.

                                -
                                Parameters
                                -

                                arg_offset (int) – The offset for the position of the key argument.

                                +
                                Parameters:
                                +

                                arg_offset (int) – The offset for the position of the key argument.

                                -
                                Return type
                                -

                                Callable

                                +
                                Return type:
                                +

                                Callable

                                -
                                Returns
                                +
                                Returns:

                                A decorator to wrap the target function.

                                @@ -373,8 +373,8 @@ __init__(max_size=128)[source]#

                                Initialise a new AsyncCache instance.

                                -
                                Parameters
                                -

                                max_size (int) – How many items to store in the cache.

                                +
                                Parameters:
                                +

                                max_size (int) – How many items to store in the cache.

                                @@ -384,8 +384,8 @@ clear()[source]#

                                Clear cache instance.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                              diff --git a/v8.2.1/output/botcore.utils.channel.html b/v8.2.1/output/botcore.utils.channel.html index 5c7cef57..ddac88c4 100644 --- a/v8.2.1/output/botcore.utils.channel.html +++ b/v8.2.1/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              • - main + main
                              • @@ -349,13 +349,13 @@ 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
                                +
                                Parameters:

                                • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

                                  • -

                                • channel_id (int) – The channel to get/fetch.

                                  • +

                                • channel_id (int) – The channel to get/fetch.

                                -
                                Raises
                                +
                                Raises:
                                -
                                Return type
                                +
                                Return type:

                                GuildChannel

                                -
                                Returns
                                +
                                Returns:

                                The channel from the ID.

                                @@ -377,16 +377,16 @@ is_in_category(channel, category_id)[source]#

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

                                -
                                Parameters
                                +
                                Parameters:

                                • channel (TextChannel) – The channel to check.

                                  • -

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

                                  • +

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

                                -
                                Return type
                                -

                                bool

                                +
                                Return type:
                                +

                                bool

                                -
                                Returns
                                +
                                Returns:

                                A bool depending on whether the channel is in the category.

                                diff --git a/v8.2.1/output/botcore.utils.commands.html b/v8.2.1/output/botcore.utils.commands.html index 2e569dfa..11240e9f 100644 --- a/v8.2.1/output/botcore.utils.commands.html +++ b/v8.2.1/output/botcore.utils.commands.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                • - main + main
                                • @@ -348,19 +348,19 @@ async clean_text_or_reply(ctx, text=None)[source]#

                                  Cleans a text argument or replied message’s content.

                                  -
                                  Parameters
                                  +
                                  Parameters:

                                  • ctx (Context) – The command’s context

                                    • -

                                  • text (Optional[str]) – The provided text argument of the command (if given)

                                    • +

                                  • text (Optional[str]) – The provided text argument of the command (if given)

                                  -
                                  Raises
                                  +
                                  Raises:

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

                                  -
                                  Return type
                                  -

                                  str

                                  +
                                  Return type:
                                  +

                                  str

                                  -
                                  Returns
                                  +
                                  Returns:

                                  The cleaned version of text, if given, else replied message.

                                  diff --git a/v8.2.1/output/botcore.utils.html b/v8.2.1/output/botcore.utils.html index ada85209..00f244b7 100644 --- a/v8.2.1/output/botcore.utils.html +++ b/v8.2.1/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                  • - main + main
                                  • @@ -357,8 +357,8 @@ that will act as top-level groups rather than being aliases of the command’s g
                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -368,13 +368,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

                              -
                              Parameters
                              -

                              name (str) – The module name to unqualify.

                              +
                              Parameters:
                              +

                              name (str) – The module name to unqualify.

                              -
                              Return type
                              -

                              str

                              +
                              Return type:
                              +

                              str

                              -
                              Returns
                              +
                              Returns:

                              The unqualified module name.

                              diff --git a/v8.2.1/output/botcore.utils.interactions.html b/v8.2.1/output/botcore.utils.interactions.html index 05015251..3ca8fc93 100644 --- a/v8.2.1/output/botcore.utils.interactions.html +++ b/v8.2.1/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                              • - main + main
                              • @@ -351,10 +351,10 @@

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

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

                                -
                                Parameters
                                +
                                Parameters:

                                • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

                                  • -

                                • label (str) – The label of the button, set to “Delete” if not specified.

                                  • +

                                • label (str) – The label of the button, set to “Delete” if not specified.

                                @@ -368,8 +368,8 @@ async callback(interaction)[source]#

                                Delete the original message on button click.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -382,13 +382,13 @@

                                Bases: View

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

                                -
                                Parameters
                                +
                                Parameters:
                                  -

                                • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                                  • -

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

                                • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                                  • +

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

                                @@ -403,11 +403,11 @@ If Noneasync interaction_check(interaction)[source]#

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

                                -
                                Parameters
                                +
                                Parameters:

                                interaction (Interaction) – The interaction that occurred.

                                -
                                Return type
                                -

                                bool

                                +
                                Return type:
                                +

                                bool

                                @@ -417,8 +417,8 @@ If Noneasync on_timeout()[source]#

                                Remove the view from self.message if set.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                diff --git a/v8.2.1/output/botcore.utils.logging.html b/v8.2.1/output/botcore.utils.logging.html index b3087e95..54b61284 100644 --- a/v8.2.1/output/botcore.utils.logging.html +++ b/v8.2.1/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                • - main + main
                                • @@ -347,8 +347,8 @@
                                  class CustomLogger(name, level=0)[source]#
                                  -

                                  Bases: Logger

                                  -

                                  Custom implementation of the logging.Logger class with an added trace method.

                                  +

                                  Bases: Logger

                                  +

                                  Custom implementation of the logging.Logger class with an added trace method.

                                  trace(msg, *args, **kwargs)[source]#
                                  @@ -358,15 +358,15 @@
                                  -
                                  Parameters
                                  +
                                  Parameters:
                                    -

                                  • msg (str) – The message to be logged.

                                    • +

                                  • msg (str) – The message to be logged.

                                  • args – Passed to the base log function as is.

                                  • kwargs – Passed to the base log function as is.

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                  @@ -378,13 +378,13 @@ get_logger(name=None)[source]#

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

                                  -
                                  Parameters
                                  -

                                  name (Optional[str]) – The name given to the logger.

                                  +
                                  Parameters:
                                  +

                                  name (Optional[str]) – The name given to the logger.

                                  -
                                  Return type
                                  +
                                  Return type:

                                  CustomLogger

                                  -
                                  Returns
                                  +
                                  Returns:

                                  An instance of the CustomLogger class.

                                  diff --git a/v8.2.1/output/botcore.utils.members.html b/v8.2.1/output/botcore.utils.members.html index 7dd1838d..6aa2bf4f 100644 --- a/v8.2.1/output/botcore.utils.members.html +++ b/v8.2.1/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                  diff --git a/v8.2.1/output/botcore.utils.regex.html b/v8.2.1/output/botcore.utils.regex.html index 7ad84043..16eda090 100644 --- a/v8.2.1/output/botcore.utils.regex.html +++ b/v8.2.1/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                  • - main + main
                                  • @@ -352,7 +352,7 @@

                                    Warning

                                    This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                                    +such as urllib.parse.quote().

                                    diff --git a/v8.2.1/output/botcore.utils.scheduling.html b/v8.2.1/output/botcore.utils.scheduling.html index cbe949bd..0e722309 100644 --- a/v8.2.1/output/botcore.utils.scheduling.html +++ b/v8.2.1/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -204,7 +204,7 @@
                                    • - main + main
                                    • @@ -347,7 +347,7 @@
                                      class Scheduler(name)[source]#
                                      -

                                      Bases: object

                                      +

                                      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 instance’s log messages from other instances. Using the name of the class or module containing @@ -361,16 +361,16 @@ the same ID used to schedule it.

                                      __contains__(task_id)[source]#
                                      -

                                      Return True if a task with the given task_id is currently scheduled.

                                      +

                                      Return True if a task with the given task_id is currently scheduled.

                                      -
                                      Parameters
                                      -

                                      task_id (Hashable) – The task to look for.

                                      +
                                      Parameters:
                                      +

                                      task_id (Hashable) – The task to look for.

                                      -
                                      Return type
                                      -

                                      bool

                                      +
                                      Return type:
                                      +

                                      bool

                                      -
                                      Returns
                                      -

                                      True if the task was found.

                                      +
                                      Returns:
                                      +

                                      True if the task was found.

                                      @@ -380,8 +380,8 @@ the same ID used to schedule it.

                                      __init__(name)[source]#

                                      Initialize a new Scheduler instance.

                                      -
                                      Parameters
                                      -

                                      name (str) – The name of the Scheduler. Used in logging, and namespacing.

                                      +
                                      Parameters:
                                      +

                                      name (str) – The name of the Scheduler. Used in logging, and namespacing.

                                      @@ -391,11 +391,11 @@ the same ID used to schedule it.

                                      cancel(task_id)[source]#

                                      Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                                      -
                                      Parameters
                                      -

                                      task_id (Hashable) – The task’s unique ID.

                                      +
                                      Parameters:
                                      +

                                      task_id (Hashable) – The task’s unique ID.

                                      -
                                      Return type
                                      -

                                      None

                                      +
                                      Return type:
                                      +

                                      None

                                      @@ -405,8 +405,8 @@ the same ID used to schedule it.

                                      cancel_all()[source]#

                                      Unschedule all known tasks.

                                      -
                                      Return type
                                      -

                                      None

                                      +
                                      Return type:
                                      +

                                      None

                                      @@ -418,14 +418,14 @@ the same ID used to schedule it.

                                      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.

                                      -
                                      Parameters
                                      +
                                      Parameters:
                                        -

                                      • task_id (Hashable) – A unique ID to create the task with.

                                        • -

                                      • coroutine (Coroutine) – The function to be called.

                                        • +

                                      • task_id (Hashable) – A unique ID to create the task with.

                                        • +

                                      • coroutine (Coroutine) – The function to be called.

                                      -
                                      Return type
                                      -

                                      None

                                      +
                                      Return type:
                                      +

                                      None

                              @@ -440,15 +440,15 @@ If timeIf 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.

                              -
                              Parameters
                              +
                              Parameters:
                                -

                              • time (datetime) – The time to start the task.

                                • -

                              • task_id (Hashable) – A unique ID to create the task with.

                                • -

                              • coroutine (Coroutine) – The function to be called.

                                • +

                              • time (datetime) – The time to start the task.

                                • +

                              • task_id (Hashable) – A unique ID to create the task with.

                                • +

                              • coroutine (Coroutine) – The function to be called.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -460,15 +460,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

                              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.

                              -
                              Parameters
                              +
                              Parameters:
                                -

                              • delay (Union[int, float]) – How long to wait before starting the task.

                                • -

                              • task_id (Hashable) – A unique ID to create the task with.

                                • -

                              • coroutine (Coroutine) – The function to be called.

                                • +

                              • delay (Union[int, float]) – How long to wait before starting the task.

                                • +

                              • task_id (Hashable) – A unique ID to create the task with.

                                • +

                              • coroutine (Coroutine) – The function to be called.

                              -
                              Return type
                              -

                              None

                              +
                              Return type:
                              +

                              None

                              @@ -478,23 +478,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
                              create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
                              -

                              Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

                              +

                              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.

                              -
                              Parameters
                              +
                              Parameters:
                              -
                              Returns
                              +
                              Returns:

                              The wrapped task.

                              -
                              Return type
                              -

                              asyncio.Task

                              +
                              Return type:
                              +

                              asyncio.Task

                              diff --git a/v8.2.1/searchindex.js b/v8.2.1/searchindex.js index 42c593a9..1f9dbb99 100644 --- a/v8.2.1/searchindex.js +++ b/v8.2.1/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "2": [0, 3, 11], "1": [0, 12], "18th": 0, "septemb": 0, "2022": 0, "bug": 0, "138": 0, "bump": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0": [0, 8, 11, 12], "august": 0, "support": [0, 4, 7, 15], "125": 0, "stabl": 0, "releas": 0, "16th": 0, "124": 0, "updat": 0, "botcor": [0, 1, 2, 11], "util": [0, 1, 2, 3, 8, 11, 12], "regex": [0, 3, 7], "discord_invit": [0, 3, 7, 14], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "match": [0, 3], "lead": 0, "http": [0, 6, 14], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "www": 0, "27th": 0, "juli": 0, "break": 0, "110": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "rc2": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "add": [0, 3], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "7": 0, "5": 0, "23rd": 0, "featur": [0, 1, 3], "101": 0, "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "attr": 0, "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "bot_token": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Changelog": [[0, "changelog"]], "async_stats": [[4, "module-botcore.async_stats"]], "Exts": [[5, "module-botcore.exts"]], "site_api": [[6, "module-botcore.site_api"]], "Utils": [[7, "module-botcore.utils"]], "Submodules": [[7, "submodules"], [3, "submodules"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "channel": [[9, "module-botcore.utils.channel"]], "caching": [[8, "module-botcore.utils.caching"]], "members": [[13, "module-botcore.utils.members"]], "regex": [[14, "module-botcore.utils.regex"]], "interactions": [[11, "module-botcore.utils.interactions"]], "commands": [[10, "module-botcore.utils.commands"]], "logging": [[12, "module-botcore.utils.logging"]], "scheduling": [[15, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "2": [0, 3, 11], "1": [0, 12], "18th": 0, "septemb": 0, "2022": 0, "bug": 0, "138": 0, "bump": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 13, 14], "py": 0, "0": [0, 8, 11, 12], "august": 0, "support": [0, 4, 7, 15], "125": 0, "stabl": 0, "releas": 0, "16th": 0, "124": 0, "updat": 0, "botcor": [0, 1, 2, 11], "util": [0, 1, 2, 3, 8, 11, 12], "regex": [0, 3, 7], "discord_invit": [0, 3, 7, 14], "option": [0, 3, 4, 6, 8, 10, 11, 12, 13], "match": [0, 3], "lead": 0, "http": [0, 6, 14], "": [0, 1, 7, 8, 10, 11, 12, 14, 15], "www": 0, "27th": 0, "juli": 0, "break": 0, "110": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13], "rediscach": 0, "v1": 0, "rc2": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "add": [0, 3], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 15], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "python": [0, 1, 3, 15], "version": [0, 10], "3": 0, "10": 0, "7": 0, "5": 0, "23rd": 0, "featur": [0, 1, 3], "101": 0, "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 12, 15], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 12, 15], "attr": 0, "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 11], "On": 0, "view": [0, 11], "timeout": [0, 11], "thi": [0, 1, 3, 7, 9, 11, 13, 14, 15], "ha": [0, 7], "its": [0, 3], "remov": [0, 3, 11], "set": [0, 1, 3, 11], "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 11], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 12, 13, 14, 15], "wrong": 0, "delet": [0, 3, 6, 8, 11], "method": [0, 4, 6, 7, 12], "103": 0, "button": [0, 11], "attach": 0, "parent": [0, 11], "gener": [0, 3, 15], "onli": [0, 3], "allow": [0, 1, 3, 11], "specifi": [0, 11], "user": [0, 11], "role": [0, 1, 3, 11, 13], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 15], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 15], "creat": [0, 3, 4, 8, 15], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 12, 13, 15], "self": [0, 3, 11], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 13], "96": 0, "attempt": [0, 3, 9, 13], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 15], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15], "none": [0, 3, 4, 6, 7, 8, 10, 11, 12, 13, 15], "28th": 0, "93": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 15], "new": [0, 1, 4, 6, 8, 15], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 12], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 15], "out": [0, 1, 11], "10th": 0, "75": 0, "invit": [0, 14], "longer": [0, 11], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "url": [0, 3, 6], "safe": 0, "result": [0, 15], "refer": 0, "handl": [0, 13, 15], "captur": [0, 14], "all": [0, 1, 3, 4, 7, 15], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 14], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 13], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 15], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 11], "actual": 0, "now": [0, 1, 15], "25th": 0, "69": 0, "get": [0, 3, 6, 9, 13], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": 0, "main": 0, "don": [0, 15], "t": [0, 10, 15], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 15], "start": [0, 3, 15], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": 0, "task": [0, 3, 15], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 15], "manipul": 0, "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1], "help": [0, 1], "command": [0, 1, 3, 7, 9], "behaviour": 0, "broke": 0, "custom": [0, 8, 12], "pagin": 0, "also": [0, 7, 11], "basic": [0, 11], "forum": 0, "channel": [0, 3, 7], "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 15], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 12, 15], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 15], "event": [0, 3, 4, 15], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 11, 15], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 11, 12, 15], "abstract": 0, "lot": 0, "logic": 0, "share": 0, "between": [0, 1], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 13, 15], "trace": [0, 7, 12], "import": 0, "can": [0, 1, 11, 15], "function": [0, 3, 8, 9, 12, 13, 15], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 13], "wrapper": [0, 6, 15], "from": [0, 1, 3, 4, 6, 7, 9, 11, 13, 15], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 12, 14], "cach": [0, 3, 7, 9, 13], "logger": [0, 12], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 11, 12], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 14], "block": [0, 14], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 12], "your": 1, "ar": [1, 3, 8, 11, 14], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": 1, "pre": 1, "exist": [1, 15], "provid": [1, 8, 10, 15], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 11], "below": 1, "more": 1, "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 15], "you": [1, 9, 14], "ll": [1, 15], "write": 1, "might": 1, "mean": 1, "modifi": [1, 13], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 15], "vari": 1, "re": [1, 3, 15], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 15], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 11, 15], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7], "free": 1, "howev": 1, "like": 1, "m": 1, "docker": 1, "compos": 1, "d": 1, "configur": 1, "variabl": 1, "program": 1, "env": 1, "bot_token": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 11], "A": [1, 3, 6, 7, 8, 9, 11, 15], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 11, 15], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 15], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 12], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 12], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 12, 15], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "implement": [3, 4, 8, 11, 12], "initialis": [3, 8], "int": [3, 4, 8, 9, 11, 15], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 11, 12, 15], "server": [3, 14], "If": [3, 6, 11, 15], "given": [3, 4, 7, 9, 10, 12, 13, 15], "oper": [3, 15], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 15], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 11, 15], "instead": [3, 15], "connector": 3, "resolv": 3, "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 15], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 15], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 11, 14], "thei": 3, "name": [3, 7, 12, 15], "alia": [3, 7], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 15], "until": [3, 14], "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": 3, "second": [3, 11, 15], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 12, 15], "error": [3, 6, 7, 13], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "customlogg": [3, 7, 12], "get_logg": [3, 7, 12], "get_or_fetch_memb": [3, 7, 13], "formatted_code_regex": [3, 7, 14], "raw_code_regex": [3, 7, 14], "create_task": [3, 7, 15], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 14], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 15], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 13, 15], "django": 6, "initi": [6, 15], "authent": 6, "keyword": [6, 7, 12], "argument": [6, 7, 8, 10, 12, 13], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 12, 15], "send": [6, 11], "json": 6, "respons": 6, "bool": [6, 9, 11, 15], "whether": [6, 9], "rais": [6, 9, 10, 13, 15], "ok": 6, "ani": [6, 14, 15], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 15], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8], "group": [7, 14], "root_alias": 7, "two": 7, "sequenc": [7, 11], "act": 7, "top": 7, "level": [7, 12], "rather": 7, "than": 7, "being": [7, 13], "It": 7, "store": [7, 8], "attribut": 7, "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "callback": [7, 11], "interaction_check": [7, 11], "on_timeout": [7, 11], "__contains__": [7, 15], "cancel": [7, 15], "cancel_al": [7, 15], "schedule_at": [7, 15], "schedule_lat": [7, 15], "relat": [8, 12], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 13, 15], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 15], "offset": 8, "arg_offset": 8, "decor": 8, "posit": 8, "callabl": [8, 13], "wrap": [8, 15], "target": 8, "item": 8, "helper": [9, 13], "variou": 9, "channel_id": 9, "fetch": [9, 13], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 11], "repli": 10, "context": 10, "badargu": 10, "wasn": 10, "els": 10, "style": 11, "buttonstyl": 11, "secondari": 11, "label": 11, "click": 11, "itself": 11, "carri": 11, "done": [11, 15], "origin": 11, "allowed_us": 11, "180": 11, "moder": 11, "who": 11, "float": [11, 15], "last": 11, "ui": 11, "accept": 11, "input": 11, "similar": [11, 14], "after": [11, 15], "occur": 11, "msg": 12, "sever": 12, "exc_info": 12, "valu": 12, "houston": 12, "we": [12, 13], "interest": 12, "problem": 12, "mypi": 12, "recognis": 12, "interactin": 13, "member_id": 13, "failur": 13, "indic": 13, "could": 13, "found": [13, 15], "coro": [13, 15], "sole": 13, "expect": 13, "add_rol": 13, "remove_rol": 13, "purpos": 13, "intend": 13, "regular": 14, "express": 14, "pattern": 14, "pleas": 14, "sanitis": 14, "output": 14, "someth": 14, "urllib": 14, "pars": 14, "quot": 14, "format": 14, "raw": 14, "execut": 15, "keep": 15, "track": 15, "must": 15, "distinguish": 15, "suggest": 15, "immedi": 15, "futur": 15, "uniqu": 15, "prematur": 15, "same": 15, "current": 15, "task_id": 15, "hashabl": 15, "look": 15, "unschedul": 15, "identifi": 15, "warn": 15, "doesn": 15, "known": 15, "alreadi": 15, "prevent": 15, "unawait": 15, "elsewher": 15, "timezon": 15, "awar": 15, "calcul": 15, "subtract": 15, "na\u00efv": 15, "utc": 15, "past": 15, "datetim": 15, "delai": 15, "union": 15, "long": 15, "suppressed_except": 15, "event_loop": 15, "otherwis": 15, "typevar": 15, "task_return": 15, "tupl": 15}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "interactions"], [12, 0, 0, "-", "logging"], [13, 0, 0, "-", "members"], [14, 0, 0, "-", "regex"], [15, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.interactions": [[11, 1, 1, "", "DeleteMessageButton"], [11, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "interaction_check"], [11, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[12, 1, 1, "", "CustomLogger"], [12, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[12, 2, 1, "", "trace"]], "botcore.utils.members": [[13, 4, 1, "", "get_or_fetch_member"], [13, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[14, 5, 1, "", "DISCORD_INVITE"], [14, 5, 1, "", "FORMATTED_CODE_REGEX"], [14, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[15, 1, 1, "", "Scheduler"], [15, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[15, 2, 1, "", "__contains__"], [15, 2, 1, "", "__init__"], [15, 2, 1, "", "cancel"], [15, 2, 1, "", "cancel_all"], [15, 2, 1, "", "schedule"], [15, 2, 1, "", "schedule_at"], [15, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "interact": 11, "log": 12, "member": 13, "regex": 14, "schedul": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Exts": [[5, "module-botcore.exts"]], "async_stats": [[4, "module-botcore.async_stats"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Submodules": [[3, "submodules"], [7, "submodules"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Utils": [[7, "module-botcore.utils"]], "site_api": [[6, "module-botcore.site_api"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Changelog": [[0, "changelog"]], "commands": [[10, "module-botcore.utils.commands"]], "scheduling": [[15, "module-botcore.utils.scheduling"]], "members": [[13, "module-botcore.utils.members"]], "interactions": [[11, "module-botcore.utils.interactions"]], "channel": [[9, "module-botcore.utils.channel"]], "caching": [[8, "module-botcore.utils.caching"]], "regex": [[14, "module-botcore.utils.regex"]], "logging": [[12, "module-botcore.utils.logging"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.interactions"], [12, "module-botcore.utils.logging"], [13, "module-botcore.utils.members"], [14, "module-botcore.utils.regex"], [15, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "deletemessagebutton (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[11, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[11, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[11, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[12, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[12, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[12, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[12, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[13, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[13, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[13, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[14, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[14, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[14, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[15, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[15, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[15, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file diff --git a/v8.3.0-beta/.buildinfo b/v8.3.0-beta/.buildinfo index 39f8d450..55274155 100644 --- a/v8.3.0-beta/.buildinfo +++ b/v8.3.0-beta/.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: b6ab54bd5dd036dc9635c76f642f8e19 +config: d6b95ed0cb07ac4ea57d47dbb1d01131 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v8.3.0-beta/_static/basic.css b/v8.3.0-beta/_static/basic.css index eeb0519a..4e9a9f1f 100644 --- a/v8.3.0-beta/_static/basic.css +++ b/v8.3.0-beta/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/v8.3.0-beta/_static/debug.css b/v8.3.0-beta/_static/debug.css index 3264805c..74d4aec3 100644 --- a/v8.3.0-beta/_static/debug.css +++ b/v8.3.0-beta/_static/debug.css @@ -64,6 +64,6 @@ body { .sb-footer__inner { background: salmon; } -[role="main"] { +.sb-article { background: white; } diff --git a/v8.3.0-beta/_static/pygments.css b/v8.3.0-beta/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v8.3.0-beta/_static/pygments.css +++ b/v8.3.0-beta/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v8.3.0-beta/_static/skeleton.css b/v8.3.0-beta/_static/skeleton.css index 01231167..467c878c 100644 --- a/v8.3.0-beta/_static/skeleton.css +++ b/v8.3.0-beta/_static/skeleton.css @@ -143,19 +143,19 @@ article { .sb-article-container, .sb-footer-content__inner, -.drop-secondary-sidebar-for-full-width-content [role="main"], +.drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 100vw; } -[role="main"], +.sb-article, .match-content-width { padding: 0 1rem; box-sizing: border-box; } @media (min-width: 32rem) { - [role="main"], + .sb-article, .match-content-width { padding: 0 2rem; } @@ -167,33 +167,33 @@ article { width: auto; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 42rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 46rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 46rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 50rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 50rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -208,33 +208,33 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } } @media (min-width: 63rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } - [role="main"], + .sb-article, .match-content-width { width: 46rem; } } @media (min-width: 67rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } - [role="main"], + .sb-article, .match-content-width { width: 50rem; } @@ -249,11 +249,11 @@ article { display: none !important; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 59rem; } - [role="main"], + .sb-article, .match-content-width { width: 42rem; } @@ -261,24 +261,24 @@ article { /* Full desktop views */ @media (min-width: 80rem) { - [role="main"], + .sb-article, .match-content-width { width: 46rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 63rem; } } @media (min-width: 84rem) { - [role="main"], + .sb-article, .match-content-width { width: 50rem; } .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } @@ -286,7 +286,7 @@ article { @media (min-width: 88rem) { .sb-footer-content__inner, - .drop-secondary-sidebar-for-full-width-content [role="main"], + .drop-secondary-sidebar-for-full-width-content .sb-article, .drop-secondary-sidebar-for-full-width-content .match-content-width { width: 67rem; } diff --git a/v8.3.0-beta/changelog.html b/v8.3.0-beta/changelog.html index ffe28525..393ba1ba 100644 --- a/v8.3.0-beta/changelog.html +++ b/v8.3.0-beta/changelog.html @@ -2,7 +2,7 @@ - + diff --git a/v8.3.0-beta/development.html b/v8.3.0-beta/development.html index 5a537f3a..b2a4a1c0 100644 --- a/v8.3.0-beta/development.html +++ b/v8.3.0-beta/development.html @@ -2,7 +2,7 @@ - + diff --git a/v8.3.0-beta/index.html b/v8.3.0-beta/index.html index c0380a50..34af6b71 100644 --- a/v8.3.0-beta/index.html +++ b/v8.3.0-beta/index.html @@ -2,7 +2,7 @@ - + diff --git a/v8.3.0-beta/output/botcore.async_stats.html b/v8.3.0-beta/output/botcore.async_stats.html index ab1931d5..9b0dec2b 100644 --- a/v8.3.0-beta/output/botcore.async_stats.html +++ b/v8.3.0-beta/output/botcore.async_stats.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                              • - main + main
                              • @@ -356,13 +356,13 @@ __init__(loop, host='localhost', port=8125, prefix=None)[source]#

                                Create a new AsyncStatsClient.

                                -
                                Parameters
                                +
                                Parameters:
                                @@ -371,10 +371,10 @@
                                async create_socket()[source]#
                                -

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

                                +

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

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                diff --git a/v8.3.0-beta/output/botcore.exts.html b/v8.3.0-beta/output/botcore.exts.html index c8596b23..42857469 100644 --- a/v8.3.0-beta/output/botcore.exts.html +++ b/v8.3.0-beta/output/botcore.exts.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                • - main + main
                                • diff --git a/v8.3.0-beta/output/botcore.html b/v8.3.0-beta/output/botcore.html index 72fcce42..f9d8b94a 100644 --- a/v8.3.0-beta/output/botcore.html +++ b/v8.3.0-beta/output/botcore.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                  • - main + main
                                  • @@ -356,14 +356,14 @@ __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
                                    +
                                    Parameters:
                                    @@ -375,8 +375,8 @@ a dummy statsd client will be created.

                                    • async add_cog(cog)[source]#

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

                                    -
                                    Return type
                                    -

                                    None

                                    +
                                    Return type:
                                    +

                                    None

                                    @@ -386,8 +386,8 @@ a dummy statsd client will be created.

                                    add_command(command)[source]#

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

                                    -
                                    Return type
                                    -

                                    None

                                    +
                                    Return type:
                                    +

                                    None

                                    @@ -397,8 +397,8 @@ a dummy statsd client will be created.

                                    clear()[source]#

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

                                    -
                                    Return type
                                    -

                                    None

                                    +
                                    Return type:
                                    +

                                    None

                                    @@ -408,8 +408,8 @@ a dummy statsd client will be created.

                                    async close()[source]#

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

                                    -
                                    Return type
                                    -

                                    None

                                    +
                                    Return type:
                                    +

                                    None

                                    @@ -420,8 +420,8 @@ a dummy statsd client will be created.

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

                                    This should be ran in a task on the event loop to avoid deadlocks caused by wait_for calls.

                                    -
                                    Return type
                                    -

                                    None

                                    +
                                    Return type:
                                    +

                                    None

                                    @@ -431,8 +431,8 @@ a dummy statsd client will be created.

                                    async log_to_dev_log(message)[source]#

                                    Log the given message to #dev-log.

                                    -
                                    Return type
                                    -

                                    None

                                    +
                                    Return type:
                                    +

                                    None

                                    @@ -444,8 +444,8 @@ a dummy statsd client will be created.

                                    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.

                                    -
                                    Return type
                                    -

                                    None

                                    +
                                    Return type:
                                    +

                                    None

                                @@ -455,8 +455,8 @@ will not be set and guild_available_but_cache_empty event will be e async on_guild_unavailable(guild)[source]#

                                Clear the internal guild available event when self.guild_id becomes unavailable.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -466,8 +466,8 @@ will not be set and guild_available_but_cache_empty event will be e async ping_services()[source]#

                                Ping all required services on setup to ensure they are up before starting.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -479,8 +479,8 @@ will not be set and guild_available_but_cache_empty event will be e

                                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
                                -

                                Optional[Command]

                                +
                                Return type:
                                +

                                Optional[Command]

                                @@ -493,8 +493,8 @@ To remove them, either remove the entire command or manually edit bot.all_ AsyncStatsClient.create_socket and ping_services().

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -506,8 +506,8 @@ and -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

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

                                Bases: Exception

                                +

                                Bases: Exception

                                Exception class for startup errors.

                                diff --git a/v8.3.0-beta/output/botcore.site_api.html b/v8.3.0-beta/output/botcore.site_api.html index e56e1e39..252e487c 100644 --- a/v8.3.0-beta/output/botcore.site_api.html +++ b/v8.3.0-beta/output/botcore.site_api.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                • - main + main
                                • @@ -349,17 +349,17 @@
                                  class APIClient(site_api_url, site_api_token, **session_kwargs)[source]#
                                  -

                                  Bases: object

                                  +

                                  Bases: object

                                  A wrapper for the Django Site API.

                                  __init__(site_api_url, site_api_token, **session_kwargs)[source]#

                                  Initialize a new APIClient instance.

                                  -
                                  Parameters
                                  +
                                  Parameters:
                                    -

                                  • site_api_url (str) – The URL of the site API.

                                    • -

                                  • site_api_token (str) – The token to use for authentication.

                                    • +

                                  • site_api_url (str) – The URL of the site API.

                                    • +

                                  • site_api_token (str) – The token to use for authentication.

                                  • session_kwargs – Keyword arguments to pass to the aiohttp.ClientSession constructor.

                                  @@ -371,8 +371,8 @@ async close()[source]#

                                Close the aiohttp session.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -382,17 +382,17 @@ async delete(endpoint, *, raise_for_status=True, **kwargs)[source]#

                                Send a DELETE request to the site API and return the JSON response.

                                -
                                Parameters
                                +
                                Parameters:
                                  -

                                • endpoint (str) – The endpoint to send the request to.

                                  • -

                                • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                                  • +

                                • endpoint (str) – The endpoint to send the request to.

                                  • +

                                • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                                • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                                -
                                Return type
                                -

                                Optional[dict]

                                +
                                Return type:
                                +

                                Optional[dict]

                                -
                                Returns
                                +
                                Returns:

                                The JSON response the API returns, or None if the response is 204 No Content.

                                @@ -403,8 +403,8 @@ async get(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                                -
                                Return type
                                -

                                dict

                                +
                                Return type:
                                +

                                dict

                                @@ -414,17 +414,17 @@ async static maybe_raise_for_status(response, should_raise)[source]#

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

                                -
                                Parameters
                                +
                                Parameters:

                                • response (aiohttp.ClientResponse) – The response to check.

                                  • -

                                • should_raise (bool) – Whether or not to raise an exception.

                                  • +

                                • should_raise (bool) – Whether or not to raise an exception.

                                -
                                Raises
                                +
                                Raises:

                                ResponseCodeError – If the response is not OK and should_raise is True.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -434,8 +434,8 @@ async patch(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                                -
                                Return type
                                -

                                dict

                                +
                                Return type:
                                +

                                dict

                                @@ -445,8 +445,8 @@ async post(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                                -
                                Return type
                                -

                                dict

                                +
                                Return type:
                                +

                                dict

                                @@ -456,8 +456,8 @@ async put(endpoint, *, raise_for_status=True, **kwargs)[source]#

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

                                -
                                Return type
                                -

                                dict

                                +
                                Return type:
                                +

                                dict

                                @@ -467,21 +467,21 @@ async request(method, endpoint, *, raise_for_status=True, **kwargs)[source]#

                                Send an HTTP request to the site API and return the JSON response.

                                -
                                Parameters
                                +
                                Parameters:
                                  -

                                • method (str) – The HTTP method to use.

                                  • -

                                • endpoint (str) – The endpoint to send the request to.

                                  • -

                                • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                                  • +

                                • method (str) – The HTTP method to use.

                                  • +

                                • endpoint (str) – The endpoint to send the request to.

                                  • +

                                • raise_for_status (bool) – Whether or not to raise an exception if the response is not OK.

                                • **kwargs – Any extra keyword arguments to pass to aiohttp.request().

                                -
                                Return type
                                -

                                dict

                                +
                                Return type:
                                +

                                dict

                                -
                                Returns
                                +
                                Returns:

                                The JSON response the API returns.

                                -
                                Raises
                                +
                                Raises:

                                ResponseCodeError – If the response is not OK and raise_for_status is True.

                                @@ -492,18 +492,18 @@
                                exception ResponseCodeError(response, response_json=None, response_text=None)[source]#
                                -

                                Bases: ValueError

                                +

                                Bases: ValueError

                                Raised in APIClient.request() when a non-OK HTTP response is received.

                                __init__(response, response_json=None, response_text=None)[source]#

                                Initialize a new ResponseCodeError instance.

                                -
                                Parameters
                                +
                                Parameters:

                                • response (aiohttp.ClientResponse) – The response object from the request.

                                  • -

                                • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                                  • -

                                • response_text (Optional[str]) – The text of the request, if any.

                                  • +

                                • response_json (Optional[dict]) – The JSON response returned from the request, if any.

                                  • +

                                • response_text (Optional[str]) – The text of the request, if any.

                                diff --git a/v8.3.0-beta/output/botcore.utils.caching.html b/v8.3.0-beta/output/botcore.utils.caching.html index 2224906a..f67b1b94 100644 --- a/v8.3.0-beta/output/botcore.utils.caching.html +++ b/v8.3.0-beta/output/botcore.utils.caching.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                • - main + main
                                • @@ -349,7 +349,7 @@
                                  class AsyncCache(max_size=128)[source]#
                                  -

                                  Bases: object

                                  +

                                  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.

                                  @@ -358,13 +358,13 @@ __call__(arg_offset=0)[source]#

                                  Decorator for async cache.

                                  -
                                  Parameters
                                  -

                                  arg_offset (int) – The offset for the position of the key argument.

                                  +
                                  Parameters:
                                  +

                                  arg_offset (int) – The offset for the position of the key argument.

                                  -
                                  Return type
                                  -

                                  Callable

                                  +
                                  Return type:
                                  +

                                  Callable

                                  -
                                  Returns
                                  +
                                  Returns:

                                  A decorator to wrap the target function.

                                  @@ -375,8 +375,8 @@ __init__(max_size=128)[source]#

                                  Initialise a new AsyncCache instance.

                                  -
                                  Parameters
                                  -

                                  max_size (int) – How many items to store in the cache.

                                  +
                                  Parameters:
                                  +

                                  max_size (int) – How many items to store in the cache.

                                  @@ -386,8 +386,8 @@ clear()[source]#

                                  Clear cache instance.

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                diff --git a/v8.3.0-beta/output/botcore.utils.channel.html b/v8.3.0-beta/output/botcore.utils.channel.html index 95a6ee23..b23c9012 100644 --- a/v8.3.0-beta/output/botcore.utils.channel.html +++ b/v8.3.0-beta/output/botcore.utils.channel.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                • - main + main
                                • @@ -351,13 +351,13 @@ 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
                                  +
                                  Parameters:

                                  • bot (Bot) – The discord.ext.commands.Bot instance to use for getting/fetching.

                                    • -

                                  • channel_id (int) – The channel to get/fetch.

                                    • +

                                  • channel_id (int) – The channel to get/fetch.

                                  -
                                  Raises
                                  +
                                  Raises:
                                  -
                                  Return type
                                  +
                                  Return type:

                                  GuildChannel

                                  -
                                  Returns
                                  +
                                  Returns:

                                  The channel from the ID.

                                  @@ -379,16 +379,16 @@ is_in_category(channel, category_id)[source]#

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

                                  -
                                  Parameters
                                  +
                                  Parameters:

                                  • channel (TextChannel) – The channel to check.

                                    • -

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

                                    • +

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

                                  -
                                  Return type
                                  -

                                  bool

                                  +
                                  Return type:
                                  +

                                  bool

                                  -
                                  Returns
                                  +
                                  Returns:

                                  A bool depending on whether the channel is in the category.

                                  diff --git a/v8.3.0-beta/output/botcore.utils.commands.html b/v8.3.0-beta/output/botcore.utils.commands.html index 419b30cb..86bc266b 100644 --- a/v8.3.0-beta/output/botcore.utils.commands.html +++ b/v8.3.0-beta/output/botcore.utils.commands.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                  • - main + main
                                  • @@ -350,19 +350,19 @@ async clean_text_or_reply(ctx, text=None)[source]#

                                    Cleans a text argument or replied message’s content.

                                    -
                                    Parameters
                                    +
                                    Parameters:

                                    • ctx (Context) – The command’s context

                                      • -

                                    • text (Optional[str]) – The provided text argument of the command (if given)

                                      • +

                                    • text (Optional[str]) – The provided text argument of the command (if given)

                                    -
                                    Raises
                                    +
                                    Raises:

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

                                    -
                                    Return type
                                    -

                                    str

                                    +
                                    Return type:
                                    +

                                    str

                                    -
                                    Returns
                                    +
                                    Returns:

                                    The cleaned version of text, if given, else replied message.

                                    diff --git a/v8.3.0-beta/output/botcore.utils.cooldown.html b/v8.3.0-beta/output/botcore.utils.cooldown.html index 243281db..d2ab7321 100644 --- a/v8.3.0-beta/output/botcore.utils.cooldown.html +++ b/v8.3.0-beta/output/botcore.utils.cooldown.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                    • - main + main
                                    • @@ -349,7 +349,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.

                                      @@ -361,10 +361,10 @@ async call_without_cooldown()[source]#

                                      Run the command this cooldown blocked.

                                      -
                                      Return type
                                      -

                                      TypeVar(R)

                                      +
                                      Return type:
                                      +

                                      TypeVar(R)

                                      -
                                      Returns
                                      +
                                      Returns:

                                      The command’s return value.

                                      @@ -390,18 +390,18 @@ 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
                                      +
                                      Parameters:
                                        -

                                      • cooldown_duration (float) – Length of the cooldown in seconds.

                                        • -

                                      • send_notice (bool) – If True, notify the user about the cooldown with a reply.

                                        • -

                                      • args_preprocessor (Optional[Callable[ParamSpec(P), Iterable[object]]]) – If specified, this function is called with the args and kwargs the function is called with, +

                                      • cooldown_duration (float) – Length of the cooldown in seconds.

                                        • +

                                      • send_notice (bool) – If True, notify the user about the cooldown with a reply.

                                        • +

                                      • args_preprocessor (Optional[Callable[ParamSpec(P), Iterable[object]]]) – If specified, this function is called with the args and kwargs the function is called with, its return value is then used to check for the cooldown instead of the raw arguments.

                                      -
                                      Return type
                                      -

                                      Callable[Callable[ParamSpec(P), Awaitable[TypeVar(R)]], Callable[ParamSpec(P), Awaitable[TypeVar(R)]]]

                                      +
                                      Return type:
                                      +

                                      Callable[Callable[ParamSpec(P), Awaitable[TypeVar(R)]], Callable[ParamSpec(P), Awaitable[TypeVar(R)]]]

                                      -
                                      Returns
                                      +
                                      Returns:

                                      A decorator that adds a wrapper which applies the cooldowns.

                                      diff --git a/v8.3.0-beta/output/botcore.utils.function.html b/v8.3.0-beta/output/botcore.utils.function.html index d17e2fa9..7fab5f2c 100644 --- a/v8.3.0-beta/output/botcore.utils.function.html +++ b/v8.3.0-beta/output/botcore.utils.function.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                      • - main + main
                                      • @@ -349,7 +349,7 @@
                                        exception GlobalNameConflictError[source]#
                                        -

                                        Bases: Exception

                                        +

                                        Bases: Exception

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

                                        @@ -359,19 +359,19 @@

                                        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.

                                        -
                                        Parameters
                                        +
                                        Parameters:
                                          -

                                        • wrapped (Callable[ParamSpec(_P), TypeVar(_R)]) – The function to wrap with.

                                          • -

                                        • assigned (Sequence[str]) – Sequence of attribute names that are directly assigned from wrapped to wrapper.

                                          • -

                                        • updated (Sequence[str]) – Sequence of attribute names that are .update``d on ``wrapper from the attributes on wrapped.

                                          • -

                                        • ignored_conflict_names (Set[str]) – A set of names to ignore if a conflict between them is found.

                                          • +

                                        • wrapped (Callable[ParamSpec(_P), TypeVar(_R)]) – The function to wrap with.

                                          • +

                                        • assigned (Sequence[str]) – Sequence of attribute names that are directly assigned from wrapped to wrapper.

                                          • +

                                        • updated (Sequence[str]) – Sequence of attribute names that are .update``d on ``wrapper from the attributes on wrapped.

                                          • +

                                        • ignored_conflict_names (Set[str]) – A set of names to ignore if a conflict between them is found.

                                        -
                                        Return type
                                        -

                                        Callable[Callable[ParamSpec(_P), TypeVar(_R)], Callable[ParamSpec(_P), TypeVar(_R)]]

                                        +
                                        Return type:
                                        +

                                        Callable[Callable[ParamSpec(_P), TypeVar(_R)], Callable[ParamSpec(_P), TypeVar(_R)]]

                                        -
                                        Returns
                                        -

                                        A decorator that behaves like functools.wraps(), +

                                        Returns:
                                        +

                                        A decorator that behaves like functools.wraps(), with the wrapper replaced with the function update_wrapper_globals() returned.

                                        @@ -390,19 +390,19 @@ their own globals.

                                        changes won’t be reflected in the new function’s globals.

                                        -
                                        Parameters
                                        +
                                        Parameters:
                                        -
                                        Raises
                                        +
                                        Raises:

                                        GlobalNameConflictError – If wrapper and wrapped share a global name that’s also used in wrapped's typehints, and is not in ignored_conflict_names.

                                        -
                                        Return type
                                        -

                                        Callable[ParamSpec(_P), TypeVar(_R)]

                                        +
                                        Return type:
                                        +

                                        Callable[ParamSpec(_P), TypeVar(_R)]

                                      diff --git a/v8.3.0-beta/output/botcore.utils.html b/v8.3.0-beta/output/botcore.utils.html index 7d51ad85..5a8c9d02 100644 --- a/v8.3.0-beta/output/botcore.utils.html +++ b/v8.3.0-beta/output/botcore.utils.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                      • - main + main
                                      • @@ -359,8 +359,8 @@ that will act as top-level groups rather than being aliases of the command’s g
                                      -
                                      Return type
                                      -

                                      None

                                      +
                                      Return type:
                                      +

                                      None

                                @@ -370,13 +370,13 @@ that will act as top-level groups rather than being aliases of the command’s g unqualify(name)[source]#

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

                                -
                                Parameters
                                -

                                name (str) – The module name to unqualify.

                                +
                                Parameters:
                                +

                                name (str) – The module name to unqualify.

                                -
                                Return type
                                -

                                str

                                +
                                Return type:
                                +

                                str

                                -
                                Returns
                                +
                                Returns:

                                The unqualified module name.

                                diff --git a/v8.3.0-beta/output/botcore.utils.interactions.html b/v8.3.0-beta/output/botcore.utils.interactions.html index 80c52f34..76fec3e7 100644 --- a/v8.3.0-beta/output/botcore.utils.interactions.html +++ b/v8.3.0-beta/output/botcore.utils.interactions.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                • - main + main
                                • @@ -353,10 +353,10 @@

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

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

                                  -
                                  Parameters
                                  +
                                  Parameters:

                                  • style (ButtonStyle) – The style of the button, set to ButtonStyle.secondary if not specified.

                                    • -

                                  • label (str) – The label of the button, set to “Delete” if not specified.

                                    • +

                                  • label (str) – The label of the button, set to “Delete” if not specified.

                                  @@ -370,8 +370,8 @@ async callback(interaction)[source]#

                                  Delete the original message on button click.

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                  @@ -384,13 +384,13 @@

                                  Bases: View

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

                                  -
                                  Parameters
                                  +
                                  Parameters:
                                    -

                                  • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                                    • -

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

                                  • allowed_users (Sequence[int]) – A sequence of user’s ids who are allowed to interact with the view.

                                    • +

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

                                  @@ -405,11 +405,11 @@ If Noneasync interaction_check(interaction)[source]#

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

                                  -
                                  Parameters
                                  +
                                  Parameters:

                                  interaction (Interaction) – The interaction that occurred.

                                  -
                                  Return type
                                  -

                                  bool

                                  +
                                  Return type:
                                  +

                                  bool

                                  @@ -419,8 +419,8 @@ If Noneasync on_timeout()[source]#

                                  Remove the view from self.message if set.

                                  -
                                  Return type
                                  -

                                  None

                                  +
                                  Return type:
                                  +

                                  None

                                  diff --git a/v8.3.0-beta/output/botcore.utils.logging.html b/v8.3.0-beta/output/botcore.utils.logging.html index 06e253db..fecb5f83 100644 --- a/v8.3.0-beta/output/botcore.utils.logging.html +++ b/v8.3.0-beta/output/botcore.utils.logging.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                  • - main + main
                                  • @@ -349,8 +349,8 @@
                                    class CustomLogger(name, level=0)[source]#
                                    -

                                    Bases: Logger

                                    -

                                    Custom implementation of the logging.Logger class with an added trace method.

                                    +

                                    Bases: Logger

                                    +

                                    Custom implementation of the logging.Logger class with an added trace method.

                                    trace(msg, *args, **kwargs)[source]#
                                    @@ -360,15 +360,15 @@
                                    -
                                    Parameters
                                    +
                                    Parameters:
                                      -

                                    • msg (str) – The message to be logged.

                                      • +

                                    • msg (str) – The message to be logged.

                                    • args – Passed to the base log function as is.

                                    • kwargs – Passed to the base log function as is.

                                    -
                                    Return type
                                    -

                                    None

                                    +
                                    Return type:
                                    +

                                    None

                                    @@ -380,13 +380,13 @@ get_logger(name=None)[source]#

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

                                    -
                                    Parameters
                                    -

                                    name (Optional[str]) – The name given to the logger.

                                    +
                                    Parameters:
                                    +

                                    name (Optional[str]) – The name given to the logger.

                                    -
                                    Return type
                                    +
                                    Return type:

                                    CustomLogger

                                    -
                                    Returns
                                    +
                                    Returns:

                                    An instance of the CustomLogger class.

                                    diff --git a/v8.3.0-beta/output/botcore.utils.members.html b/v8.3.0-beta/output/botcore.utils.members.html index 7ae4e930..23ef3f9a 100644 --- a/v8.3.0-beta/output/botcore.utils.members.html +++ b/v8.3.0-beta/output/botcore.utils.members.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                    diff --git a/v8.3.0-beta/output/botcore.utils.regex.html b/v8.3.0-beta/output/botcore.utils.regex.html index 4530c6f3..98361520 100644 --- a/v8.3.0-beta/output/botcore.utils.regex.html +++ b/v8.3.0-beta/output/botcore.utils.regex.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                    • - main + main
                                    • @@ -354,7 +354,7 @@

                                      Warning

                                      This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as urllib.parse.quote().

                                      +such as urllib.parse.quote().

                                      diff --git a/v8.3.0-beta/output/botcore.utils.scheduling.html b/v8.3.0-beta/output/botcore.utils.scheduling.html index 585d35db..e5284305 100644 --- a/v8.3.0-beta/output/botcore.utils.scheduling.html +++ b/v8.3.0-beta/output/botcore.utils.scheduling.html @@ -2,7 +2,7 @@ - + @@ -206,7 +206,7 @@
                                      • - main + main
                                      • @@ -349,7 +349,7 @@
                                        class Scheduler(name)[source]#
                                        -

                                        Bases: object

                                        +

                                        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 instance’s log messages from other instances. Using the name of the class or module containing @@ -363,16 +363,16 @@ the same ID used to schedule it.

                                        __contains__(task_id)[source]#
                                        -

                                        Return True if a task with the given task_id is currently scheduled.

                                        +

                                        Return True if a task with the given task_id is currently scheduled.

                                        -
                                        Parameters
                                        -

                                        task_id (Hashable) – The task to look for.

                                        +
                                        Parameters:
                                        +

                                        task_id (Hashable) – The task to look for.

                                        -
                                        Return type
                                        -

                                        bool

                                        +
                                        Return type:
                                        +

                                        bool

                                        -
                                        Returns
                                        -

                                        True if the task was found.

                                        +
                                        Returns:
                                        +

                                        True if the task was found.

                                        @@ -382,8 +382,8 @@ the same ID used to schedule it.

                                        __init__(name)[source]#

                                        Initialize a new Scheduler instance.

                                        -
                                        Parameters
                                        -

                                        name (str) – The name of the Scheduler. Used in logging, and namespacing.

                                        +
                                        Parameters:
                                        +

                                        name (str) – The name of the Scheduler. Used in logging, and namespacing.

                                        @@ -393,11 +393,11 @@ the same ID used to schedule it.

                                        cancel(task_id)[source]#

                                        Unschedule the task identified by task_id. Log a warning if the task doesn’t exist.

                                        -
                                        Parameters
                                        -

                                        task_id (Hashable) – The task’s unique ID.

                                        +
                                        Parameters:
                                        +

                                        task_id (Hashable) – The task’s unique ID.

                                        -
                                        Return type
                                        -

                                        None

                                        +
                                        Return type:
                                        +

                                        None

                                        @@ -407,8 +407,8 @@ the same ID used to schedule it.

                                        cancel_all()[source]#

                                        Unschedule all known tasks.

                                        -
                                        Return type
                                        -

                                        None

                                        +
                                        Return type:
                                        +

                                        None

                                        @@ -420,14 +420,14 @@ the same ID used to schedule it.

                                        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.

                                        -
                                        Parameters
                                        +
                                        Parameters:
                                          -

                                        • task_id (Hashable) – A unique ID to create the task with.

                                          • -

                                        • coroutine (Coroutine) – The function to be called.

                                          • +

                                        • task_id (Hashable) – A unique ID to create the task with.

                                          • +

                                        • coroutine (Coroutine) – The function to be called.

                                        -
                                        Return type
                                        -

                                        None

                                        +
                                        Return type:
                                        +

                                        None

                                @@ -442,15 +442,15 @@ If timeIf 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.

                                -
                                Parameters
                                +
                                Parameters:
                                  -

                                • time (datetime) – The time to start the task.

                                  • -

                                • task_id (Hashable) – A unique ID to create the task with.

                                  • -

                                • coroutine (Coroutine) – The function to be called.

                                  • +

                                • time (datetime) – The time to start the task.

                                  • +

                                • task_id (Hashable) – A unique ID to create the task with.

                                  • +

                                • coroutine (Coroutine) – The function to be called.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -462,15 +462,15 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-

                                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.

                                -
                                Parameters
                                +
                                Parameters:
                                  -

                                • delay (Union[int, float]) – How long to wait before starting the task.

                                  • -

                                • task_id (Hashable) – A unique ID to create the task with.

                                  • -

                                • coroutine (Coroutine) – The function to be called.

                                  • +

                                • delay (Union[int, float]) – How long to wait before starting the task.

                                  • +

                                • task_id (Hashable) – A unique ID to create the task with.

                                  • +

                                • coroutine (Coroutine) – The function to be called.

                                -
                                Return type
                                -

                                None

                                +
                                Return type:
                                +

                                None

                                @@ -480,23 +480,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-
                                create_task(coro, *, suppressed_exceptions=(), event_loop=None, **kwargs)[source]#
                                -

                                Wrapper for creating an asyncio.Task which logs exceptions raised in the task.

                                +

                                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.

                                -
                                Parameters
                                +
                                Parameters:
                                -
                                Returns
                                +
                                Returns:

                                The wrapped task.

                                -
                                Return type
                                -

                                asyncio.Task

                                +
                                Return type:
                                +

                                asyncio.Task

                                diff --git a/v8.3.0-beta/searchindex.js b/v8.3.0-beta/searchindex.js index 9b4eaf03..7785ebd1 100644 --- a/v8.3.0-beta/searchindex.js +++ b/v8.3.0-beta/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.cooldown", "output/botcore.utils.function", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.cooldown.rst", "output/botcore.utils.function.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "cooldown", "function", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "3": 0, "0": [0, 8, 13, 14], "25th": 0, "octob": 0, "2022": 0, "featur": [0, 1, 3], "88": 0, "add": [0, 3, 11], "decor": [0, 8, 11, 12], "stop": 0, "success": 0, "duplic": [0, 11], "invoc": [0, 11], "command": [0, 1, 3, 7, 9, 11, 12], "support": [0, 4, 7, 17], "151": 0, "python": [0, 1, 3, 17], "11": 0, "2": [0, 3, 13], "1": [0, 14], "18th": 0, "septemb": 0, "bug": 0, "138": 0, "bump": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 12, 15, 16], "py": [0, 12], "august": 0, "125": 0, "stabl": 0, "releas": 0, "16th": 0, "124": 0, "updat": [0, 12], "botcor": [0, 1, 2, 13], "util": [0, 1, 2, 3, 8, 12, 13, 14], "regex": [0, 3, 7], "discord_invit": [0, 3, 7, 16], "option": [0, 3, 4, 6, 8, 10, 11, 13, 14, 15], "match": [0, 3], "lead": 0, "http": [0, 6, 16], "": [0, 1, 7, 8, 10, 11, 12, 13, 14, 16, 17], "www": 0, "27th": 0, "juli": 0, "break": [0, 12], "110": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15], "rediscach": 0, "v1": 0, "rc2": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 12, 17], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "version": [0, 10], "10": 0, "7": 0, "5": [0, 11], "23rd": 0, "101": 0, "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 13, 14, 17], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 14, 17], "attr": 0, "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 13], "On": 0, "view": [0, 13], "timeout": [0, 13], "thi": [0, 1, 3, 7, 9, 11, 12, 13, 15, 16, 17], "ha": [0, 7], "its": [0, 3, 11, 12], "remov": [0, 3, 13], "set": [0, 1, 3, 11, 12, 13], "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 13], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 11, 12, 14, 15, 16, 17], "wrong": 0, "delet": [0, 3, 6, 8, 13], "method": [0, 4, 6, 7, 14], "103": 0, "button": [0, 13], "attach": 0, "parent": [0, 13], "gener": [0, 3, 11, 17], "onli": [0, 3], "allow": [0, 1, 3, 13], "specifi": [0, 11, 13], "user": [0, 11, 13], "role": [0, 1, 3, 13, 15], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 17], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 17], "creat": [0, 3, 4, 8, 11, 12, 17], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13, 15], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 14, 15, 17], "self": [0, 3, 13], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 15], "96": 0, "attempt": [0, 3, 9, 15], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 11, 12, 17], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 14, 15, 17], "none": [0, 3, 4, 6, 7, 8, 10, 11, 13, 14, 15, 17], "28th": 0, "93": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 11, 17], "new": [0, 1, 4, 6, 8, 12, 17], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 14], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 17], "out": [0, 1, 13], "10th": 0, "75": 0, "invit": [0, 16], "longer": [0, 13], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "url": [0, 3, 6], "safe": 0, "result": [0, 17], "refer": 0, "handl": [0, 15, 17], "captur": [0, 12, 16], "all": [0, 1, 3, 4, 7, 17], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 16], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 15], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 13, 14, 17], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 13], "actual": 0, "now": [0, 1, 17], "69": 0, "get": [0, 3, 6, 9, 15], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": [0, 12], "main": 0, "don": [0, 17], "t": [0, 10, 12, 17], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 12, 17], "start": [0, 3, 17], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": [0, 12], "task": [0, 3, 17], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 17], "manipul": [0, 12], "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1, 12], "help": [0, 1], "behaviour": 0, "broke": 0, "custom": [0, 8, 14], "pagin": 0, "also": [0, 7, 12, 13], "basic": [0, 13], "forum": 0, "channel": [0, 3, 7, 11], "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 13, 17], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 14, 17], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 17], "event": [0, 3, 4, 17], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 13, 17], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 13, 14, 17], "abstract": 0, "lot": 0, "logic": 0, "share": [0, 12], "between": [0, 1, 12], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 15, 17], "trace": [0, 7, 14], "import": 0, "can": [0, 1, 13, 17], "function": [0, 3, 7, 8, 9, 11, 14, 15, 17], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 15], "wrapper": [0, 6, 11, 12, 17], "from": [0, 1, 3, 4, 6, 7, 9, 12, 13, 15, 17], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 14, 16], "cach": [0, 3, 7, 9, 15], "logger": [0, 14], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 13, 14], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 16], "block": [0, 11, 16], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 14], "your": 1, "ar": [1, 3, 8, 12, 13, 16], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": [1, 12], "pre": 1, "exist": [1, 17], "provid": [1, 8, 10, 17], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 12, 13], "below": 1, "more": [1, 12], "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 12, 17], "you": [1, 9, 16], "ll": [1, 17], "write": 1, "might": 1, "mean": 1, "modifi": [1, 15], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 17], "vari": 1, "re": [1, 3, 17], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 11, 17], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 13, 17], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7, 12], "free": 1, "howev": 1, "like": [1, 12], "m": 1, "docker": 1, "compos": 1, "d": [1, 12], "configur": 1, "variabl": 1, "program": 1, "env": 1, "bot_token": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11, 13], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 13], "A": [1, 3, 6, 7, 8, 9, 11, 12, 13, 17], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 13, 17], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 17], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 14], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 11, 14], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 13, 14, 17], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "implement": [3, 4, 8, 13, 14], "initialis": [3, 8], "int": [3, 4, 8, 9, 13, 17], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 12, 13, 14, 17], "server": [3, 16], "If": [3, 6, 11, 12, 13, 17], "given": [3, 4, 7, 9, 10, 14, 15, 17], "oper": [3, 17], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 13, 17], "instead": [3, 11, 17], "connector": 3, "resolv": [3, 12], "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 17], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 11, 12, 17], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 13, 16], "thei": [3, 12], "name": [3, 7, 12, 14, 17], "alia": [3, 7, 11], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 17], "until": [3, 16], "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": [3, 12], "second": [3, 11, 13, 17], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 11, 12, 14, 17], "error": [3, 6, 7, 15], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "cooldown": [3, 7], "commandoncooldown": [3, 7, 11], "p": [3, 7, 11], "r": [3, 7, 11], "block_duplicate_invoc": [3, 7, 11], "globalnameconflicterror": [3, 7, 12], "command_wrap": [3, 7, 12], "update_wrapper_glob": [3, 7, 12], "customlogg": [3, 7, 14], "get_logg": [3, 7, 14], "get_or_fetch_memb": [3, 7, 15], "formatted_code_regex": [3, 7, 16], "raw_code_regex": [3, 7, 16], "create_task": [3, 7, 17], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 16], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 17], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 11, 15, 17], "django": 6, "initi": [6, 17], "authent": 6, "keyword": [6, 7, 14], "argument": [6, 7, 8, 10, 11, 14, 15], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 11, 14, 17], "send": [6, 13], "json": 6, "respons": 6, "bool": [6, 9, 11, 13, 17], "whether": [6, 9], "rais": [6, 9, 10, 11, 12, 15, 17], "ok": 6, "ani": [6, 16, 17], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 13, 17], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8, 11], "group": [7, 16], "root_alias": 7, "two": 7, "sequenc": [7, 12, 13], "act": 7, "top": 7, "level": [7, 14], "rather": 7, "than": 7, "being": [7, 15], "It": 7, "store": [7, 8], "attribut": [7, 12], "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "call_without_cooldown": [7, 11], "callback": [7, 13], "interaction_check": [7, 13], "on_timeout": [7, 13], "__contains__": [7, 17], "cancel": [7, 17], "cancel_al": [7, 17], "schedule_at": [7, 17], "schedule_lat": [7, 17], "relat": [8, 14], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 15, 17], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 17], "offset": 8, "arg_offset": 8, "posit": 8, "callabl": [8, 11, 12, 15], "wrap": [8, 12, 17], "target": 8, "item": 8, "helper": [9, 11, 15], "variou": 9, "channel_id": 9, "fetch": [9, 15], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12, 14], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 13], "repli": [10, 11], "context": 10, "badargu": 10, "wasn": 10, "els": 10, "commanderror": 11, "while": 11, "typevar": [11, 12, 17], "valu": [11, 12, 14], "signatur": 11, "cooldown_dur": 11, "send_notic": 11, "fals": 11, "args_preprocessor": 11, "prevent": [11, 17], "same": [11, 17], "float": [11, 13, 17], "length": 11, "notifi": 11, "about": 11, "paramspec": [11, 12], "iter": 11, "raw": [11, 16], "conflict": 12, "global": 12, "annot": 12, "assign": 12, "__module__": 12, "__name__": 12, "__qualname__": 12, "__doc__": 12, "__annotations__": 12, "__dict__": 12, "ignored_conflict_nam": 12, "frozenset": 12, "look": [12, 17], "forwardref": 12, "evalu": 12, "detail": 12, "_p": 12, "_r": 12, "found": [12, 15, 17], "behav": 12, "functool": 12, "replac": 12, "For": 12, "__global__": 12, "state": 12, "won": 12, "reflect": 12, "typehint": 12, "style": 13, "buttonstyl": 13, "secondari": 13, "label": 13, "click": 13, "itself": 13, "carri": 13, "done": [13, 17], "origin": 13, "allowed_us": 13, "180": 13, "moder": 13, "who": 13, "last": 13, "ui": 13, "accept": 13, "input": 13, "similar": [13, 16], "after": [13, 17], "occur": 13, "msg": 14, "sever": 14, "exc_info": 14, "houston": 14, "we": [14, 15], "interest": 14, "problem": 14, "mypi": 14, "recognis": 14, "interactin": 15, "member_id": 15, "failur": 15, "indic": 15, "could": 15, "coro": [15, 17], "sole": 15, "expect": 15, "add_rol": 15, "remove_rol": 15, "purpos": 15, "intend": 15, "regular": 16, "express": 16, "pattern": 16, "pleas": 16, "sanitis": 16, "output": 16, "someth": 16, "urllib": 16, "pars": 16, "quot": 16, "format": 16, "execut": 17, "keep": 17, "track": 17, "must": 17, "distinguish": 17, "suggest": 17, "immedi": 17, "futur": 17, "uniqu": 17, "prematur": 17, "current": 17, "task_id": 17, "hashabl": 17, "unschedul": 17, "identifi": 17, "warn": 17, "doesn": 17, "known": 17, "alreadi": 17, "unawait": 17, "elsewher": 17, "timezon": 17, "awar": 17, "calcul": 17, "subtract": 17, "na\u00efv": 17, "utc": 17, "past": 17, "datetim": 17, "delai": 17, "union": 17, "long": 17, "suppressed_except": 17, "event_loop": 17, "otherwis": 17, "task_return": 17, "tupl": 17}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "cooldown"], [12, 0, 0, "-", "function"], [13, 0, 0, "-", "interactions"], [14, 0, 0, "-", "logging"], [15, 0, 0, "-", "members"], [16, 0, 0, "-", "regex"], [17, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.cooldown": [[11, 3, 1, "", "CommandOnCooldown"], [11, 5, 1, "", "P"], [11, 5, 1, "", "R"], [11, 4, 1, "", "block_duplicate_invocations"]], "botcore.utils.cooldown.CommandOnCooldown": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "call_without_cooldown"]], "botcore.utils.function": [[12, 3, 1, "", "GlobalNameConflictError"], [12, 4, 1, "", "command_wraps"], [12, 4, 1, "", "update_wrapper_globals"]], "botcore.utils.interactions": [[13, 1, 1, "", "DeleteMessageButton"], [13, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[13, 2, 1, "", "__init__"], [13, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[13, 2, 1, "", "__init__"], [13, 2, 1, "", "interaction_check"], [13, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[14, 1, 1, "", "CustomLogger"], [14, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[14, 2, 1, "", "trace"]], "botcore.utils.members": [[15, 4, 1, "", "get_or_fetch_member"], [15, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[16, 5, 1, "", "DISCORD_INVITE"], [16, 5, 1, "", "FORMATTED_CODE_REGEX"], [16, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[17, 1, 1, "", "Scheduler"], [17, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[17, 2, 1, "", "__contains__"], [17, 2, 1, "", "__init__"], [17, 2, 1, "", "cancel"], [17, 2, 1, "", "cancel_all"], [17, 2, 1, "", "schedule"], [17, 2, 1, "", "schedule_at"], [17, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "cooldown": 11, "function": 12, "interact": 13, "log": 14, "member": 15, "regex": 16, "schedul": 17}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Exts": [[5, "module-botcore.exts"]], "Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Submodules": [[3, "submodules"], [7, "submodules"]], "site_api": [[6, "module-botcore.site_api"]], "Changelog": [[0, "changelog"]], "caching": [[8, "module-botcore.utils.caching"]], "async_stats": [[4, "module-botcore.async_stats"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Utils": [[7, "module-botcore.utils"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "logging": [[14, "module-botcore.utils.logging"]], "function": [[12, "module-botcore.utils.function"]], "members": [[15, "module-botcore.utils.members"]], "channel": [[9, "module-botcore.utils.channel"]], "commands": [[10, "module-botcore.utils.commands"]], "cooldown": [[11, "module-botcore.utils.cooldown"]], "regex": [[16, "module-botcore.utils.regex"]], "interactions": [[13, "module-botcore.utils.interactions"]], "scheduling": [[17, "module-botcore.utils.scheduling"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.cooldown"], [12, "module-botcore.utils.function"], [13, "module-botcore.utils.interactions"], [14, "module-botcore.utils.logging"], [15, "module-botcore.utils.members"], [16, "module-botcore.utils.regex"], [17, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "commandoncooldown": [[11, "botcore.utils.cooldown.CommandOnCooldown"]], "p (in module botcore.utils.cooldown)": [[11, "botcore.utils.cooldown.P"]], "r (in module botcore.utils.cooldown)": [[11, "botcore.utils.cooldown.R"]], "__init__() (commandoncooldown method)": [[11, "botcore.utils.cooldown.CommandOnCooldown.__init__"]], "block_duplicate_invocations() (in module botcore.utils.cooldown)": [[11, "botcore.utils.cooldown.block_duplicate_invocations"]], "botcore.utils.cooldown": [[11, "module-botcore.utils.cooldown"]], "call_without_cooldown() (commandoncooldown method)": [[11, "botcore.utils.cooldown.CommandOnCooldown.call_without_cooldown"]], "globalnameconflicterror": [[12, "botcore.utils.function.GlobalNameConflictError"]], "botcore.utils.function": [[12, "module-botcore.utils.function"]], "command_wraps() (in module botcore.utils.function)": [[12, "botcore.utils.function.command_wraps"]], "update_wrapper_globals() (in module botcore.utils.function)": [[12, "botcore.utils.function.update_wrapper_globals"]], "deletemessagebutton (class in botcore.utils.interactions)": [[13, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[13, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[13, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[13, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[14, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[14, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[14, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[14, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[15, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[15, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[15, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[16, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[16, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[16, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[16, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[17, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[17, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[17, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["changelog", "development", "index", "output/botcore", "output/botcore.async_stats", "output/botcore.exts", "output/botcore.site_api", "output/botcore.utils", "output/botcore.utils.caching", "output/botcore.utils.channel", "output/botcore.utils.commands", "output/botcore.utils.cooldown", "output/botcore.utils.function", "output/botcore.utils.interactions", "output/botcore.utils.logging", "output/botcore.utils.members", "output/botcore.utils.regex", "output/botcore.utils.scheduling"], "filenames": ["changelog.rst", "development.rst", "index.rst", "output/botcore.rst", "output/botcore.async_stats.rst", "output/botcore.exts.rst", "output/botcore.site_api.rst", "output/botcore.utils.rst", "output/botcore.utils.caching.rst", "output/botcore.utils.channel.rst", "output/botcore.utils.commands.rst", "output/botcore.utils.cooldown.rst", "output/botcore.utils.function.rst", "output/botcore.utils.interactions.rst", "output/botcore.utils.logging.rst", "output/botcore.utils.members.rst", "output/botcore.utils.regex.rst", "output/botcore.utils.scheduling.rst"], "titles": ["Changelog", "Local Development & Testing", "Bot Core Project Documentation", "Botcore", "async_stats", "Exts", "site_api", "Utils", "caching", "channel", "commands", "cooldown", "function", "interactions", "logging", "members", "regex", "scheduling"], "terms": {"8": 0, "3": 0, "0": [0, 8, 13, 14], "25th": 0, "octob": 0, "2022": 0, "featur": [0, 1, 3], "88": 0, "add": [0, 3, 11], "decor": [0, 8, 11, 12], "stop": 0, "success": 0, "duplic": [0, 11], "invoc": [0, 11], "command": [0, 1, 3, 7, 9, 11, 12], "support": [0, 4, 7, 17], "151": 0, "python": [0, 1, 3, 17], "11": 0, "2": [0, 3, 13], "1": [0, 14], "18th": 0, "septemb": 0, "bug": 0, "138": 0, "bump": 0, "discord": [0, 1, 3, 5, 7, 9, 10, 12, 15, 16], "py": [0, 12], "august": 0, "125": 0, "stabl": 0, "releas": 0, "16th": 0, "124": 0, "updat": [0, 12], "botcor": [0, 1, 2, 13], "util": [0, 1, 2, 3, 8, 12, 13, 14], "regex": [0, 3, 7], "discord_invit": [0, 3, 7, 16], "option": [0, 3, 4, 6, 8, 10, 11, 13, 14, 15], "match": [0, 3], "lead": 0, "http": [0, 6, 16], "": [0, 1, 7, 8, 10, 11, 12, 13, 14, 16, 17], "www": 0, "27th": 0, "juli": 0, "break": [0, 12], "110": 0, "async": [0, 3, 4, 6, 8, 9, 10, 11, 13, 15], "rediscach": 0, "v1": 0, "rc2": 0, "107": 0, "declar": 0, "aiodn": 0, "project": [0, 1], "depend": [0, 9], "sampl": 0, "boilerpl": 0, "document": 0, "explain": 0, "how": [0, 8, 12, 17], "develop": [0, 2, 3, 7], "bot": [0, 1, 3, 7, 9], "core": [0, 1], "108": 0, "version": [0, 10], "10": 0, "7": 0, "5": [0, 11], "23rd": 0, "101": 0, "clean": [0, 10], "string": [0, 6], "referenc": 0, "messag": [0, 3, 10, 11, 13, 14, 17], "content": [0, 6, 10], "4": 0, "17th": 0, "106": 0, "an": [0, 1, 3, 4, 6, 7, 8, 9, 14, 17], "attr": 0, "interact": [0, 3, 7, 9], "viewwithuserandrolecheck": [0, 3, 7, 13], "On": 0, "view": [0, 13], "timeout": [0, 13], "thi": [0, 1, 3, 7, 9, 11, 12, 13, 15, 16, 17], "ha": [0, 7], "its": [0, 3, 11, 12], "remov": [0, 3, 13], "set": [0, 1, 3, 11, 12, 13], "104": 0, "fix": 0, "deletemessagebutton": [0, 3, 7, 13], "work": [0, 1], "due": 0, "us": [0, 1, 3, 4, 6, 7, 9, 11, 12, 14, 15, 16, 17], "wrong": 0, "delet": [0, 3, 6, 8, 13], "method": [0, 4, 6, 7, 14], "103": 0, "button": [0, 13], "attach": 0, "parent": [0, 13], "gener": [0, 3, 11, 17], "onli": [0, 3], "allow": [0, 1, 3, 13], "specifi": [0, 11, 13], "user": [0, 11, 13], "role": [0, 1, 3, 13, 15], "9th": 0, "98": 0, "close": [0, 2, 3, 6, 17], "botbas": [0, 2, 3], "stat": [0, 4], "_transport": 0, "wa": [0, 9, 17], "creat": [0, 3, 4, 8, 11, 12, 17], "30th": 0, "june": 0, "91": 0, "miss": 0, "await": [0, 11, 13, 15], "ping_servic": [0, 2, 3], "some": 0, "case": 0, "pass": [0, 6, 14, 15, 17], "self": [0, 3, 13], "paramet": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "incorrect": 0, "docstr": 0, "member": [0, 3, 7], "handle_role_chang": [0, 3, 7, 15], "96": 0, "attempt": [0, 3, 9, 15], "connect": [0, 3, 4], "statsd_url": [0, 3], "when": [0, 3, 4, 6, 7, 8, 11, 12, 17], "i": [0, 1, 3, 6, 7, 9, 11, 12, 13, 14, 15, 17], "none": [0, 3, 4, 6, 7, 8, 10, 11, 13, 14, 15, 17], "28th": 0, "93": 0, "0eb3d26": 0, "auto": 0, "mod": 0, "which": [0, 1, 7, 11, 17], "new": [0, 1, 4, 6, 8, 12, 17], "auto_mod": 0, "message_typ": 0, "need": [0, 1], "our": [0, 1, 7], "filter": 0, "system": [0, 1], "mai": [0, 8], "79": 0, "restor": 0, "site": [0, 6], "sphinx": 0, "multivers": 0, "make": [0, 1, 14], "avail": [0, 3], "older": 0, "doc": 0, "24th": 0, "78": 0, "4cbe8f5": 0, "permiss": [0, 9], "resolut": 0, "deal": 0, "time": [0, 17], "out": [0, 1, 13], "10th": 0, "75": 0, "invit": [0, 16], "longer": [0, 13], "return": [0, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "url": [0, 3, 6], "safe": 0, "result": [0, 17], "refer": 0, "handl": [0, 15, 17], "captur": [0, 12, 16], "all": [0, 1, 3, 4, 7, 17], "charact": 0, "up": [0, 1, 3], "whitespac": [0, 16], "6": 0, "26th": 0, "april": 0, "72": 0, "5a06fa5": 0, "notabl": 0, "one": [0, 3], "commit": 0, "dynam": 0, "extend": 0, "guild": [0, 1, 3, 15], "chunk": 0, "base": [0, 3, 4, 6, 8, 11, 12, 13, 14, 17], "number": 0, "so": [0, 1, 7], "should": [0, 1, 3, 6, 13], "actual": 0, "now": [0, 1, 17], "69": 0, "get": [0, 3, 6, 9, 15], "21st": 0, "68": 0, "correct": [0, 1], "pyproject": [0, 1], "toml": [0, 1], "directli": [0, 12], "main": 0, "don": [0, 17], "t": [0, 10, 12, 17], "load": [0, 1, 3, 7], "modul": [0, 3, 7, 12, 17], "start": [0, 3, 17], "_": 0, "66": 0, "each": 0, "cog": [0, 3, 5], "own": [0, 12], "task": [0, 3, 17], "avoid": [0, 3], "singl": 0, "crash": 0, "entir": [0, 3], "process": 0, "20th": 0, "65": 0, "unqualifi": [0, 2, 3, 7], "namespac": [0, 17], "manipul": [0, 12], "extens": [0, 3], "19th": 0, "64": 0, "987235d": 0, "revert": 0, "chang": [0, 1, 12], "help": [0, 1], "behaviour": 0, "broke": 0, "custom": [0, 8, 14], "pagin": 0, "also": [0, 7, 12, 13], "basic": [0, 13], "forum": 0, "channel": [0, 3, 7, 11], "63": 0, "api_cli": [0, 3], "__init__": [0, 2, 3, 4, 6, 7, 8, 11, 13, 17], "site_api": [0, 2, 3], "apicli": [0, 2, 3, 6], "instanc": [0, 3, 6, 8, 9, 14, 17], "61": 0, "reconnect": 0, "redi": 0, "session": [0, 3, 6], "setup": [0, 3], "5th": 0, "56": 0, "move": 0, "creation": 0, "asyncio": [0, 4, 17], "event": [0, 3, 4, 17], "_guild_avail": 0, "within": [0, 3], "hook": 0, "deprec": 0, "notic": 0, "dummi": [0, 3], "asyncstatsdcli": 0, "befor": [0, 3, 13, 17], "real": 0, "cannot": [0, 3], "made": 0, "init": [0, 3, 4], "2nd": 0, "54": 0, "aiohttp": [0, 3, 6], "asyncresolv": 0, "42": 0, "public": 0, "statsd": [0, 3, 4], "client": [0, 3, 4], "ext": [0, 2, 3, 7, 9, 10], "sub": [0, 3], "class": [0, 3, 4, 6, 8, 13, 14, 17], "abstract": 0, "lot": 0, "logic": 0, "share": [0, 12], "between": [0, 1, 12], "latest": 0, "alpha": 0, "14th": 0, "march": 0, "39": 0, "migrat": 0, "back": 0, "37": 0, "log": [0, 3, 7, 15, 17], "trace": [0, 7, 14], "import": 0, "can": [0, 1, 13, 17], "function": [0, 3, 7, 8, 9, 11, 14, 15, 17], "3rd": 0, "35": 0, "apply_monkey_patch": [0, 2, 3, 7], "februari": 0, "34": 0, "port": [0, 4], "api": [0, 6, 15], "wrapper": [0, 6, 11, 12, 17], "from": [0, 1, 3, 4, 6, 7, 9, 12, 13, 15, 17], "repo": 0, "22nd": 0, "32": 0, "0a0": 0, "disnak": 0, "29": 0, "mani": [0, 3, 8], "common": [0, 1, 3, 7, 14, 16], "cach": [0, 3, 7, 9, 15], "logger": [0, 14], "schedul": [0, 3, 7], "monkei": [0, 7], "patch": [0, 3, 6, 7], "ad": [0, 1, 7, 13, 14], "intersphinx": 0, "januari": 0, "12": 0, "code": [0, 1, 16], "block": [0, 11, 16], "detect": 0, "decemb": 0, "2021": 0, "autogener": 0, "novemb": 0, "packag": [0, 7], "poetri": [0, 1], "lint": 0, "ci": 0, "To": [1, 3, 14], "your": 1, "ar": [1, 3, 8, 12, 13, 16], "few": 1, "possibl": 1, "approach": 1, "instal": 1, "copi": [1, 12], "pre": 1, "exist": [1, 17], "provid": [1, 8, 10, 17], "templat": 1, "dev": [1, 3], "folder": 1, "see": [1, 12, 13], "below": 1, "more": [1, 12], "info": 1, "both": 1, "what": 1, "go": 1, "them": [1, 3, 12, 17], "you": [1, 9, 16], "ll": [1, 17], "write": 1, "might": 1, "mean": 1, "modifi": [1, 15], "ones": 1, "etc": 1, "The": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "step": 1, "most": 1, "groundwork": 1, "exact": 1, "requir": [1, 3, 17], "vari": 1, "re": [1, 3, 17], "navig": 1, "want": 1, "sir": 1, "lancebot": 1, "run": [1, 11, 17], "pip": 1, "path": 1, "environ": 1, "root": [1, 3, 7], "directori": 1, "machin": 1, "That": 1, "contain": [1, 13, 17], "file": 1, "sure": 1, "again": 1, "git": 1, "ignor": [1, 7, 12], "free": 1, "howev": 1, "like": [1, 12], "m": 1, "docker": 1, "compos": 1, "d": [1, 12], "configur": 1, "variabl": 1, "program": 1, "env": 1, "bot_token": 1, "token": [1, 6], "intent": 1, "enabl": 1, "guild_id": [1, 3], "monitor": 1, "prefix": [1, 4], "invok": [1, 11, 13], "default": 1, "mention": [1, 3], "allowed_rol": [1, 3, 13], "A": [1, 3, 6, 7, 8, 9, 11, 12, 13, 17], "comma": 1, "seper": 1, "list": [1, 3], "id": [1, 3, 9, 13, 17], "do": [1, 9], "anyth": 1, "reinstal": 1, "librari": 1, "includ": 1, "servic": [1, 3], "other": [1, 17], "applic": 1, "certain": 1, "add_cog": [2, 3], "add_command": [2, 3], "clear": [2, 3, 7, 8], "load_extens": [2, 3], "log_to_dev_log": [2, 3], "on_guild_avail": [2, 3], "on_guild_unavail": [2, 3], "remove_command": [2, 3], "setup_hook": [2, 3], "wait_until_guild_avail": [2, 3], "startuperror": [2, 3], "subpackag": 2, "submodul": 2, "async_stat": [2, 3], "asyncstatscli": [2, 3, 4], "responsecodeerror": [2, 3, 6], "index": 2, "search": 2, "page": 2, "inform": [2, 14], "local": 2, "test": 2, "changelog": 2, "tool": [3, 7], "arg": [3, 11, 14], "http_session": 3, "redis_sess": 3, "kwarg": [3, 6, 11, 13, 14, 17], "sourc": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17], "implement": [3, 4, 8, 13, 14], "initialis": [3, 8], "int": [3, 4, 8, 9, 13, 17], "clientsess": [3, 6], "redissess": 3, "async_rediscach": 3, "str": [3, 4, 6, 7, 10, 12, 13, 14, 17], "server": [3, 16], "If": [3, 6, 11, 12, 13, 17], "given": [3, 4, 7, 9, 10, 14, 15, 17], "oper": [3, 17], "type": [3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17], "normal": 3, "alias": [3, 7], "Not": 3, "instanti": [3, 13, 17], "instead": [3, 11, 17], "connector": 3, "resolv": [3, 12], "save": 3, "all_extens": 3, "ran": 3, "loop": [3, 4, 17], "deadlock": 3, "caus": [3, 7], "wait_for": 3, "call": [3, 11, 12, 17], "intern": [3, 7], "becom": 3, "appear": 3, "still": 3, "empti": 3, "guild_available_but_cache_empti": 3, "emit": 3, "unavail": 3, "ping": 3, "ensur": [3, 13, 16], "thei": [3, 12], "name": [3, 7, 12, 14, 17], "alia": [3, 7, 11], "individu": 3, "either": 3, "manual": 3, "edit": 3, "all_command": 3, "startup": 3, "create_socket": [3, 4], "wait": [3, 17], "until": [3, 16], "readi": 3, "on_readi": 3, "inadequ": 3, "becaus": [3, 12], "second": [3, 11, 13, 17], "guild_creat": 3, "gatewai": 3, "give": 3, "thu": 3, "popul": 3, "except": [3, 6, 11, 12, 14, 17], "error": [3, 6, 7, 15], "asynccach": [3, 7, 8], "get_or_fetch_channel": [3, 7, 9], "is_in_categori": [3, 7, 9], "clean_text_or_repli": [3, 7, 10], "cooldown": [3, 7], "commandoncooldown": [3, 7, 11], "p": [3, 7, 11], "r": [3, 7, 11], "block_duplicate_invoc": [3, 7, 11], "globalnameconflicterror": [3, 7, 12], "command_wrap": [3, 7, 12], "update_wrapper_glob": [3, 7, 12], "customlogg": [3, 7, 14], "get_logg": [3, 7, 14], "get_or_fetch_memb": [3, 7, 15], "formatted_code_regex": [3, 7, 16], "raw_code_regex": [3, 7, 16], "create_task": [3, 7, 17], "maybe_raise_for_statu": [3, 6], "post": [3, 6], "put": [3, 6], "request": [3, 6, 16], "__str__": [3, 6], "transport": 4, "commun": 4, "host": 4, "localhost": 4, "8125": 4, "statsclientbas": 4, "abstracteventloop": [4, 17], "create_datagram_endpoint": 4, "socket": 4, "reusabl": 5, "around": 6, "site_api_url": 6, "site_api_token": 6, "session_kwarg": 6, "object": [6, 7, 8, 9, 11, 15, 17], "django": 6, "initi": [6, 17], "authent": 6, "keyword": [6, 7, 14], "argument": [6, 7, 8, 10, 11, 14, 15], "constructor": 6, "endpoint": 6, "raise_for_statu": 6, "true": [6, 11, 14, 17], "send": [6, 13], "json": 6, "respons": 6, "bool": [6, 9, 11, 13, 17], "whether": [6, 9], "rais": [6, 9, 10, 11, 12, 15, 17], "ok": 6, "ani": [6, 16, 17], "extra": 6, "dict": 6, "204": 6, "No": 6, "equival": 6, "static": 6, "should_rais": 6, "non": 6, "clientrespons": 6, "check": [6, 9, 11, 13, 17], "response_json": 6, "response_text": 6, "valueerror": 6, "receiv": [6, 9], "text": [6, 10], "represent": 6, "appli": [7, 8, 11], "group": [7, 16], "root_alias": 7, "two": 7, "sequenc": [7, 12, 13], "act": 7, "top": 7, "level": [7, 14], "rather": 7, "than": 7, "being": [7, 15], "It": 7, "store": [7, 8], "attribut": [7, 12], "send_typ": 7, "403": 7, "under": 7, "heavi": 7, "cloudflar": 7, "worker": 7, "rout": 7, "thrown": 7, "qualifi": 7, "__call__": [7, 8], "call_without_cooldown": [7, 11], "callback": [7, 13], "interaction_check": [7, 13], "on_timeout": [7, 13], "__contains__": [7, 17], "cancel": [7, 17], "cancel_al": [7, 17], "schedule_at": [7, 17], "schedule_lat": [7, 17], "relat": [8, 14], "max_siz": 8, "128": 8, "lru": 8, "coroutin": [8, 15, 17], "onc": 8, "exce": 8, "maximum": 8, "size": 8, "kei": 8, "fifo": 8, "order": [8, 17], "offset": 8, "arg_offset": 8, "posit": 8, "callabl": [8, 11, 12, 15], "wrap": [8, 12, 17], "target": 8, "item": 8, "helper": [9, 11, 15], "variou": 9, "channel_id": 9, "fetch": [9, 15], "invaliddata": 9, "unknown": 9, "httpexcept": 9, "retriev": 9, "fail": 9, "notfound": 9, "invalid": 9, "forbidden": 9, "have": [9, 12, 14], "guildchannel": 9, "category_id": 9, "categori": 9, "textchannel": 9, "ctx": [10, 13], "repli": [10, 11], "context": 10, "badargu": 10, "wasn": 10, "els": 10, "commanderror": 11, "while": 11, "typevar": [11, 12, 17], "valu": [11, 12, 14], "signatur": 11, "cooldown_dur": 11, "send_notic": 11, "fals": 11, "args_preprocessor": 11, "prevent": [11, 17], "same": [11, 17], "float": [11, 13, 17], "length": 11, "notifi": 11, "about": 11, "paramspec": [11, 12], "iter": 11, "raw": [11, 16], "conflict": 12, "global": 12, "annot": 12, "assign": 12, "__module__": 12, "__name__": 12, "__qualname__": 12, "__doc__": 12, "__annotations__": 12, "__dict__": 12, "ignored_conflict_nam": 12, "frozenset": 12, "look": [12, 17], "forwardref": 12, "evalu": 12, "detail": 12, "_p": 12, "_r": 12, "found": [12, 15, 17], "behav": 12, "functool": 12, "replac": 12, "For": 12, "__global__": 12, "state": 12, "won": 12, "reflect": 12, "typehint": 12, "style": 13, "buttonstyl": 13, "secondari": 13, "label": 13, "click": 13, "itself": 13, "carri": 13, "done": [13, 17], "origin": 13, "allowed_us": 13, "180": 13, "moder": 13, "who": 13, "last": 13, "ui": 13, "accept": 13, "input": 13, "similar": [13, 16], "after": [13, 17], "occur": 13, "msg": 14, "sever": 14, "exc_info": 14, "houston": 14, "we": [14, 15], "interest": 14, "problem": 14, "mypi": 14, "recognis": 14, "interactin": 15, "member_id": 15, "failur": 15, "indic": 15, "could": 15, "coro": [15, 17], "sole": 15, "expect": 15, "add_rol": 15, "remove_rol": 15, "purpos": 15, "intend": 15, "regular": 16, "express": 16, "pattern": 16, "pleas": 16, "sanitis": 16, "output": 16, "someth": 16, "urllib": 16, "pars": 16, "quot": 16, "format": 16, "execut": 17, "keep": 17, "track": 17, "must": 17, "distinguish": 17, "suggest": 17, "immedi": 17, "futur": 17, "uniqu": 17, "prematur": 17, "current": 17, "task_id": 17, "hashabl": 17, "unschedul": 17, "identifi": 17, "warn": 17, "doesn": 17, "known": 17, "alreadi": 17, "unawait": 17, "elsewher": 17, "timezon": 17, "awar": 17, "calcul": 17, "subtract": 17, "na\u00efv": 17, "utc": 17, "past": 17, "datetim": 17, "delai": 17, "union": 17, "long": 17, "suppressed_except": 17, "event_loop": 17, "otherwis": 17, "task_return": 17, "tupl": 17}, "objects": {"": [[3, 0, 0, "-", "botcore"]], "botcore": [[3, 1, 1, "", "BotBase"], [3, 3, 1, "", "StartupError"], [4, 0, 0, "-", "async_stats"], [5, 0, 0, "-", "exts"], [6, 0, 0, "-", "site_api"], [7, 0, 0, "-", "utils"]], "botcore.BotBase": [[3, 2, 1, "", "__init__"], [3, 2, 1, "", "add_cog"], [3, 2, 1, "", "add_command"], [3, 2, 1, "", "clear"], [3, 2, 1, "", "close"], [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, "", "remove_command"], [3, 2, 1, "", "setup_hook"], [3, 2, 1, "", "wait_until_guild_available"]], "botcore.StartupError": [[3, 2, 1, "", "__init__"]], "botcore.async_stats": [[4, 1, 1, "", "AsyncStatsClient"]], "botcore.async_stats.AsyncStatsClient": [[4, 2, 1, "", "__init__"], [4, 2, 1, "", "create_socket"]], "botcore.site_api": [[6, 1, 1, "", "APIClient"], [6, 3, 1, "", "ResponseCodeError"]], "botcore.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"]], "botcore.site_api.ResponseCodeError": [[6, 2, 1, "", "__init__"], [6, 2, 1, "", "__str__"]], "botcore.utils": [[7, 4, 1, "", "apply_monkey_patches"], [8, 0, 0, "-", "caching"], [9, 0, 0, "-", "channel"], [10, 0, 0, "-", "commands"], [11, 0, 0, "-", "cooldown"], [12, 0, 0, "-", "function"], [13, 0, 0, "-", "interactions"], [14, 0, 0, "-", "logging"], [15, 0, 0, "-", "members"], [16, 0, 0, "-", "regex"], [17, 0, 0, "-", "scheduling"], [7, 4, 1, "", "unqualify"]], "botcore.utils.caching": [[8, 1, 1, "", "AsyncCache"]], "botcore.utils.caching.AsyncCache": [[8, 2, 1, "", "__call__"], [8, 2, 1, "", "__init__"], [8, 2, 1, "", "clear"]], "botcore.utils.channel": [[9, 4, 1, "", "get_or_fetch_channel"], [9, 4, 1, "", "is_in_category"]], "botcore.utils.commands": [[10, 4, 1, "", "clean_text_or_reply"]], "botcore.utils.cooldown": [[11, 3, 1, "", "CommandOnCooldown"], [11, 5, 1, "", "P"], [11, 5, 1, "", "R"], [11, 4, 1, "", "block_duplicate_invocations"]], "botcore.utils.cooldown.CommandOnCooldown": [[11, 2, 1, "", "__init__"], [11, 2, 1, "", "call_without_cooldown"]], "botcore.utils.function": [[12, 3, 1, "", "GlobalNameConflictError"], [12, 4, 1, "", "command_wraps"], [12, 4, 1, "", "update_wrapper_globals"]], "botcore.utils.interactions": [[13, 1, 1, "", "DeleteMessageButton"], [13, 1, 1, "", "ViewWithUserAndRoleCheck"]], "botcore.utils.interactions.DeleteMessageButton": [[13, 2, 1, "", "__init__"], [13, 2, 1, "", "callback"]], "botcore.utils.interactions.ViewWithUserAndRoleCheck": [[13, 2, 1, "", "__init__"], [13, 2, 1, "", "interaction_check"], [13, 2, 1, "", "on_timeout"]], "botcore.utils.logging": [[14, 1, 1, "", "CustomLogger"], [14, 4, 1, "", "get_logger"]], "botcore.utils.logging.CustomLogger": [[14, 2, 1, "", "trace"]], "botcore.utils.members": [[15, 4, 1, "", "get_or_fetch_member"], [15, 4, 1, "", "handle_role_change"]], "botcore.utils.regex": [[16, 5, 1, "", "DISCORD_INVITE"], [16, 5, 1, "", "FORMATTED_CODE_REGEX"], [16, 5, 1, "", "RAW_CODE_REGEX"]], "botcore.utils.scheduling": [[17, 1, 1, "", "Scheduler"], [17, 4, 1, "", "create_task"]], "botcore.utils.scheduling.Scheduler": [[17, 2, 1, "", "__contains__"], [17, 2, 1, "", "__init__"], [17, 2, 1, "", "cancel"], [17, 2, 1, "", "cancel_all"], [17, 2, 1, "", "schedule"], [17, 2, 1, "", "schedule_at"], [17, 2, 1, "", "schedule_later"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["py", "data", "Python data"]}, "titleterms": {"changelog": 0, "local": 1, "develop": 1, "test": 1, "option": 1, "1": 1, "2": 1, "bot": 2, "core": 2, "project": 2, "document": 2, "refer": 2, "modul": 2, "extra": 2, "botcor": 3, "subpackag": 3, "submodul": [3, 7], "async_stat": 4, "ext": 5, "site_api": 6, "util": 7, "cach": 8, "channel": 9, "command": 10, "cooldown": 11, "function": 12, "interact": 13, "log": 14, "member": 15, "regex": 16, "schedul": 17}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Botcore": [[3, "module-botcore"]], "Subpackages": [[3, "subpackages"]], "Submodules": [[3, "submodules"], [7, "submodules"]], "site_api": [[6, "module-botcore.site_api"]], "Changelog": [[0, "changelog"]], "async_stats": [[4, "module-botcore.async_stats"]], "caching": [[8, "module-botcore.utils.caching"]], "Local Development & Testing": [[1, "local-development-testing"]], "Option 1": [[1, "option-1"]], "Option 2": [[1, "option-2"]], "Bot Core Project Documentation": [[2, "bot-core-project-documentation"]], "Reference": [[2, "reference"]], "Modules:": [[2, null]], "Extras": [[2, "extras"]], "Utils": [[7, "module-botcore.utils"]], "Exts": [[5, "module-botcore.exts"]], "members": [[15, "module-botcore.utils.members"]], "function": [[12, "module-botcore.utils.function"]], "commands": [[10, "module-botcore.utils.commands"]], "cooldown": [[11, "module-botcore.utils.cooldown"]], "interactions": [[13, "module-botcore.utils.interactions"]], "logging": [[14, "module-botcore.utils.logging"]], "regex": [[16, "module-botcore.utils.regex"]], "scheduling": [[17, "module-botcore.utils.scheduling"]], "channel": [[9, "module-botcore.utils.channel"]]}, "indexentries": {"botbase (class in botcore)": [[3, "botcore.BotBase"]], "startuperror": [[3, "botcore.StartupError"]], "__init__() (botbase method)": [[3, "botcore.BotBase.__init__"]], "__init__() (startuperror method)": [[3, "botcore.StartupError.__init__"]], "add_cog() (botbase method)": [[3, "botcore.BotBase.add_cog"]], "add_command() (botbase method)": [[3, "botcore.BotBase.add_command"]], "botcore": [[3, "module-botcore"]], "clear() (botbase method)": [[3, "botcore.BotBase.clear"]], "close() (botbase method)": [[3, "botcore.BotBase.close"]], "load_extensions() (botbase method)": [[3, "botcore.BotBase.load_extensions"]], "log_to_dev_log() (botbase method)": [[3, "botcore.BotBase.log_to_dev_log"]], "module": [[3, "module-botcore"], [4, "module-botcore.async_stats"], [5, "module-botcore.exts"], [6, "module-botcore.site_api"], [7, "module-botcore.utils"], [8, "module-botcore.utils.caching"], [9, "module-botcore.utils.channel"], [10, "module-botcore.utils.commands"], [11, "module-botcore.utils.cooldown"], [12, "module-botcore.utils.function"], [13, "module-botcore.utils.interactions"], [14, "module-botcore.utils.logging"], [15, "module-botcore.utils.members"], [16, "module-botcore.utils.regex"], [17, "module-botcore.utils.scheduling"]], "on_guild_available() (botbase method)": [[3, "botcore.BotBase.on_guild_available"]], "on_guild_unavailable() (botbase method)": [[3, "botcore.BotBase.on_guild_unavailable"]], "ping_services() (botbase method)": [[3, "botcore.BotBase.ping_services"]], "remove_command() (botbase method)": [[3, "botcore.BotBase.remove_command"]], "setup_hook() (botbase method)": [[3, "botcore.BotBase.setup_hook"]], "wait_until_guild_available() (botbase method)": [[3, "botcore.BotBase.wait_until_guild_available"]], "asyncstatsclient (class in botcore.async_stats)": [[4, "botcore.async_stats.AsyncStatsClient"]], "__init__() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.__init__"]], "botcore.async_stats": [[4, "module-botcore.async_stats"]], "create_socket() (asyncstatsclient method)": [[4, "botcore.async_stats.AsyncStatsClient.create_socket"]], "botcore.exts": [[5, "module-botcore.exts"]], "apiclient (class in botcore.site_api)": [[6, "botcore.site_api.APIClient"]], "responsecodeerror": [[6, "botcore.site_api.ResponseCodeError"]], "__init__() (apiclient method)": [[6, "botcore.site_api.APIClient.__init__"]], "__init__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__init__"]], "__str__() (responsecodeerror method)": [[6, "botcore.site_api.ResponseCodeError.__str__"]], "botcore.site_api": [[6, "module-botcore.site_api"]], "close() (apiclient method)": [[6, "botcore.site_api.APIClient.close"]], "delete() (apiclient method)": [[6, "botcore.site_api.APIClient.delete"]], "get() (apiclient method)": [[6, "botcore.site_api.APIClient.get"]], "maybe_raise_for_status() (apiclient static method)": [[6, "botcore.site_api.APIClient.maybe_raise_for_status"]], "patch() (apiclient method)": [[6, "botcore.site_api.APIClient.patch"]], "post() (apiclient method)": [[6, "botcore.site_api.APIClient.post"]], "put() (apiclient method)": [[6, "botcore.site_api.APIClient.put"]], "request() (apiclient method)": [[6, "botcore.site_api.APIClient.request"]], "apply_monkey_patches() (in module botcore.utils)": [[7, "botcore.utils.apply_monkey_patches"]], "botcore.utils": [[7, "module-botcore.utils"]], "unqualify() (in module botcore.utils)": [[7, "botcore.utils.unqualify"]], "asynccache (class in botcore.utils.caching)": [[8, "botcore.utils.caching.AsyncCache"]], "__call__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__call__"]], "__init__() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.__init__"]], "botcore.utils.caching": [[8, "module-botcore.utils.caching"]], "clear() (asynccache method)": [[8, "botcore.utils.caching.AsyncCache.clear"]], "botcore.utils.channel": [[9, "module-botcore.utils.channel"]], "get_or_fetch_channel() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.get_or_fetch_channel"]], "is_in_category() (in module botcore.utils.channel)": [[9, "botcore.utils.channel.is_in_category"]], "botcore.utils.commands": [[10, "module-botcore.utils.commands"]], "clean_text_or_reply() (in module botcore.utils.commands)": [[10, "botcore.utils.commands.clean_text_or_reply"]], "commandoncooldown": [[11, "botcore.utils.cooldown.CommandOnCooldown"]], "p (in module botcore.utils.cooldown)": [[11, "botcore.utils.cooldown.P"]], "r (in module botcore.utils.cooldown)": [[11, "botcore.utils.cooldown.R"]], "__init__() (commandoncooldown method)": [[11, "botcore.utils.cooldown.CommandOnCooldown.__init__"]], "block_duplicate_invocations() (in module botcore.utils.cooldown)": [[11, "botcore.utils.cooldown.block_duplicate_invocations"]], "botcore.utils.cooldown": [[11, "module-botcore.utils.cooldown"]], "call_without_cooldown() (commandoncooldown method)": [[11, "botcore.utils.cooldown.CommandOnCooldown.call_without_cooldown"]], "globalnameconflicterror": [[12, "botcore.utils.function.GlobalNameConflictError"]], "botcore.utils.function": [[12, "module-botcore.utils.function"]], "command_wraps() (in module botcore.utils.function)": [[12, "botcore.utils.function.command_wraps"]], "update_wrapper_globals() (in module botcore.utils.function)": [[12, "botcore.utils.function.update_wrapper_globals"]], "deletemessagebutton (class in botcore.utils.interactions)": [[13, "botcore.utils.interactions.DeleteMessageButton"]], "viewwithuserandrolecheck (class in botcore.utils.interactions)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck"]], "__init__() (deletemessagebutton method)": [[13, "botcore.utils.interactions.DeleteMessageButton.__init__"]], "__init__() (viewwithuserandrolecheck method)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck.__init__"]], "botcore.utils.interactions": [[13, "module-botcore.utils.interactions"]], "callback() (deletemessagebutton method)": [[13, "botcore.utils.interactions.DeleteMessageButton.callback"]], "interaction_check() (viewwithuserandrolecheck method)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"]], "on_timeout() (viewwithuserandrolecheck method)": [[13, "botcore.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"]], "customlogger (class in botcore.utils.logging)": [[14, "botcore.utils.logging.CustomLogger"]], "botcore.utils.logging": [[14, "module-botcore.utils.logging"]], "get_logger() (in module botcore.utils.logging)": [[14, "botcore.utils.logging.get_logger"]], "trace() (customlogger method)": [[14, "botcore.utils.logging.CustomLogger.trace"]], "botcore.utils.members": [[15, "module-botcore.utils.members"]], "get_or_fetch_member() (in module botcore.utils.members)": [[15, "botcore.utils.members.get_or_fetch_member"]], "handle_role_change() (in module botcore.utils.members)": [[15, "botcore.utils.members.handle_role_change"]], "discord_invite (in module botcore.utils.regex)": [[16, "botcore.utils.regex.DISCORD_INVITE"]], "formatted_code_regex (in module botcore.utils.regex)": [[16, "botcore.utils.regex.FORMATTED_CODE_REGEX"]], "raw_code_regex (in module botcore.utils.regex)": [[16, "botcore.utils.regex.RAW_CODE_REGEX"]], "botcore.utils.regex": [[16, "module-botcore.utils.regex"]], "scheduler (class in botcore.utils.scheduling)": [[17, "botcore.utils.scheduling.Scheduler"]], "__contains__() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.__contains__"]], "__init__() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.__init__"]], "botcore.utils.scheduling": [[17, "module-botcore.utils.scheduling"]], "cancel() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.cancel"]], "cancel_all() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.cancel_all"]], "create_task() (in module botcore.utils.scheduling)": [[17, "botcore.utils.scheduling.create_task"]], "schedule() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.schedule"]], "schedule_at() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.schedule_at"]], "schedule_later() (scheduler method)": [[17, "botcore.utils.scheduling.Scheduler.schedule_later"]]}}) \ No newline at end of file -- cgit v1.2.3