diff options
author | 2022-06-28 12:11:54 +0000 | |
---|---|---|
committer | 2022-06-28 12:11:54 +0000 | |
commit | 05394fec96b65e6f97d53a5b4d5fe47b07fcebc2 (patch) | |
tree | 402ced04f0bf0608a8557e9f4f62fd058058f6b7 | |
parent | Deploying to docs from @ python-discord/bot-core@149e278d3b6111a6f45f31e99311... (diff) |
Deploying to docs from @ python-discord/bot-core@28be7e1e8b712084a883a9199028c0cab876361c 🚀
-rw-r--r-- | main/.buildinfo | 2 | ||||
-rw-r--r-- | main/.doctrees/changelog.doctree | bin | 67877 -> 67877 bytes | |||
-rw-r--r-- | main/.doctrees/environment.pickle | bin | 2634216 -> 2634198 bytes | |||
-rw-r--r-- | main/.doctrees/index.doctree | bin | 5445 -> 5445 bytes | |||
-rw-r--r-- | main/.doctrees/output/botcore.async_stats.doctree | bin | 18992 -> 18992 bytes | |||
-rw-r--r-- | main/.doctrees/output/botcore.doctree | bin | 62401 -> 62401 bytes | |||
-rw-r--r-- | main/.doctrees/output/botcore.exts.doctree | bin | 3091 -> 3091 bytes | |||
-rw-r--r-- | main/.doctrees/output/botcore.site_api.doctree | bin | 65215 -> 65215 bytes | |||
-rw-r--r-- | main/.doctrees/output/botcore.utils.caching.doctree | bin | 16590 -> 16590 bytes | |||
-rw-r--r-- | main/.doctrees/output/botcore.utils.channel.doctree | bin | 17681 -> 17681 bytes | |||
-rw-r--r-- | main/.doctrees/output/botcore.utils.doctree | bin | 13965 -> 13965 bytes | |||
-rw-r--r-- | main/.doctrees/output/botcore.utils.logging.doctree | bin | 18135 -> 18135 bytes | |||
-rw-r--r-- | main/.doctrees/output/botcore.utils.members.doctree | bin | 16844 -> 16844 bytes | |||
-rw-r--r-- | main/.doctrees/output/botcore.utils.regex.doctree | bin | 9013 -> 9013 bytes | |||
-rw-r--r-- | main/.doctrees/output/botcore.utils.scheduling.doctree | bin | 53663 -> 53663 bytes | |||
-rw-r--r-- | main/changelog.html | 2 | ||||
-rw-r--r-- | main/genindex.html | 2 | ||||
-rw-r--r-- | main/index.html | 2 | ||||
-rw-r--r-- | main/output/botcore.async_stats.html | 8 | ||||
-rw-r--r-- | main/output/botcore.exts.html | 2 | ||||
-rw-r--r-- | main/output/botcore.html | 34 | ||||
-rw-r--r-- | main/output/botcore.site_api.html | 28 | ||||
-rw-r--r-- | main/output/botcore.utils.caching.html | 10 | ||||
-rw-r--r-- | main/output/botcore.utils.channel.html | 6 | ||||
-rw-r--r-- | main/output/botcore.utils.html | 6 | ||||
-rw-r--r-- | main/output/botcore.utils.logging.html | 8 | ||||
-rw-r--r-- | main/output/botcore.utils.members.html | 6 | ||||
-rw-r--r-- | main/output/botcore.utils.regex.html | 8 | ||||
-rw-r--r-- | main/output/botcore.utils.scheduling.html | 20 | ||||
-rw-r--r-- | main/py-modindex.html | 2 | ||||
-rw-r--r-- | main/search.html | 2 | ||||
-rw-r--r-- | main/versions.html | 4 | ||||
-rw-r--r-- | v7.1.1/.buildinfo | 2 | ||||
-rw-r--r-- | v7.1.1/.doctrees/changelog.doctree | bin | 64686 -> 64686 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/environment.pickle | bin | 2634220 -> 2634202 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/index.doctree | bin | 5445 -> 5445 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/output/botcore.async_stats.doctree | bin | 18992 -> 18992 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/output/botcore.doctree | bin | 62401 -> 62401 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/output/botcore.exts.doctree | bin | 3091 -> 3091 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/output/botcore.site_api.doctree | bin | 65215 -> 65215 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/output/botcore.utils.caching.doctree | bin | 16590 -> 16590 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/output/botcore.utils.channel.doctree | bin | 17681 -> 17681 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/output/botcore.utils.doctree | bin | 13965 -> 13965 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/output/botcore.utils.logging.doctree | bin | 18135 -> 18135 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/output/botcore.utils.members.doctree | bin | 16844 -> 16844 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/output/botcore.utils.regex.doctree | bin | 9013 -> 9013 bytes | |||
-rw-r--r-- | v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree | bin | 53663 -> 53663 bytes | |||
-rw-r--r-- | v7.1.1/changelog.html | 2 | ||||
-rw-r--r-- | v7.1.1/genindex.html | 2 | ||||
-rw-r--r-- | v7.1.1/index.html | 2 | ||||
-rw-r--r-- | v7.1.1/output/botcore.async_stats.html | 2 | ||||
-rw-r--r-- | v7.1.1/output/botcore.exts.html | 2 | ||||
-rw-r--r-- | v7.1.1/output/botcore.html | 2 | ||||
-rw-r--r-- | v7.1.1/output/botcore.site_api.html | 2 | ||||
-rw-r--r-- | v7.1.1/output/botcore.utils.caching.html | 2 | ||||
-rw-r--r-- | v7.1.1/output/botcore.utils.channel.html | 2 | ||||
-rw-r--r-- | v7.1.1/output/botcore.utils.html | 2 | ||||
-rw-r--r-- | v7.1.1/output/botcore.utils.logging.html | 2 | ||||
-rw-r--r-- | v7.1.1/output/botcore.utils.members.html | 2 | ||||
-rw-r--r-- | v7.1.1/output/botcore.utils.regex.html | 2 | ||||
-rw-r--r-- | v7.1.1/output/botcore.utils.scheduling.html | 2 | ||||
-rw-r--r-- | v7.1.1/py-modindex.html | 2 | ||||
-rw-r--r-- | v7.1.1/search.html | 2 | ||||
-rw-r--r-- | v7.1.1/versions.html | 4 | ||||
-rw-r--r-- | v7.1.2/.buildinfo | 2 | ||||
-rw-r--r-- | v7.1.2/.doctrees/changelog.doctree | bin | 65755 -> 65755 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/environment.pickle | bin | 2634220 -> 2634202 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/index.doctree | bin | 5445 -> 5445 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/output/botcore.async_stats.doctree | bin | 18992 -> 18992 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/output/botcore.doctree | bin | 62401 -> 62401 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/output/botcore.exts.doctree | bin | 3091 -> 3091 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/output/botcore.site_api.doctree | bin | 65269 -> 65269 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/output/botcore.utils.caching.doctree | bin | 16590 -> 16590 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/output/botcore.utils.channel.doctree | bin | 17681 -> 17681 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/output/botcore.utils.doctree | bin | 13965 -> 13965 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/output/botcore.utils.logging.doctree | bin | 18135 -> 18135 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/output/botcore.utils.members.doctree | bin | 16844 -> 16844 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/output/botcore.utils.regex.doctree | bin | 9013 -> 9013 bytes | |||
-rw-r--r-- | v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree | bin | 53663 -> 53663 bytes | |||
-rw-r--r-- | v7.1.2/changelog.html | 2 | ||||
-rw-r--r-- | v7.1.2/genindex.html | 2 | ||||
-rw-r--r-- | v7.1.2/index.html | 2 | ||||
-rw-r--r-- | v7.1.2/output/botcore.async_stats.html | 2 | ||||
-rw-r--r-- | v7.1.2/output/botcore.exts.html | 2 | ||||
-rw-r--r-- | v7.1.2/output/botcore.html | 2 | ||||
-rw-r--r-- | v7.1.2/output/botcore.site_api.html | 2 | ||||
-rw-r--r-- | v7.1.2/output/botcore.utils.caching.html | 2 | ||||
-rw-r--r-- | v7.1.2/output/botcore.utils.channel.html | 2 | ||||
-rw-r--r-- | v7.1.2/output/botcore.utils.html | 2 | ||||
-rw-r--r-- | v7.1.2/output/botcore.utils.logging.html | 2 | ||||
-rw-r--r-- | v7.1.2/output/botcore.utils.members.html | 2 | ||||
-rw-r--r-- | v7.1.2/output/botcore.utils.regex.html | 2 | ||||
-rw-r--r-- | v7.1.2/output/botcore.utils.scheduling.html | 2 | ||||
-rw-r--r-- | v7.1.2/py-modindex.html | 2 | ||||
-rw-r--r-- | v7.1.2/search.html | 2 | ||||
-rw-r--r-- | v7.1.2/versions.html | 4 | ||||
-rw-r--r-- | v7.1.3/.buildinfo | 2 | ||||
-rw-r--r-- | v7.1.3/.doctrees/changelog.doctree | bin | 65755 -> 65755 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/environment.pickle | bin | 2634220 -> 707028 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/index.doctree | bin | 5445 -> 5445 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/output/botcore.async_stats.doctree | bin | 18992 -> 18992 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/output/botcore.doctree | bin | 62401 -> 62401 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/output/botcore.exts.doctree | bin | 3091 -> 3091 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/output/botcore.site_api.doctree | bin | 65271 -> 65271 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/output/botcore.utils.caching.doctree | bin | 16590 -> 16590 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/output/botcore.utils.channel.doctree | bin | 17681 -> 17681 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/output/botcore.utils.doctree | bin | 13965 -> 13965 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/output/botcore.utils.logging.doctree | bin | 18135 -> 18135 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/output/botcore.utils.members.doctree | bin | 16844 -> 16844 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/output/botcore.utils.regex.doctree | bin | 9013 -> 9013 bytes | |||
-rw-r--r-- | v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree | bin | 53663 -> 53663 bytes | |||
-rw-r--r-- | v7.1.3/changelog.html | 2 | ||||
-rw-r--r-- | v7.1.3/genindex.html | 2 | ||||
-rw-r--r-- | v7.1.3/index.html | 2 | ||||
-rw-r--r-- | v7.1.3/output/botcore.async_stats.html | 16 | ||||
-rw-r--r-- | v7.1.3/output/botcore.exts.html | 2 | ||||
-rw-r--r-- | v7.1.3/output/botcore.html | 38 | ||||
-rw-r--r-- | v7.1.3/output/botcore.site_api.html | 40 | ||||
-rw-r--r-- | v7.1.3/output/botcore.utils.caching.html | 12 | ||||
-rw-r--r-- | v7.1.3/output/botcore.utils.channel.html | 8 | ||||
-rw-r--r-- | v7.1.3/output/botcore.utils.html | 8 | ||||
-rw-r--r-- | v7.1.3/output/botcore.utils.logging.html | 12 | ||||
-rw-r--r-- | v7.1.3/output/botcore.utils.members.html | 10 | ||||
-rw-r--r-- | v7.1.3/output/botcore.utils.regex.html | 4 | ||||
-rw-r--r-- | v7.1.3/output/botcore.utils.scheduling.html | 54 | ||||
-rw-r--r-- | v7.1.3/py-modindex.html | 2 | ||||
-rw-r--r-- | v7.1.3/search.html | 2 | ||||
-rw-r--r-- | v7.1.3/versions.html | 4 | ||||
-rw-r--r-- | v7.2.0/.buildinfo (renamed from v7.2.0-alpha/.buildinfo) | 2 | ||||
-rw-r--r-- | v7.2.0/.doctrees/changelog.doctree (renamed from v7.2.0-alpha/.doctrees/changelog.doctree) | bin | 67915 -> 67877 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/environment.pickle (renamed from v7.2.0-alpha/.doctrees/environment.pickle) | bin | 2634232 -> 2634202 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/index.doctree (renamed from v7.2.0-alpha/.doctrees/index.doctree) | bin | 5445 -> 5445 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/output/botcore.async_stats.doctree (renamed from v7.2.0-alpha/.doctrees/output/botcore.async_stats.doctree) | bin | 18992 -> 18992 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/output/botcore.doctree (renamed from v7.2.0-alpha/.doctrees/output/botcore.doctree) | bin | 62401 -> 62401 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/output/botcore.exts.doctree (renamed from v7.2.0-alpha/.doctrees/output/botcore.exts.doctree) | bin | 3091 -> 3091 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/output/botcore.site_api.doctree (renamed from v7.2.0-alpha/.doctrees/output/botcore.site_api.doctree) | bin | 65215 -> 65215 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/output/botcore.utils.caching.doctree (renamed from v7.2.0-alpha/.doctrees/output/botcore.utils.caching.doctree) | bin | 16590 -> 16590 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/output/botcore.utils.channel.doctree (renamed from v7.2.0-alpha/.doctrees/output/botcore.utils.channel.doctree) | bin | 17681 -> 17681 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/output/botcore.utils.doctree (renamed from v7.2.0-alpha/.doctrees/output/botcore.utils.doctree) | bin | 13965 -> 13965 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/output/botcore.utils.logging.doctree (renamed from v7.2.0-alpha/.doctrees/output/botcore.utils.logging.doctree) | bin | 18135 -> 18135 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/output/botcore.utils.members.doctree (renamed from v7.2.0-alpha/.doctrees/output/botcore.utils.members.doctree) | bin | 16844 -> 16844 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/output/botcore.utils.regex.doctree (renamed from v7.2.0-alpha/.doctrees/output/botcore.utils.regex.doctree) | bin | 9013 -> 9013 bytes | |||
-rw-r--r-- | v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree (renamed from v7.2.0-alpha/.doctrees/output/botcore.utils.scheduling.doctree) | bin | 53663 -> 53663 bytes | |||
-rw-r--r-- | v7.2.0/.nojekyll (renamed from v7.2.0-alpha/.nojekyll) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/changelog.rst.txt (renamed from v7.2.0-alpha/_sources/changelog.rst.txt) | 2 | ||||
-rw-r--r-- | v7.2.0/_sources/index.rst.txt (renamed from v7.2.0-alpha/_sources/index.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/output/botcore.async_stats.rst.txt (renamed from v7.2.0-alpha/_sources/output/botcore.async_stats.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/output/botcore.exts.rst.txt (renamed from v7.2.0-alpha/_sources/output/botcore.exts.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/output/botcore.rst.txt (renamed from v7.2.0-alpha/_sources/output/botcore.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/output/botcore.site_api.rst.txt (renamed from v7.2.0-alpha/_sources/output/botcore.site_api.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/output/botcore.utils.caching.rst.txt (renamed from v7.2.0-alpha/_sources/output/botcore.utils.caching.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/output/botcore.utils.channel.rst.txt (renamed from v7.2.0-alpha/_sources/output/botcore.utils.channel.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/output/botcore.utils.logging.rst.txt (renamed from v7.2.0-alpha/_sources/output/botcore.utils.logging.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/output/botcore.utils.members.rst.txt (renamed from v7.2.0-alpha/_sources/output/botcore.utils.members.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/output/botcore.utils.regex.rst.txt (renamed from v7.2.0-alpha/_sources/output/botcore.utils.regex.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/output/botcore.utils.rst.txt (renamed from v7.2.0-alpha/_sources/output/botcore.utils.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_sources/output/botcore.utils.scheduling.rst.txt (renamed from v7.2.0-alpha/_sources/output/botcore.utils.scheduling.rst.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/_sphinx_javascript_frameworks_compat.js (renamed from v7.2.0-alpha/_static/_sphinx_javascript_frameworks_compat.js) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/basic.css (renamed from v7.2.0-alpha/_static/basic.css) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/changelog.css (renamed from v7.2.0-alpha/_static/changelog.css) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/changelog.js (renamed from v7.2.0-alpha/_static/changelog.js) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/debug.css (renamed from v7.2.0-alpha/_static/debug.css) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/doctools.js (renamed from v7.2.0-alpha/_static/doctools.js) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/documentation_options.js (renamed from v7.2.0-alpha/_static/documentation_options.js) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/file.png (renamed from v7.2.0-alpha/_static/file.png) | bin | 286 -> 286 bytes | |||
-rw-r--r-- | v7.2.0/_static/index.css (renamed from v7.2.0-alpha/_static/index.css) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/jquery-3.6.0.js (renamed from v7.2.0-alpha/_static/jquery-3.6.0.js) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/jquery.js (renamed from v7.2.0-alpha/_static/jquery.js) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/language_data.js (renamed from v7.2.0-alpha/_static/language_data.js) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/logo.css (renamed from v7.2.0-alpha/_static/logo.css) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/minus.png (renamed from v7.2.0-alpha/_static/minus.png) | bin | 90 -> 90 bytes | |||
-rw-r--r-- | v7.2.0/_static/plus.png (renamed from v7.2.0-alpha/_static/plus.png) | bin | 90 -> 90 bytes | |||
-rw-r--r-- | v7.2.0/_static/pygments.css (renamed from v7.2.0-alpha/_static/pygments.css) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/scripts/furo-extensions.js (renamed from v7.2.0-alpha/_static/scripts/furo-extensions.js) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/scripts/furo.js (renamed from v7.2.0-alpha/_static/scripts/furo.js) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/scripts/furo.js.LICENSE.txt (renamed from v7.2.0-alpha/_static/scripts/furo.js.LICENSE.txt) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/scripts/furo.js.map (renamed from v7.2.0-alpha/_static/scripts/furo.js.map) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/searchtools.js (renamed from v7.2.0-alpha/_static/searchtools.js) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/skeleton.css (renamed from v7.2.0-alpha/_static/skeleton.css) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/statsd_additional_objects.inv (renamed from v7.2.0-alpha/_static/statsd_additional_objects.inv) | bin | 308 -> 308 bytes | |||
-rw-r--r-- | v7.2.0/_static/styles/furo-extensions.css (renamed from v7.2.0-alpha/_static/styles/furo-extensions.css) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/styles/furo-extensions.css.map (renamed from v7.2.0-alpha/_static/styles/furo-extensions.css.map) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/styles/furo.css (renamed from v7.2.0-alpha/_static/styles/furo.css) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/styles/furo.css.map (renamed from v7.2.0-alpha/_static/styles/furo.css.map) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/underscore-1.13.1.js (renamed from v7.2.0-alpha/_static/underscore-1.13.1.js) | 0 | ||||
-rw-r--r-- | v7.2.0/_static/underscore.js (renamed from v7.2.0-alpha/_static/underscore.js) | 0 | ||||
-rw-r--r-- | v7.2.0/changelog.html (renamed from v7.2.0-alpha/changelog.html) | 8 | ||||
-rw-r--r-- | v7.2.0/genindex.html (renamed from v7.2.0-alpha/genindex.html) | 8 | ||||
-rw-r--r-- | v7.2.0/index.html (renamed from v7.2.0-alpha/index.html) | 8 | ||||
-rw-r--r-- | v7.2.0/index_redirect.html (renamed from v7.2.0-alpha/index_redirect.html) | 2 | ||||
-rw-r--r-- | v7.2.0/objects.inv (renamed from v7.2.0-alpha/objects.inv) | bin | 1115 -> 1115 bytes | |||
-rw-r--r-- | v7.2.0/output/botcore.async_stats.html (renamed from v7.2.0-alpha/output/botcore.async_stats.html) | 14 | ||||
-rw-r--r-- | v7.2.0/output/botcore.exts.html (renamed from v7.2.0-alpha/output/botcore.exts.html) | 8 | ||||
-rw-r--r-- | v7.2.0/output/botcore.html (renamed from v7.2.0-alpha/output/botcore.html) | 40 | ||||
-rw-r--r-- | v7.2.0/output/botcore.site_api.html (renamed from v7.2.0-alpha/output/botcore.site_api.html) | 34 | ||||
-rw-r--r-- | v7.2.0/output/botcore.utils.caching.html (renamed from v7.2.0-alpha/output/botcore.utils.caching.html) | 16 | ||||
-rw-r--r-- | v7.2.0/output/botcore.utils.channel.html (renamed from v7.2.0-alpha/output/botcore.utils.channel.html) | 12 | ||||
-rw-r--r-- | v7.2.0/output/botcore.utils.html (renamed from v7.2.0-alpha/output/botcore.utils.html) | 12 | ||||
-rw-r--r-- | v7.2.0/output/botcore.utils.logging.html (renamed from v7.2.0-alpha/output/botcore.utils.logging.html) | 14 | ||||
-rw-r--r-- | v7.2.0/output/botcore.utils.members.html (renamed from v7.2.0-alpha/output/botcore.utils.members.html) | 12 | ||||
-rw-r--r-- | v7.2.0/output/botcore.utils.regex.html (renamed from v7.2.0-alpha/output/botcore.utils.regex.html) | 14 | ||||
-rw-r--r-- | v7.2.0/output/botcore.utils.scheduling.html (renamed from v7.2.0-alpha/output/botcore.utils.scheduling.html) | 26 | ||||
-rw-r--r-- | v7.2.0/py-modindex.html (renamed from v7.2.0-alpha/py-modindex.html) | 8 | ||||
-rw-r--r-- | v7.2.0/search.html (renamed from v7.2.0-alpha/search.html) | 8 | ||||
-rw-r--r-- | v7.2.0/searchindex.js (renamed from v7.2.0-alpha/searchindex.js) | 0 | ||||
-rw-r--r-- | v7.2.0/versions.html (renamed from v7.2.0-alpha/versions.html) | 10 |
206 files changed, 353 insertions, 353 deletions
diff --git a/main/.buildinfo b/main/.buildinfo index 57e397fb..3c01d855 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: f096eed24f4b676c12c74020238beea3 +config: ed7640c9afd7554cfba6ebbb13f67310 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/changelog.doctree b/main/.doctrees/changelog.doctree Binary files differindex a52a3970..1a0bb58a 100644 --- a/main/.doctrees/changelog.doctree +++ b/main/.doctrees/changelog.doctree diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle Binary files differindex d830b5a6..6ebb611d 100644 --- a/main/.doctrees/environment.pickle +++ b/main/.doctrees/environment.pickle diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree Binary files differindex 0ea2af3e..248a518d 100644 --- a/main/.doctrees/index.doctree +++ b/main/.doctrees/index.doctree diff --git a/main/.doctrees/output/botcore.async_stats.doctree b/main/.doctrees/output/botcore.async_stats.doctree Binary files differindex 752d0cfa..57a4f760 100644 --- a/main/.doctrees/output/botcore.async_stats.doctree +++ b/main/.doctrees/output/botcore.async_stats.doctree diff --git a/main/.doctrees/output/botcore.doctree b/main/.doctrees/output/botcore.doctree Binary files differindex d645a9cb..3d9cf18e 100644 --- a/main/.doctrees/output/botcore.doctree +++ b/main/.doctrees/output/botcore.doctree diff --git a/main/.doctrees/output/botcore.exts.doctree b/main/.doctrees/output/botcore.exts.doctree Binary files differindex 4de30dbe..e833dbda 100644 --- a/main/.doctrees/output/botcore.exts.doctree +++ b/main/.doctrees/output/botcore.exts.doctree diff --git a/main/.doctrees/output/botcore.site_api.doctree b/main/.doctrees/output/botcore.site_api.doctree Binary files differindex ec52e6f7..8ad0ee0f 100644 --- a/main/.doctrees/output/botcore.site_api.doctree +++ b/main/.doctrees/output/botcore.site_api.doctree diff --git a/main/.doctrees/output/botcore.utils.caching.doctree b/main/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 5d191980..da35fbb0 100644 --- a/main/.doctrees/output/botcore.utils.caching.doctree +++ b/main/.doctrees/output/botcore.utils.caching.doctree diff --git a/main/.doctrees/output/botcore.utils.channel.doctree b/main/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 8dc69d73..2f3369e1 100644 --- a/main/.doctrees/output/botcore.utils.channel.doctree +++ b/main/.doctrees/output/botcore.utils.channel.doctree diff --git a/main/.doctrees/output/botcore.utils.doctree b/main/.doctrees/output/botcore.utils.doctree Binary files differindex c9b30603..9be1c467 100644 --- a/main/.doctrees/output/botcore.utils.doctree +++ b/main/.doctrees/output/botcore.utils.doctree diff --git a/main/.doctrees/output/botcore.utils.logging.doctree b/main/.doctrees/output/botcore.utils.logging.doctree Binary files differindex a2fb1a5f..0a5426e9 100644 --- a/main/.doctrees/output/botcore.utils.logging.doctree +++ b/main/.doctrees/output/botcore.utils.logging.doctree diff --git a/main/.doctrees/output/botcore.utils.members.doctree b/main/.doctrees/output/botcore.utils.members.doctree Binary files differindex 87dbd29b..2c3c0c47 100644 --- a/main/.doctrees/output/botcore.utils.members.doctree +++ b/main/.doctrees/output/botcore.utils.members.doctree diff --git a/main/.doctrees/output/botcore.utils.regex.doctree b/main/.doctrees/output/botcore.utils.regex.doctree Binary files differindex a42255e9..88adb21f 100644 --- a/main/.doctrees/output/botcore.utils.regex.doctree +++ b/main/.doctrees/output/botcore.utils.regex.doctree diff --git a/main/.doctrees/output/botcore.utils.scheduling.doctree b/main/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex bf0e55d1..c2ed9b08 100644 --- a/main/.doctrees/output/botcore.utils.scheduling.doctree +++ b/main/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/main/changelog.html b/main/changelog.html index 6ae2bc30..0712ae4d 100644 --- a/main/changelog.html +++ b/main/changelog.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/changelog.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/changelog.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/main/genindex.html b/main/genindex.html index d3b2bd94..90bc4483 100644 --- a/main/genindex.html +++ b/main/genindex.html @@ -203,7 +203,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/main/index.html b/main/index.html index aff6afd2..a4b5f0b2 100644 --- a/main/index.html +++ b/main/index.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/main/output/botcore.async_stats.html b/main/output/botcore.async_stats.html index 614be4b0..6fa24c76 100644 --- a/main/output/botcore.async_stats.html +++ b/main/output/botcore.async_stats.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.async_stats.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.async_stats.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,12 +279,12 @@ <p>An async transport method for statsd communication.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncStatsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/async_stats.py#L12-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncStatsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/async_stats.py#L12-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatsClientBase</span></code></a></p> <p>An async implementation of <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statsd.client.base.StatsClientBase</span></code></a> that supports async stat communication.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/async_stats.py#L15-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/async_stats.py#L15-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Create a new <a class="reference internal" href="#botcore.async_stats.AsyncStatsClient" title="botcore.async_stats.AsyncStatsClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncStatsClient</span></code></a>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -301,7 +301,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient.create_socket"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_socket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/async_stats.py#L40-L47"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.create_socket" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_socket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/async_stats.py#L40-L47"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.create_socket" title="Permalink to this definition">#</a></dt> <dd><p>Use <a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code></a> from the loop given on init to create a socket.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> diff --git a/main/output/botcore.exts.html b/main/output/botcore.exts.html index c5423fe9..caafa920 100644 --- a/main/output/botcore.exts.html +++ b/main/output/botcore.exts.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.exts.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.exts.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/main/output/botcore.html b/main/output/botcore.html index c46768bf..48b96def 100644 --- a/main/output/botcore.html +++ b/main/output/botcore.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,12 +279,12 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.BotBase"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">BotBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L36-L290"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">BotBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L36-L290"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></p> <p>A sub-class that implements many common features that Python Discord bots use.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L39-L89"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L39-L89"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialise the base bot instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -303,7 +303,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.add_cog"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_cog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cog</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L152-L156"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_cog" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_cog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cog</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L152-L156"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_cog" title="Permalink to this definition">#</a></dt> <dd><p>Add the given <code class="docutils literal notranslate"><span class="pre">cog</span></code> to the bot and log the operation.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -314,7 +314,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.add_command"> -<span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L157-L161"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_command" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L157-L161"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_command" title="Permalink to this definition">#</a></dt> <dd><p>Add <code class="docutils literal notranslate"><span class="pre">command</span></code> as normal and then add its root aliases to the bot.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -325,7 +325,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.clear"> -<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L177-L180"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.clear" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L177-L180"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.clear" title="Permalink to this definition">#</a></dt> <dd><p>Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -336,7 +336,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L256-L290"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.close" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L256-L290"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.close" title="Permalink to this definition">#</a></dt> <dd><p>Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -347,7 +347,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.load_extensions"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_extensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L119-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.load_extensions" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_extensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L119-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.load_extensions" title="Permalink to this definition">#</a></dt> <dd><p>Load all the extensions within the given module and save them to <code class="docutils literal notranslate"><span class="pre">self.all_extensions</span></code>.</p> <p>This should be ran in a task on the event loop to avoid deadlocks caused by <code class="docutils literal notranslate"><span class="pre">wait_for</span></code> calls.</p> <dl class="field-list simple"> @@ -359,7 +359,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.log_to_dev_log"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">log_to_dev_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L205-L208"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.log_to_dev_log" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">log_to_dev_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L205-L208"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.log_to_dev_log" title="Permalink to this definition">#</a></dt> <dd><p>Log the given message to #dev-log.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -370,7 +370,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.on_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L188-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_available" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L188-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_available" title="Permalink to this definition">#</a></dt> <dd><p>Set the internal guild available event when self.guild_id becomes available.</p> <p>If the cache appears to still be empty (no members, no channels, or no roles), the event will not be set and <cite>guild_available_but_cache_empty</cite> event will be emitted.</p> @@ -383,7 +383,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.on_guild_unavailable"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L181-L187"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_unavailable" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L181-L187"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_unavailable" title="Permalink to this definition">#</a></dt> <dd><p>Clear the internal guild available event when self.guild_id becomes unavailable.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -394,7 +394,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.ping_services"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ping_services</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L252-L255"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.ping_services" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ping_services</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L252-L255"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.ping_services" title="Permalink to this definition">#</a></dt> <dd><p>Ping all required services on setup to ensure they are up before starting.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -405,7 +405,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.remove_command"> -<span class="sig-name descname"><span class="pre">remove_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L162-L176"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.remove_command" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">remove_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L162-L176"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.remove_command" title="Permalink to this definition">#</a></dt> <dd><p>Remove a command/alias as normal and then remove its root aliases from the bot.</p> <p>Individual root aliases cannot be removed by this function. To remove them, either remove the entire command or manually edit <cite>bot.all_commands</cite>.</p> @@ -418,7 +418,7 @@ To remove them, either remove the entire command or manually edit <cite>bot.all_ <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.setup_hook"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_hook</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L218-L251"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.setup_hook" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_hook</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L218-L251"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.setup_hook" title="Permalink to this definition">#</a></dt> <dd><p>An async init to startup generic services.</p> <p>Connects to statsd, and calls <a class="reference internal" href="botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.create_socket" title="botcore.async_stats.AsyncStatsClient.create_socket"><code class="xref py py-func docutils literal notranslate"><span class="pre">AsyncStatsClient.create_socket</span></code></a> @@ -432,7 +432,7 @@ and <a class="reference internal" href="#botcore.BotBase.ping_services" title="b <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.wait_until_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait_until_guild_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L209-L217"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.wait_until_guild_available" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait_until_guild_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L209-L217"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.wait_until_guild_available" title="Permalink to this definition">#</a></dt> <dd><p>Wait until the guild that matches the <code class="docutils literal notranslate"><span class="pre">guild_id</span></code> given at init is available (and the cache is ready).</p> <p>The on_ready event is inadequate because it only waits 2 seconds for a GUILD_CREATE gateway event before giving up and thus not populating the cache for unavailable guilds.</p> @@ -447,12 +447,12 @@ gateway event before giving up and thus not populating the cache for unavailable <dl class="py exception"> <dt class="sig sig-object py" id="botcore.StartupError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">StartupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L28-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">StartupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L28-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Exception class for startup errors.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.StartupError.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L31-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/__init__.py#L31-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError.__init__" title="Permalink to this definition">#</a></dt> <dd></dd></dl> </dd></dl> diff --git a/main/output/botcore.site_api.html b/main/output/botcore.site_api.html index 9ca23a13..097763be 100644 --- a/main/output/botcore.site_api.html +++ b/main/output/botcore.site_api.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.site_api.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.site_api.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,12 +279,12 @@ <p>An API wrapper around the Site API.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.site_api.APIClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L42-L154"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L42-L154"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>A wrapper for the Django Site API.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L48-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L48-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">APIClient</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -299,7 +299,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L75-L78"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.close" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L75-L78"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.close" title="Permalink to this definition">#</a></dt> <dd><p>Close the aiohttp session.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -310,7 +310,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.delete"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L136-L154"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.delete" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L136-L154"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.delete" title="Permalink to this definition">#</a></dt> <dd><p>Send a DELETE request to the site API and return the JSON response.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -331,7 +331,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.get"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L120-L123"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.get" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L120-L123"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.get" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with GET passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -342,7 +342,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.maybe_raise_for_status"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maybe_raise_for_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">should_raise</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L79-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.maybe_raise_for_status" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maybe_raise_for_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">should_raise</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L79-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.maybe_raise_for_status" title="Permalink to this definition">#</a></dt> <dd><p>Raise <a class="reference internal" href="#botcore.site_api.ResponseCodeError" title="botcore.site_api.ResponseCodeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a> for non-OK response if an exception should be raised.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -362,7 +362,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.patch"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">patch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L124-L127"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.patch" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">patch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L124-L127"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.patch" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PATCH passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -373,7 +373,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.post"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L128-L131"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.post" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L128-L131"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.post" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with POST passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -384,7 +384,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.put"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">put</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L132-L135"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.put" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">put</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L132-L135"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.put" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PUT passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -395,7 +395,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.request"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L99-L119"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.request" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L99-L119"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.request" title="Permalink to this definition">#</a></dt> <dd><p>Send an HTTP request to the site API and return the JSON response.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -422,12 +422,12 @@ <dl class="py exception"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L14-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L14-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></a></p> <p>Raised in <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> when a non-OK HTTP response is received.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L17-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L17-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#botcore.site_api.ResponseCodeError" title="botcore.site_api.ResponseCodeError"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -442,7 +442,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError.__str__"> -<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L36-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__str__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/site_api.py#L36-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__str__" title="Permalink to this definition">#</a></dt> <dd><p>Return a string representation of the error.</p> </dd></dl> diff --git a/main/output/botcore.utils.caching.html b/main/output/botcore.utils.caching.html index ee828d6f..34996381 100644 --- a/main/output/botcore.utils.caching.html +++ b/main/output/botcore.utils.caching.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.caching.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.caching.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,14 +279,14 @@ <p>Utilities related to custom caches.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>LRU cache implementation for coroutines.</p> <p>Once the cache exceeds the maximum size, keys are deleted in FIFO order.</p> <p>An offset may be optionally provided to be applied to the coroutine’s arguments when creating the cache key.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.__call__"> -<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__call__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__call__" title="Permalink to this definition">#</a></dt> <dd><p>Decorator for async cache.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -303,7 +303,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialise a new <a class="reference internal" href="#botcore.utils.caching.AsyncCache" title="botcore.utils.caching.AsyncCache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncCache</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -314,7 +314,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.clear"> -<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.clear" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.clear" title="Permalink to this definition">#</a></dt> <dd><p>Clear cache instance.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> diff --git a/main/output/botcore.utils.channel.html b/main/output/botcore.utils.channel.html index 89f188aa..120ee4d4 100644 --- a/main/output/botcore.utils.channel.html +++ b/main/output/botcore.utils.channel.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.channel.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.channel.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,7 +279,7 @@ <p>Useful helper functions for interacting with various discord channel objects.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.channel.get_or_fetch_channel"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/channel.py#L25-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.get_or_fetch_channel" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/channel.py#L25-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.get_or_fetch_channel" title="Permalink to this definition">#</a></dt> <dd><p>Attempt to get or fetch the given <code class="docutils literal notranslate"><span class="pre">channel_id</span></code> from the bots cache, and return it.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -307,7 +307,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.channel.is_in_category"> -<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.is_in_category" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.is_in_category" title="Permalink to this definition">#</a></dt> <dd><p>Return whether the given <code class="docutils literal notranslate"><span class="pre">channel</span></code> in the the category with the id <code class="docutils literal notranslate"><span class="pre">category_id</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> diff --git a/main/output/botcore.utils.html b/main/output/botcore.utils.html index fefc93e8..68e0d293 100644 --- a/main/output/botcore.utils.html +++ b/main/output/botcore.utils.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,7 +279,7 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.apply_monkey_patches"> -<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/__init__.py#L7-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/__init__.py#L7-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt> <dd><p>Applies all common monkey patches for our bots.</p> <dl> <dt>Patches <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Command</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Group" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Group</span></code></a> to support root aliases.</dt><dd><p>A <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code> keyword argument is added to these two objects, which is a sequence of alias names @@ -298,7 +298,7 @@ that will act as top-level groups rather than being aliases of the command’s g <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.unqualify"> -<span class="sig-name descname"><span class="pre">unqualify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/__init__.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.unqualify" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">unqualify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/__init__.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.unqualify" title="Permalink to this definition">#</a></dt> <dd><p>Return an unqualified name given a qualified module/package <code class="docutils literal notranslate"><span class="pre">name</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> diff --git a/main/output/botcore.utils.logging.html b/main/output/botcore.utils.logging.html index 6d30a636..13d7bd27 100644 --- a/main/output/botcore.utils.logging.html +++ b/main/output/botcore.utils.logging.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.logging.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.logging.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,12 +279,12 @@ <p>Common logging related functions.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/logging.py#L14-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/logging.py#L14-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Logger</span></code></a></p> <p>Custom implementation of the <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.Logger</span></code></a> class with an added <a class="reference internal" href="#botcore.utils.logging.CustomLogger.trace" title="botcore.utils.logging.CustomLogger.trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trace</span></code></a> method.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger.trace"> -<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/logging.py#L17-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger.trace" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/logging.py#L17-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger.trace" title="Permalink to this definition">#</a></dt> <dd><p>Log the given message with the severity <code class="docutils literal notranslate"><span class="pre">"TRACE"</span></code>.</p> <p>To pass exception information, use the keyword argument exc_info with a true value:</p> <div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">logger</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s2">"Houston, we have an </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"interesting problem"</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> @@ -308,7 +308,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.logging.get_logger"> -<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/logging.py#L35-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.get_logger" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/logging.py#L35-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.get_logger" title="Permalink to this definition">#</a></dt> <dd><p>Utility to make mypy recognise that logger is of type <a class="reference internal" href="#botcore.utils.logging.CustomLogger" title="botcore.utils.logging.CustomLogger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CustomLogger</span></code></a>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> diff --git a/main/output/botcore.utils.members.html b/main/output/botcore.utils.members.html index 8ef550b3..e398f16f 100644 --- a/main/output/botcore.utils.members.html +++ b/main/output/botcore.utils.members.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.members.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.members.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,7 +279,7 @@ <p>Useful helper functions for interactin with <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> objects.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.members.get_or_fetch_member"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_member</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/members.py#L12-L29"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.get_or_fetch_member" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_member</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/members.py#L12-L29"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.get_or_fetch_member" title="Permalink to this definition">#</a></dt> <dd><p>Attempt to get a member from cache; on failure fetch from the API.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -293,7 +293,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.members.handle_role_change"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_role_change</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/members.py#L31-L57"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.handle_role_change" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_role_change</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/members.py#L31-L57"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.handle_role_change" title="Permalink to this definition">#</a></dt> <dd><p>Await the given <code class="docutils literal notranslate"><span class="pre">coro</span></code> with <code class="docutils literal notranslate"><span class="pre">member</span></code> as the sole argument.</p> <p>Handle errors that we expect to be raised from <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p> diff --git a/main/output/botcore.utils.regex.html b/main/output/botcore.utils.regex.html index c0b1dc3a..8e578376 100644 --- a/main/output/botcore.utils.regex.html +++ b/main/output/botcore.utils.regex.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.regex.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.regex.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,7 +279,7 @@ <p>Common regular expressions.</p> <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.DISCORD_INVITE"> -<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/regex.py#L5-L16"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.DISCORD_INVITE" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/regex.py#L5-L16"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.DISCORD_INVITE" title="Permalink to this definition">#</a></dt> <dd><p>Regex for Discord server invites.</p> <div class="admonition warning"> <p class="admonition-title">Warning</p> @@ -293,7 +293,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.FORMATTED_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/regex.py#L28-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.FORMATTED_CODE_REGEX" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/regex.py#L28-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.FORMATTED_CODE_REGEX" title="Permalink to this definition">#</a></dt> <dd><p>Regex for formatted code, using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> @@ -301,7 +301,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.RAW_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/regex.py#L43-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.RAW_CODE_REGEX" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/regex.py#L43-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.RAW_CODE_REGEX" title="Permalink to this definition">#</a></dt> <dd><p>Regex for raw code, <em>not</em> using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> diff --git a/main/output/botcore.utils.scheduling.html b/main/output/botcore.utils.scheduling.html index b9e84a1e..8e659cc8 100644 --- a/main/output/botcore.utils.scheduling.html +++ b/main/output/botcore.utils.scheduling.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.scheduling.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.scheduling.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,7 +279,7 @@ <p>Generic python scheduler.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L13-L209"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/scheduling.py#L13-L209"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>Schedule the execution of coroutines and keep track of them.</p> <p>When instantiating a <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a>, a name must be provided. This name is used to distinguish the @@ -293,7 +293,7 @@ the same ID used to schedule it.</p> <p>Any exception raised in a scheduled task is logged when the task is done.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.__contains__"> -<span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L43-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__contains__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/scheduling.py#L43-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__contains__" title="Permalink to this definition">#</a></dt> <dd><p>Return <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> if a task with the given <code class="docutils literal notranslate"><span class="pre">task_id</span></code> is currently scheduled.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -310,7 +310,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L31-L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/scheduling.py#L31-L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -321,7 +321,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.cancel"> -<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L125-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/scheduling.py#L125-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel" title="Permalink to this definition">#</a></dt> <dd><p>Unschedule the task identified by <code class="docutils literal notranslate"><span class="pre">task_id</span></code>. Log a warning if the task doesn’t exist.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -335,7 +335,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.cancel_all"> -<span class="sig-name descname"><span class="pre">cancel_all</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L143-L149"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel_all" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">cancel_all</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/scheduling.py#L143-L149"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel_all" title="Permalink to this definition">#</a></dt> <dd><p>Unschedule all known tasks.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -346,7 +346,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule"> -<span class="sig-name descname"><span class="pre">schedule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L55-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/scheduling.py#L55-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule" title="Permalink to this definition">#</a></dt> <dd><p>Schedule the execution of a <code class="docutils literal notranslate"><span class="pre">coroutine</span></code>.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> @@ -365,7 +365,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule_at"> -<span class="sig-name descname"><span class="pre">schedule_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L82-L105"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_at" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/scheduling.py#L82-L105"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_at" title="Permalink to this definition">#</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed at the given <code class="docutils literal notranslate"><span class="pre">time</span></code>.</p> <p>If <code class="docutils literal notranslate"><span class="pre">time</span></code> is timezone aware, then use that timezone to calculate now() when subtracting. If <code class="docutils literal notranslate"><span class="pre">time</span></code> is naïve, then use UTC.</p> @@ -388,7 +388,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule_later"> -<span class="sig-name descname"><span class="pre">schedule_later</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L106-L124"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_later" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule_later</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/scheduling.py#L106-L124"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_later" title="Permalink to this definition">#</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed after <code class="docutils literal notranslate"><span class="pre">delay</span></code> seconds.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> @@ -410,7 +410,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.scheduling.create_task"> -<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suppressed_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_loop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L211-L239"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.create_task" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suppressed_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_loop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/28be7e1e8b712084a883a9199028c0cab876361c/botcore/utils/scheduling.py#L211-L239"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.create_task" title="Permalink to this definition">#</a></dt> <dd><p>Wrapper for creating an <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.Task</span></code></a> which logs exceptions raised in the task.</p> <p>If the <code class="docutils literal notranslate"><span class="pre">event_loop</span></code> kwarg is provided, the task is created from that event loop, otherwise the running loop is used.</p> diff --git a/main/py-modindex.html b/main/py-modindex.html index 8f576a34..bc4c0bc8 100644 --- a/main/py-modindex.html +++ b/main/py-modindex.html @@ -203,7 +203,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/main/search.html b/main/search.html index 18eac3f5..2976737e 100644 --- a/main/search.html +++ b/main/search.html @@ -202,7 +202,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/main/versions.html b/main/versions.html index 5b0f5c10..ba6fe7d4 100644 --- a/main/versions.html +++ b/main/versions.html @@ -204,7 +204,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -287,7 +287,7 @@ </li> <li> - <a class="reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> diff --git a/v7.1.1/.buildinfo b/v7.1.1/.buildinfo index 436de27f..8f5f5ae8 100644 --- a/v7.1.1/.buildinfo +++ b/v7.1.1/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 5570983e3de7d51ccb4a5ea06c516666 +config: 5a8997e6714e32837dc1f88ea5711ff2 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.1.1/.doctrees/changelog.doctree b/v7.1.1/.doctrees/changelog.doctree Binary files differindex 2a3acc7c..effe660c 100644 --- a/v7.1.1/.doctrees/changelog.doctree +++ b/v7.1.1/.doctrees/changelog.doctree diff --git a/v7.1.1/.doctrees/environment.pickle b/v7.1.1/.doctrees/environment.pickle Binary files differindex 468eae25..04798643 100644 --- a/v7.1.1/.doctrees/environment.pickle +++ b/v7.1.1/.doctrees/environment.pickle diff --git a/v7.1.1/.doctrees/index.doctree b/v7.1.1/.doctrees/index.doctree Binary files differindex 7ffab6c6..9d59edb2 100644 --- a/v7.1.1/.doctrees/index.doctree +++ b/v7.1.1/.doctrees/index.doctree diff --git a/v7.1.1/.doctrees/output/botcore.async_stats.doctree b/v7.1.1/.doctrees/output/botcore.async_stats.doctree Binary files differindex 98b1a3e1..ca9a57e8 100644 --- a/v7.1.1/.doctrees/output/botcore.async_stats.doctree +++ b/v7.1.1/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.1.1/.doctrees/output/botcore.doctree b/v7.1.1/.doctrees/output/botcore.doctree Binary files differindex 0b3c1513..d1375239 100644 --- a/v7.1.1/.doctrees/output/botcore.doctree +++ b/v7.1.1/.doctrees/output/botcore.doctree diff --git a/v7.1.1/.doctrees/output/botcore.exts.doctree b/v7.1.1/.doctrees/output/botcore.exts.doctree Binary files differindex a1b30b7c..03948c71 100644 --- a/v7.1.1/.doctrees/output/botcore.exts.doctree +++ b/v7.1.1/.doctrees/output/botcore.exts.doctree diff --git a/v7.1.1/.doctrees/output/botcore.site_api.doctree b/v7.1.1/.doctrees/output/botcore.site_api.doctree Binary files differindex b1ef79bf..083ac15e 100644 --- a/v7.1.1/.doctrees/output/botcore.site_api.doctree +++ b/v7.1.1/.doctrees/output/botcore.site_api.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.caching.doctree b/v7.1.1/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 73fb1cef..2f7b2f41 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.channel.doctree b/v7.1.1/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 73bf8472..fbec7080 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.doctree b/v7.1.1/.doctrees/output/botcore.utils.doctree Binary files differindex 5ae76fda..2bc67605 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.logging.doctree b/v7.1.1/.doctrees/output/botcore.utils.logging.doctree Binary files differindex 7aa1992f..17f86d92 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.members.doctree b/v7.1.1/.doctrees/output/botcore.utils.members.doctree Binary files differindex 32f0b363..a5db1eb2 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.members.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.regex.doctree b/v7.1.1/.doctrees/output/botcore.utils.regex.doctree Binary files differindex a48ec58e..22432fb5 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree b/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex 6391cdad..32d38b21 100644 --- a/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.1.1/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.1.1/changelog.html b/v7.1.1/changelog.html index f64adfe3..f60d2a7e 100644 --- a/v7.1.1/changelog.html +++ b/v7.1.1/changelog.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/changelog.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/changelog.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/genindex.html b/v7.1.1/genindex.html index 60ec45f6..068a360e 100644 --- a/v7.1.1/genindex.html +++ b/v7.1.1/genindex.html @@ -203,7 +203,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/index.html b/v7.1.1/index.html index c263643a..e5d7bcd2 100644 --- a/v7.1.1/index.html +++ b/v7.1.1/index.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/output/botcore.async_stats.html b/v7.1.1/output/botcore.async_stats.html index 5e1fbbc5..e563e5a2 100644 --- a/v7.1.1/output/botcore.async_stats.html +++ b/v7.1.1/output/botcore.async_stats.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.async_stats.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.async_stats.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/output/botcore.exts.html b/v7.1.1/output/botcore.exts.html index eb8a48ca..f77e8ffb 100644 --- a/v7.1.1/output/botcore.exts.html +++ b/v7.1.1/output/botcore.exts.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.exts.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.exts.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/output/botcore.html b/v7.1.1/output/botcore.html index 70cda8a4..f25cf723 100644 --- a/v7.1.1/output/botcore.html +++ b/v7.1.1/output/botcore.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/output/botcore.site_api.html b/v7.1.1/output/botcore.site_api.html index 41f76fbf..bcdf3011 100644 --- a/v7.1.1/output/botcore.site_api.html +++ b/v7.1.1/output/botcore.site_api.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.site_api.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.site_api.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/output/botcore.utils.caching.html b/v7.1.1/output/botcore.utils.caching.html index d9a2cee1..b5c99728 100644 --- a/v7.1.1/output/botcore.utils.caching.html +++ b/v7.1.1/output/botcore.utils.caching.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.caching.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.caching.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/output/botcore.utils.channel.html b/v7.1.1/output/botcore.utils.channel.html index d42bcb17..b507f959 100644 --- a/v7.1.1/output/botcore.utils.channel.html +++ b/v7.1.1/output/botcore.utils.channel.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.channel.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.channel.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/output/botcore.utils.html b/v7.1.1/output/botcore.utils.html index da1a444f..7f81bdfb 100644 --- a/v7.1.1/output/botcore.utils.html +++ b/v7.1.1/output/botcore.utils.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/output/botcore.utils.logging.html b/v7.1.1/output/botcore.utils.logging.html index 532f531a..3b7632ab 100644 --- a/v7.1.1/output/botcore.utils.logging.html +++ b/v7.1.1/output/botcore.utils.logging.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.logging.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.logging.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/output/botcore.utils.members.html b/v7.1.1/output/botcore.utils.members.html index b1d459dc..86277624 100644 --- a/v7.1.1/output/botcore.utils.members.html +++ b/v7.1.1/output/botcore.utils.members.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.members.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.members.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/output/botcore.utils.regex.html b/v7.1.1/output/botcore.utils.regex.html index fb7509b2..adfdf3d8 100644 --- a/v7.1.1/output/botcore.utils.regex.html +++ b/v7.1.1/output/botcore.utils.regex.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.regex.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.regex.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/output/botcore.utils.scheduling.html b/v7.1.1/output/botcore.utils.scheduling.html index f2217f91..72ba0f19 100644 --- a/v7.1.1/output/botcore.utils.scheduling.html +++ b/v7.1.1/output/botcore.utils.scheduling.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.scheduling.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.scheduling.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/py-modindex.html b/v7.1.1/py-modindex.html index 2c60e426..b7854c7e 100644 --- a/v7.1.1/py-modindex.html +++ b/v7.1.1/py-modindex.html @@ -203,7 +203,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/search.html b/v7.1.1/search.html index 8e2309d3..cef8dd9f 100644 --- a/v7.1.1/search.html +++ b/v7.1.1/search.html @@ -202,7 +202,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.1/versions.html b/v7.1.1/versions.html index 8b2bb0a5..1b0a4db4 100644 --- a/v7.1.1/versions.html +++ b/v7.1.1/versions.html @@ -204,7 +204,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -287,7 +287,7 @@ </li> <li> - <a class="reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> diff --git a/v7.1.2/.buildinfo b/v7.1.2/.buildinfo index e1fc17c5..7bd0ad14 100644 --- a/v7.1.2/.buildinfo +++ b/v7.1.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: 24b7890b5bbb748fed8c9703ed86231d +config: 2eb1a37e8ca9be6480d5353d22ff4c6f tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.1.2/.doctrees/changelog.doctree b/v7.1.2/.doctrees/changelog.doctree Binary files differindex 6e05975e..c6e0c3a7 100644 --- a/v7.1.2/.doctrees/changelog.doctree +++ b/v7.1.2/.doctrees/changelog.doctree diff --git a/v7.1.2/.doctrees/environment.pickle b/v7.1.2/.doctrees/environment.pickle Binary files differindex 3cb9eb5e..374be4a7 100644 --- a/v7.1.2/.doctrees/environment.pickle +++ b/v7.1.2/.doctrees/environment.pickle diff --git a/v7.1.2/.doctrees/index.doctree b/v7.1.2/.doctrees/index.doctree Binary files differindex 5db89bc7..20f3fb16 100644 --- a/v7.1.2/.doctrees/index.doctree +++ b/v7.1.2/.doctrees/index.doctree diff --git a/v7.1.2/.doctrees/output/botcore.async_stats.doctree b/v7.1.2/.doctrees/output/botcore.async_stats.doctree Binary files differindex b91be271..01d5eb7e 100644 --- a/v7.1.2/.doctrees/output/botcore.async_stats.doctree +++ b/v7.1.2/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.1.2/.doctrees/output/botcore.doctree b/v7.1.2/.doctrees/output/botcore.doctree Binary files differindex 12a313aa..8e229718 100644 --- a/v7.1.2/.doctrees/output/botcore.doctree +++ b/v7.1.2/.doctrees/output/botcore.doctree diff --git a/v7.1.2/.doctrees/output/botcore.exts.doctree b/v7.1.2/.doctrees/output/botcore.exts.doctree Binary files differindex 6cf4239d..b2ad7994 100644 --- a/v7.1.2/.doctrees/output/botcore.exts.doctree +++ b/v7.1.2/.doctrees/output/botcore.exts.doctree diff --git a/v7.1.2/.doctrees/output/botcore.site_api.doctree b/v7.1.2/.doctrees/output/botcore.site_api.doctree Binary files differindex 4722895d..b63147dc 100644 --- a/v7.1.2/.doctrees/output/botcore.site_api.doctree +++ b/v7.1.2/.doctrees/output/botcore.site_api.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.caching.doctree b/v7.1.2/.doctrees/output/botcore.utils.caching.doctree Binary files differindex a4fea352..288fc209 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.channel.doctree b/v7.1.2/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 8c25b974..1a86f6be 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.doctree b/v7.1.2/.doctrees/output/botcore.utils.doctree Binary files differindex 0ac8098e..3d6c8554 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.logging.doctree b/v7.1.2/.doctrees/output/botcore.utils.logging.doctree Binary files differindex d32c1618..1ba04d2c 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.members.doctree b/v7.1.2/.doctrees/output/botcore.utils.members.doctree Binary files differindex d93259a3..60a02156 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.members.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.regex.doctree b/v7.1.2/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 0b24cd6b..95f0ae60 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree b/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex 635d3152..633d2b8c 100644 --- a/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.1.2/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.1.2/changelog.html b/v7.1.2/changelog.html index e732e965..59236cd6 100644 --- a/v7.1.2/changelog.html +++ b/v7.1.2/changelog.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/changelog.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/changelog.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/genindex.html b/v7.1.2/genindex.html index d523eda3..f2802987 100644 --- a/v7.1.2/genindex.html +++ b/v7.1.2/genindex.html @@ -203,7 +203,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/index.html b/v7.1.2/index.html index bf52e573..b9dc467b 100644 --- a/v7.1.2/index.html +++ b/v7.1.2/index.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/output/botcore.async_stats.html b/v7.1.2/output/botcore.async_stats.html index 306f605d..d546e57e 100644 --- a/v7.1.2/output/botcore.async_stats.html +++ b/v7.1.2/output/botcore.async_stats.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.async_stats.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.async_stats.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/output/botcore.exts.html b/v7.1.2/output/botcore.exts.html index 9df82653..ca1558f1 100644 --- a/v7.1.2/output/botcore.exts.html +++ b/v7.1.2/output/botcore.exts.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.exts.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.exts.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/output/botcore.html b/v7.1.2/output/botcore.html index 5fc42fbd..5b37baab 100644 --- a/v7.1.2/output/botcore.html +++ b/v7.1.2/output/botcore.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/output/botcore.site_api.html b/v7.1.2/output/botcore.site_api.html index 57992073..8eb7d6d1 100644 --- a/v7.1.2/output/botcore.site_api.html +++ b/v7.1.2/output/botcore.site_api.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.site_api.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.site_api.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/output/botcore.utils.caching.html b/v7.1.2/output/botcore.utils.caching.html index 8f0f7161..bc582357 100644 --- a/v7.1.2/output/botcore.utils.caching.html +++ b/v7.1.2/output/botcore.utils.caching.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.caching.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.caching.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/output/botcore.utils.channel.html b/v7.1.2/output/botcore.utils.channel.html index d48b1a14..05a70c66 100644 --- a/v7.1.2/output/botcore.utils.channel.html +++ b/v7.1.2/output/botcore.utils.channel.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.channel.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.channel.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/output/botcore.utils.html b/v7.1.2/output/botcore.utils.html index ab5cf05b..c761a016 100644 --- a/v7.1.2/output/botcore.utils.html +++ b/v7.1.2/output/botcore.utils.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/output/botcore.utils.logging.html b/v7.1.2/output/botcore.utils.logging.html index 3f48ae5f..240d14e8 100644 --- a/v7.1.2/output/botcore.utils.logging.html +++ b/v7.1.2/output/botcore.utils.logging.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.logging.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.logging.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/output/botcore.utils.members.html b/v7.1.2/output/botcore.utils.members.html index b1f131d4..68dbdd4a 100644 --- a/v7.1.2/output/botcore.utils.members.html +++ b/v7.1.2/output/botcore.utils.members.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.members.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.members.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/output/botcore.utils.regex.html b/v7.1.2/output/botcore.utils.regex.html index cc84f390..d8ab03d0 100644 --- a/v7.1.2/output/botcore.utils.regex.html +++ b/v7.1.2/output/botcore.utils.regex.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.regex.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.regex.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/output/botcore.utils.scheduling.html b/v7.1.2/output/botcore.utils.scheduling.html index bc6ad6af..8b3b3176 100644 --- a/v7.1.2/output/botcore.utils.scheduling.html +++ b/v7.1.2/output/botcore.utils.scheduling.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.scheduling.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.scheduling.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/py-modindex.html b/v7.1.2/py-modindex.html index a788de09..bc83f005 100644 --- a/v7.1.2/py-modindex.html +++ b/v7.1.2/py-modindex.html @@ -203,7 +203,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/search.html b/v7.1.2/search.html index e9ff8d80..74c37538 100644 --- a/v7.1.2/search.html +++ b/v7.1.2/search.html @@ -202,7 +202,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.1.2/versions.html b/v7.1.2/versions.html index 9406cc55..2c616da5 100644 --- a/v7.1.2/versions.html +++ b/v7.1.2/versions.html @@ -204,7 +204,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -287,7 +287,7 @@ </li> <li> - <a class="reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> diff --git a/v7.1.3/.buildinfo b/v7.1.3/.buildinfo index 07f5f5f0..f185ad5b 100644 --- a/v7.1.3/.buildinfo +++ b/v7.1.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: 30d5f34d6b98d8f4ebf7e07ca5883674 +config: 4a10d9d1b81c70c7be4cc7612cf5efd3 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.1.3/.doctrees/changelog.doctree b/v7.1.3/.doctrees/changelog.doctree Binary files differindex db53bd00..d1665e96 100644 --- a/v7.1.3/.doctrees/changelog.doctree +++ b/v7.1.3/.doctrees/changelog.doctree diff --git a/v7.1.3/.doctrees/environment.pickle b/v7.1.3/.doctrees/environment.pickle Binary files differindex 01e1cd1b..e66f8113 100644 --- a/v7.1.3/.doctrees/environment.pickle +++ b/v7.1.3/.doctrees/environment.pickle diff --git a/v7.1.3/.doctrees/index.doctree b/v7.1.3/.doctrees/index.doctree Binary files differindex c65a52a7..5e509eb3 100644 --- a/v7.1.3/.doctrees/index.doctree +++ b/v7.1.3/.doctrees/index.doctree diff --git a/v7.1.3/.doctrees/output/botcore.async_stats.doctree b/v7.1.3/.doctrees/output/botcore.async_stats.doctree Binary files differindex 12a60ff3..2dd3d27d 100644 --- a/v7.1.3/.doctrees/output/botcore.async_stats.doctree +++ b/v7.1.3/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.1.3/.doctrees/output/botcore.doctree b/v7.1.3/.doctrees/output/botcore.doctree Binary files differindex b74434ae..5b164d1d 100644 --- a/v7.1.3/.doctrees/output/botcore.doctree +++ b/v7.1.3/.doctrees/output/botcore.doctree diff --git a/v7.1.3/.doctrees/output/botcore.exts.doctree b/v7.1.3/.doctrees/output/botcore.exts.doctree Binary files differindex 6fb32019..0d60ec98 100644 --- a/v7.1.3/.doctrees/output/botcore.exts.doctree +++ b/v7.1.3/.doctrees/output/botcore.exts.doctree diff --git a/v7.1.3/.doctrees/output/botcore.site_api.doctree b/v7.1.3/.doctrees/output/botcore.site_api.doctree Binary files differindex 7133fa53..558f6f58 100644 --- a/v7.1.3/.doctrees/output/botcore.site_api.doctree +++ b/v7.1.3/.doctrees/output/botcore.site_api.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.caching.doctree b/v7.1.3/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 54e49665..63382ccf 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.channel.doctree b/v7.1.3/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 0b894ad2..a9a141d2 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.doctree b/v7.1.3/.doctrees/output/botcore.utils.doctree Binary files differindex e840d1d1..06bb7320 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.logging.doctree b/v7.1.3/.doctrees/output/botcore.utils.logging.doctree Binary files differindex 73002236..a16789f5 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.members.doctree b/v7.1.3/.doctrees/output/botcore.utils.members.doctree Binary files differindex ca0a7a0b..affbf146 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.members.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.regex.doctree b/v7.1.3/.doctrees/output/botcore.utils.regex.doctree Binary files differindex a7810118..b4ac3154 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree b/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex 56935b5a..9e7d0863 100644 --- a/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.1.3/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.1.3/changelog.html b/v7.1.3/changelog.html index c14268f1..9a3e3202 100644 --- a/v7.1.3/changelog.html +++ b/v7.1.3/changelog.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/changelog.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/changelog.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> diff --git a/v7.1.3/genindex.html b/v7.1.3/genindex.html index a39741b9..62aa0607 100644 --- a/v7.1.3/genindex.html +++ b/v7.1.3/genindex.html @@ -203,7 +203,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> diff --git a/v7.1.3/index.html b/v7.1.3/index.html index c123af39..382f694b 100644 --- a/v7.1.3/index.html +++ b/v7.1.3/index.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> diff --git a/v7.1.3/output/botcore.async_stats.html b/v7.1.3/output/botcore.async_stats.html index 354b5452..c3c298b9 100644 --- a/v7.1.3/output/botcore.async_stats.html +++ b/v7.1.3/output/botcore.async_stats.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.async_stats.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.async_stats.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> @@ -289,11 +289,11 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>loop</strong> (<a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.AbstractEventLoop" title="(in Python v3.10)"><em>asyncio.AbstractEventLoop</em></a>) – The event loop to use when creating the -<a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code></a>.</p></li> -<li><p><strong>host</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The host to connect to.</p></li> -<li><p><strong>port</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – The port to connect to.</p></li> -<li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]) – The prefix to use for all stats.</p></li> +<li><p><strong>loop</strong> (<em>asyncio.AbstractEventLoop</em>) – The event loop to use when creating the +<code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code>.</p></li> +<li><p><strong>host</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The host to connect to.</p></li> +<li><p><strong>port</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – The port to connect to.</p></li> +<li><p><strong>prefix</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – The prefix to use for all stats.</p></li> </ul> </dd> </dl> @@ -302,10 +302,10 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient.create_socket"> <em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_socket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c503586db31b26a66c7f63bf05ab0e30a9365fef/botcore/async_stats.py#L40-L47"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.create_socket" title="Permalink to this definition">#</a></dt> -<dd><p>Use <a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code></a> from the loop given on init to create a socket.</p> +<dd><p>Use <code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code> from the loop given on init to create a socket.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> diff --git a/v7.1.3/output/botcore.exts.html b/v7.1.3/output/botcore.exts.html index 14f8de9a..95c59a69 100644 --- a/v7.1.3/output/botcore.exts.html +++ b/v7.1.3/output/botcore.exts.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.exts.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.exts.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> diff --git a/v7.1.3/output/botcore.html b/v7.1.3/output/botcore.html index 349d0ee8..be0d9b38 100644 --- a/v7.1.3/output/botcore.html +++ b/v7.1.3/output/botcore.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> @@ -289,12 +289,12 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>guild_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – The ID of the guild use for <a class="reference internal" href="#botcore.BotBase.wait_until_guild_available" title="botcore.BotBase.wait_until_guild_available"><code class="xref py py-func docutils literal notranslate"><span class="pre">wait_until_guild_available()</span></code></a>.</p></li> -<li><p><strong>allowed_roles</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>) – A list of role IDs that the bot is allowed to mention.</p></li> +<li><p><strong>guild_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – The ID of the guild use for <a class="reference internal" href="#botcore.BotBase.wait_until_guild_available" title="botcore.BotBase.wait_until_guild_available"><code class="xref py py-func docutils literal notranslate"><span class="pre">wait_until_guild_available()</span></code></a>.</p></li> +<li><p><strong>allowed_roles</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>) – A list of role IDs that the bot is allowed to mention.</p></li> <li><p><strong>http_session</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.8)"><em>aiohttp.ClientSession</em></a>) – The session to use for the bot.</p></li> -<li><p><strong>redis_session</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<code class="xref py py-class docutils literal notranslate"><span class="pre">RedisSession</span></code>]) – The <a class="reference external" href="https://github.com/SebastiaanZ/async-rediscache#creating-a-redissession">async_rediscache.RedisSession</a> to use for the bot.</p></li> -<li><p><strong>api_client</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIClient</span></code></a>]) – The <a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">botcore.site_api.APIClient</span></code></a> instance to use for the bot.</p></li> -<li><p><strong>statsd_url</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]) – The URL of the statsd server to use for the bot. If not given, +<li><p><strong>redis_session</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">RedisSession</span></code>]) – The <a class="reference external" href="https://github.com/SebastiaanZ/async-rediscache#creating-a-redissession">async_rediscache.RedisSession</a> to use for the bot.</p></li> +<li><p><strong>api_client</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIClient</span></code></a>]) – The <a class="reference internal" href="botcore.site_api.html#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">botcore.site_api.APIClient</span></code></a> instance to use for the bot.</p></li> +<li><p><strong>statsd_url</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – The URL of the statsd server to use for the bot. If not given, a dummy statsd client will be created.</p></li> </ul> </dd> @@ -307,7 +307,7 @@ a dummy statsd client will be created.</p></li> <dd><p>Add the given <code class="docutils literal notranslate"><span class="pre">cog</span></code> to the bot and log the operation.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -318,7 +318,7 @@ a dummy statsd client will be created.</p></li> <dd><p>Add <code class="docutils literal notranslate"><span class="pre">command</span></code> as normal and then add its root aliases to the bot.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -329,7 +329,7 @@ a dummy statsd client will be created.</p></li> <dd><p>Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -340,7 +340,7 @@ a dummy statsd client will be created.</p></li> <dd><p>Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -352,7 +352,7 @@ a dummy statsd client will be created.</p></li> <p>This should be ran in a task on the event loop to avoid deadlocks caused by <code class="docutils literal notranslate"><span class="pre">wait_for</span></code> calls.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -363,7 +363,7 @@ a dummy statsd client will be created.</p></li> <dd><p>Log the given message to #dev-log.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -376,7 +376,7 @@ a dummy statsd client will be created.</p></li> will not be set and <cite>guild_available_but_cache_empty</cite> event will be emitted.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -387,7 +387,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dd><p>Clear the internal guild available event when self.guild_id becomes unavailable.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -398,7 +398,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dd><p>Ping all required services on setup to ensure they are up before starting.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -411,7 +411,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e To remove them, either remove the entire command or manually edit <cite>bot.all_commands</cite>.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a>]</p> +<dd class="field-odd"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a>]</p> </dd> </dl> </dd></dl> @@ -425,7 +425,7 @@ To remove them, either remove the entire command or manually edit <cite>bot.all_ and <a class="reference internal" href="#botcore.BotBase.ping_services" title="botcore.BotBase.ping_services"><code class="xref py py-func docutils literal notranslate"><span class="pre">ping_services()</span></code></a>.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -438,7 +438,7 @@ and <a class="reference internal" href="#botcore.BotBase.ping_services" title="b gateway event before giving up and thus not populating the cache for unavailable guilds.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -448,7 +448,7 @@ gateway event before giving up and thus not populating the cache for unavailable <dl class="py exception"> <dt class="sig sig-object py" id="botcore.StartupError"> <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">StartupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c503586db31b26a66c7f63bf05ab0e30a9365fef/botcore/__init__.py#L28-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError" title="Permalink to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p> <p>Exception class for startup errors.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.StartupError.__init__"> diff --git a/v7.1.3/output/botcore.site_api.html b/v7.1.3/output/botcore.site_api.html index 0ed91557..224af374 100644 --- a/v7.1.3/output/botcore.site_api.html +++ b/v7.1.3/output/botcore.site_api.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.site_api.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.site_api.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> @@ -280,7 +280,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="botcore.site_api.APIClient"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c503586db31b26a66c7f63bf05ab0e30a9365fef/botcore/site_api.py#L42-L154"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient" title="Permalink to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> <p>A wrapper for the Django Site API.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.__init__"> @@ -289,8 +289,8 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>site_api_url</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The URL of the site API.</p></li> -<li><p><strong>site_api_token</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The token to use for authentication.</p></li> +<li><p><strong>site_api_url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The URL of the site API.</p></li> +<li><p><strong>site_api_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The token to use for authentication.</p></li> <li><p><strong>session_kwargs</strong> – Keyword arguments to pass to the <a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientSession</span></code></a> constructor.</p></li> </ul> </dd> @@ -303,7 +303,7 @@ <dd><p>Close the aiohttp session.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -315,13 +315,13 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The endpoint to send the request to.</p></li> -<li><p><strong>raise_for_status</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – Whether or not to raise an exception if the response is not OK.</p></li> +<li><p><strong>endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The endpoint to send the request to.</p></li> +<li><p><strong>raise_for_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether or not to raise an exception if the response is not OK.</p></li> <li><p><strong>**kwargs</strong> – Any extra keyword arguments to pass to <a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.request" title="(in aiohttp v3.8)"><code class="xref py py-func docutils literal notranslate"><span class="pre">aiohttp.request()</span></code></a>.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]</p> +<dd class="field-even"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>]</p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>The JSON response the API returns, or None if the response is 204 No Content.</p> @@ -335,7 +335,7 @@ <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with GET passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p> </dd> </dl> </dd></dl> @@ -348,14 +348,14 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>response</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientResponse" title="(in aiohttp v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientResponse</span></code></a>) – The response to check.</p></li> -<li><p><strong>should_raise</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – Whether or not to raise an exception.</p></li> +<li><p><strong>should_raise</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether or not to raise an exception.</p></li> </ul> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> <dd class="field-even"><p><a class="reference internal" href="#botcore.site_api.ResponseCodeError" title="botcore.site_api.ResponseCodeError"><strong>ResponseCodeError</strong></a> – If the response is not OK and <code class="docutils literal notranslate"><span class="pre">should_raise</span></code> is True.</p> </dd> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -366,7 +366,7 @@ <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PATCH passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p> </dd> </dl> </dd></dl> @@ -377,7 +377,7 @@ <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with POST passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p> </dd> </dl> </dd></dl> @@ -388,7 +388,7 @@ <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PUT passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p> </dd> </dl> </dd></dl> @@ -400,14 +400,14 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>method</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The HTTP method to use.</p></li> -<li><p><strong>endpoint</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The endpoint to send the request to.</p></li> -<li><p><strong>raise_for_status</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – Whether or not to raise an exception if the response is not OK.</p></li> +<li><p><strong>method</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The HTTP method to use.</p></li> +<li><p><strong>endpoint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The endpoint to send the request to.</p></li> +<li><p><strong>raise_for_status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Whether or not to raise an exception if the response is not OK.</p></li> <li><p><strong>**kwargs</strong> – Any extra keyword arguments to pass to <a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.request" title="(in aiohttp v3.8)"><code class="xref py py-func docutils literal notranslate"><span class="pre">aiohttp.request()</span></code></a>.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p> +<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>The JSON response the API returns.</p> @@ -423,7 +423,7 @@ <dl class="py exception"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError"> <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c503586db31b26a66c7f63bf05ab0e30a9365fef/botcore/site_api.py#L14-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError" title="Permalink to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></a></p> +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></p> <p>Raised in <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> when a non-OK HTTP response is received.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError.__init__"> @@ -433,7 +433,7 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>response</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientResponse" title="(in aiohttp v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientResponse</span></code></a>) – The response object from the request. And then reverted in 7.1.3.</p></li> -<li><p><strong>response_json</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]) – The JSON response returned from the request, if any.</p></li> +<li><p><strong>response_json</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>]) – The JSON response returned from the request, if any.</p></li> <li><p><strong>request_text</strong> – The text of the request, if any.</p></li> </ul> </dd> diff --git a/v7.1.3/output/botcore.utils.caching.html b/v7.1.3/output/botcore.utils.caching.html index e9b394c7..c647a897 100644 --- a/v7.1.3/output/botcore.utils.caching.html +++ b/v7.1.3/output/botcore.utils.caching.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.caching.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.caching.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> @@ -280,7 +280,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c503586db31b26a66c7f63bf05ab0e30a9365fef/botcore/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache" title="Permalink to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> <p>LRU cache implementation for coroutines.</p> <p>Once the cache exceeds the maximum size, keys are deleted in FIFO order.</p> <p>An offset may be optionally provided to be applied to the coroutine’s arguments when creating the cache key.</p> @@ -290,10 +290,10 @@ <dd><p>Decorator for async cache.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>arg_offset</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – The offset for the position of the key argument.</p> +<dd class="field-odd"><p><strong>arg_offset</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – The offset for the position of the key argument.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a></p> +<dd class="field-even"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>A decorator to wrap the target function.</p> @@ -307,7 +307,7 @@ <dd><p>Initialise a new <a class="reference internal" href="#botcore.utils.caching.AsyncCache" title="botcore.utils.caching.AsyncCache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncCache</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – How many items to store in the cache.</p> +<dd class="field-odd"><p><strong>max_size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – How many items to store in the cache.</p> </dd> </dl> </dd></dl> @@ -318,7 +318,7 @@ <dd><p>Clear cache instance.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> diff --git a/v7.1.3/output/botcore.utils.channel.html b/v7.1.3/output/botcore.utils.channel.html index 2b64c006..0c4cb277 100644 --- a/v7.1.3/output/botcore.utils.channel.html +++ b/v7.1.3/output/botcore.utils.channel.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.channel.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.channel.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> @@ -285,7 +285,7 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>bot</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a>) – The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Bot</span></code></a> instance to use for getting/fetching.</p></li> -<li><p><strong>channel_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – The channel to get/fetch.</p></li> +<li><p><strong>channel_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – The channel to get/fetch.</p></li> </ul> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> @@ -313,11 +313,11 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>channel</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.TextChannel" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code></a>) – The channel to check.</p></li> -<li><p><strong>category_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – The category to check for.</p></li> +<li><p><strong>category_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>) – The category to check for.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></p> +<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>A bool depending on whether the channel is in the category.</p> diff --git a/v7.1.3/output/botcore.utils.html b/v7.1.3/output/botcore.utils.html index 5b372970..85ecd232 100644 --- a/v7.1.3/output/botcore.utils.html +++ b/v7.1.3/output/botcore.utils.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> @@ -291,7 +291,7 @@ that will act as top-level groups rather than being aliases of the command’s g </dl> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -302,10 +302,10 @@ that will act as top-level groups rather than being aliases of the command’s g <dd><p>Return an unqualified name given a qualified module/package <code class="docutils literal notranslate"><span class="pre">name</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The module name to unqualify.</p> +<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The module name to unqualify.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p> +<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>The unqualified module name.</p> diff --git a/v7.1.3/output/botcore.utils.logging.html b/v7.1.3/output/botcore.utils.logging.html index 8aaaf2b3..a2063ec9 100644 --- a/v7.1.3/output/botcore.utils.logging.html +++ b/v7.1.3/output/botcore.utils.logging.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.logging.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.logging.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> @@ -280,8 +280,8 @@ <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c503586db31b26a66c7f63bf05ab0e30a9365fef/botcore/utils/logging.py#L14-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger" title="Permalink to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Logger</span></code></a></p> -<p>Custom implementation of the <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.Logger</span></code></a> class with an added <a class="reference internal" href="#botcore.utils.logging.CustomLogger.trace" title="botcore.utils.logging.CustomLogger.trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trace</span></code></a> method.</p> +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Logger</span></code></p> +<p>Custom implementation of the <code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.Logger</span></code> class with an added <a class="reference internal" href="#botcore.utils.logging.CustomLogger.trace" title="botcore.utils.logging.CustomLogger.trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trace</span></code></a> method.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger.trace"> <span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c503586db31b26a66c7f63bf05ab0e30a9365fef/botcore/utils/logging.py#L17-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger.trace" title="Permalink to this definition">#</a></dt> @@ -293,13 +293,13 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>msg</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The message to be logged.</p></li> +<li><p><strong>msg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The message to be logged.</p></li> <li><p><strong>args</strong> – Passed to the base log function as is.</p></li> <li><p><strong>kwargs</strong> – Passed to the base log function as is.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -312,7 +312,7 @@ <dd><p>Utility to make mypy recognise that logger is of type <a class="reference internal" href="#botcore.utils.logging.CustomLogger" title="botcore.utils.logging.CustomLogger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CustomLogger</span></code></a>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]) – The name given to the logger.</p> +<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – The name given to the logger.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> <dd class="field-even"><p><a class="reference internal" href="#botcore.utils.logging.CustomLogger" title="botcore.utils.logging.CustomLogger"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomLogger</span></code></a></p> diff --git a/v7.1.3/output/botcore.utils.members.html b/v7.1.3/output/botcore.utils.members.html index 448ebe0f..0d1e1504 100644 --- a/v7.1.3/output/botcore.utils.members.html +++ b/v7.1.3/output/botcore.utils.members.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.members.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.members.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> @@ -283,10 +283,10 @@ <dd><p>Attempt to get a member from cache; on failure fetch from the API.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a>]</p> +<dd class="field-odd"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a>]</p> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> -<dd class="field-even"><p>The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a> to indicate the member could not be found.</p> +<dd class="field-even"><p>The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> to indicate the member could not be found.</p> </dd> </dl> </dd></dl> @@ -301,11 +301,11 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>member</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a>) – The member to pass to <code class="docutils literal notranslate"><span class="pre">coro</span></code>.</p></li> -<li><p><strong>coro</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/constants.html#Ellipsis" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">...</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Coroutine" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>]) – This is intended to be <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> or <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p></li> +<li><p><strong>coro</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">...</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code>]) – This is intended to be <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> or <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> diff --git a/v7.1.3/output/botcore.utils.regex.html b/v7.1.3/output/botcore.utils.regex.html index f16688ac..3c4b7b51 100644 --- a/v7.1.3/output/botcore.utils.regex.html +++ b/v7.1.3/output/botcore.utils.regex.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.regex.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.regex.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> @@ -285,7 +285,7 @@ <p class="admonition-title">Warning</p> <p>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 <a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote" title="(in Python v3.10)"><code class="xref py py-func docutils literal notranslate"><span class="pre">urllib.parse.quote()</span></code></a>.</p> +such as <code class="xref py py-func docutils literal notranslate"><span class="pre">urllib.parse.quote()</span></code>.</p> </div> <dl class="field-list simple"> </dl> diff --git a/v7.1.3/output/botcore.utils.scheduling.html b/v7.1.3/output/botcore.utils.scheduling.html index 5fca6407..57640d83 100644 --- a/v7.1.3/output/botcore.utils.scheduling.html +++ b/v7.1.3/output/botcore.utils.scheduling.html @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../../v7.2.0-alpha/output/botcore.utils.scheduling.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../../v7.2.0/output/botcore.utils.scheduling.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> @@ -280,7 +280,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c503586db31b26a66c7f63bf05ab0e30a9365fef/botcore/utils/scheduling.py#L13-L209"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler" title="Permalink to this definition">#</a></dt> -<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> <p>Schedule the execution of coroutines and keep track of them.</p> <p>When instantiating a <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a>, 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 @@ -294,16 +294,16 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.__contains__"> <span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c503586db31b26a66c7f63bf05ab0e30a9365fef/botcore/utils/scheduling.py#L43-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__contains__" title="Permalink to this definition">#</a></dt> -<dd><p>Return <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> if a task with the given <code class="docutils literal notranslate"><span class="pre">task_id</span></code> is currently scheduled.</p> +<dd><p>Return <code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code> if a task with the given <code class="docutils literal notranslate"><span class="pre">task_id</span></code> is currently scheduled.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>task_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Hashable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>) – The task to look for.</p> +<dd class="field-odd"><p><strong>task_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code>) – The task to look for.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></p> +<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> if the task was found.</p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code> if the task was found.</p> </dd> </dl> </dd></dl> @@ -314,7 +314,7 @@ the same ID used to schedule it.</p> <dd><p>Initialize a new <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – The name of the <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a>. Used in logging, and namespacing.</p> +<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name of the <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a>. Used in logging, and namespacing.</p> </dd> </dl> </dd></dl> @@ -325,10 +325,10 @@ the same ID used to schedule it.</p> <dd><p>Unschedule the task identified by <code class="docutils literal notranslate"><span class="pre">task_id</span></code>. Log a warning if the task doesn’t exist.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>task_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Hashable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>) – The task’s unique ID.</p> +<dd class="field-odd"><p><strong>task_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code>) – The task’s unique ID.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -339,7 +339,7 @@ the same ID used to schedule it.</p> <dd><p>Unschedule all known tasks.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -353,12 +353,12 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>task_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Hashable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>) – A unique ID to create the task with.</p></li> -<li><p><strong>coroutine</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Coroutine" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>) – The function to be called.</p></li> +<li><p><strong>task_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code>) – A unique ID to create the task with.</p></li> +<li><p><strong>coroutine</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code>) – The function to be called.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -375,13 +375,13 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>time</strong> (<a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></a>) – The time to start the task.</p></li> -<li><p><strong>task_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Hashable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>) – A unique ID to create the task with.</p></li> -<li><p><strong>coroutine</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Coroutine" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>) – The function to be called.</p></li> +<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code>) – The time to start the task.</p></li> +<li><p><strong>task_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code>) – A unique ID to create the task with.</p></li> +<li><p><strong>coroutine</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code>) – The function to be called.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -395,13 +395,13 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>delay</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.10)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a>]) – How long to wait before starting the task.</p></li> -<li><p><strong>task_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Hashable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>) – A unique ID to create the task with.</p></li> -<li><p><strong>coroutine</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Coroutine" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>) – The function to be called.</p></li> +<li><p><strong>delay</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]) – How long to wait before starting the task.</p></li> +<li><p><strong>task_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code>) – A unique ID to create the task with.</p></li> +<li><p><strong>coroutine</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code>) – The function to be called.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></p> +<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p> </dd> </dl> </dd></dl> @@ -411,23 +411,23 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.scheduling.create_task"> <span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suppressed_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_loop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c503586db31b26a66c7f63bf05ab0e30a9365fef/botcore/utils/scheduling.py#L211-L239"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.create_task" title="Permalink to this definition">#</a></dt> -<dd><p>Wrapper for creating an <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.Task</span></code></a> which logs exceptions raised in the task.</p> +<dd><p>Wrapper for creating an <code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.Task</span></code> which logs exceptions raised in the task.</p> <p>If the <code class="docutils literal notranslate"><span class="pre">event_loop</span></code> kwarg is provided, the task is created from that event loop, otherwise the running loop is used.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>coro</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Awaitable" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</span></code></a>) – The function to call.</p></li> -<li><p><strong>suppressed_exceptions</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Type" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a>]]) – Exceptions to be handled by the task.</p></li> -<li><p><strong>event_loop</strong> (<a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.AbstractEventLoop" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.AbstractEventLoop</span></code></a>) – The loop to create the task from.</p></li> -<li><p><strong>kwargs</strong> – Passed to <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.create_task" title="(in Python v3.10)"><code class="xref py py-func docutils literal notranslate"><span class="pre">asyncio.create_task()</span></code></a>.</p></li> +<li><p><strong>coro</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</span></code>) – The function to call.</p></li> +<li><p><strong>suppressed_exceptions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code>]]) – Exceptions to be handled by the task.</p></li> +<li><p><strong>event_loop</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.AbstractEventLoop</span></code>) – The loop to create the task from.</p></li> +<li><p><strong>kwargs</strong> – Passed to <code class="xref py py-func docutils literal notranslate"><span class="pre">asyncio.create_task()</span></code>.</p></li> </ul> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>The wrapped task.</p> </dd> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.10)">asyncio.Task</a></p> +<dd class="field-odd"><p>asyncio.Task</p> </dd> </dl> </dd></dl> diff --git a/v7.1.3/py-modindex.html b/v7.1.3/py-modindex.html index fd26c28a..9f2444cb 100644 --- a/v7.1.3/py-modindex.html +++ b/v7.1.3/py-modindex.html @@ -203,7 +203,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> diff --git a/v7.1.3/search.html b/v7.1.3/search.html index b5343960..177a4fc6 100644 --- a/v7.1.3/search.html +++ b/v7.1.3/search.html @@ -202,7 +202,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> diff --git a/v7.1.3/versions.html b/v7.1.3/versions.html index 95cd230f..260ad994 100644 --- a/v7.1.3/versions.html +++ b/v7.1.3/versions.html @@ -204,7 +204,7 @@ </li> <li class="toctree-l2 "> - <a class="version_link reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> <li class="toctree-l2 current-page"> @@ -287,7 +287,7 @@ </li> <li> - <a class="reference internal" href="../v7.2.0-alpha/index.html">v7.2.0-alpha</a> + <a class="reference internal" href="../v7.2.0/index.html">v7.2.0</a> </li> diff --git a/v7.2.0-alpha/.buildinfo b/v7.2.0/.buildinfo index 112c3b75..d7b432c0 100644 --- a/v7.2.0-alpha/.buildinfo +++ b/v7.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: de0ddd131e43ef26a09e9f32cc233aba +config: 3be6441cf33c886b1c3ac44b840354c9 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.2.0-alpha/.doctrees/changelog.doctree b/v7.2.0/.doctrees/changelog.doctree Binary files differindex 6ec4a6b8..73658d78 100644 --- a/v7.2.0-alpha/.doctrees/changelog.doctree +++ b/v7.2.0/.doctrees/changelog.doctree diff --git a/v7.2.0-alpha/.doctrees/environment.pickle b/v7.2.0/.doctrees/environment.pickle Binary files differindex eb90365e..4f349df8 100644 --- a/v7.2.0-alpha/.doctrees/environment.pickle +++ b/v7.2.0/.doctrees/environment.pickle diff --git a/v7.2.0-alpha/.doctrees/index.doctree b/v7.2.0/.doctrees/index.doctree Binary files differindex 1087594f..92209e0b 100644 --- a/v7.2.0-alpha/.doctrees/index.doctree +++ b/v7.2.0/.doctrees/index.doctree diff --git a/v7.2.0-alpha/.doctrees/output/botcore.async_stats.doctree b/v7.2.0/.doctrees/output/botcore.async_stats.doctree Binary files differindex ad712b90..b98dfe2d 100644 --- a/v7.2.0-alpha/.doctrees/output/botcore.async_stats.doctree +++ b/v7.2.0/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.2.0-alpha/.doctrees/output/botcore.doctree b/v7.2.0/.doctrees/output/botcore.doctree Binary files differindex 8ccb379a..dbe53ea2 100644 --- a/v7.2.0-alpha/.doctrees/output/botcore.doctree +++ b/v7.2.0/.doctrees/output/botcore.doctree diff --git a/v7.2.0-alpha/.doctrees/output/botcore.exts.doctree b/v7.2.0/.doctrees/output/botcore.exts.doctree Binary files differindex 4f29895a..43258a18 100644 --- a/v7.2.0-alpha/.doctrees/output/botcore.exts.doctree +++ b/v7.2.0/.doctrees/output/botcore.exts.doctree diff --git a/v7.2.0-alpha/.doctrees/output/botcore.site_api.doctree b/v7.2.0/.doctrees/output/botcore.site_api.doctree Binary files differindex 1383a89f..08039caa 100644 --- a/v7.2.0-alpha/.doctrees/output/botcore.site_api.doctree +++ b/v7.2.0/.doctrees/output/botcore.site_api.doctree diff --git a/v7.2.0-alpha/.doctrees/output/botcore.utils.caching.doctree b/v7.2.0/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 67ec732a..97c3505c 100644 --- a/v7.2.0-alpha/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.2.0-alpha/.doctrees/output/botcore.utils.channel.doctree b/v7.2.0/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 01739ebe..70950d5a 100644 --- a/v7.2.0-alpha/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.2.0-alpha/.doctrees/output/botcore.utils.doctree b/v7.2.0/.doctrees/output/botcore.utils.doctree Binary files differindex f1761abe..f3db6b24 100644 --- a/v7.2.0-alpha/.doctrees/output/botcore.utils.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.doctree diff --git a/v7.2.0-alpha/.doctrees/output/botcore.utils.logging.doctree b/v7.2.0/.doctrees/output/botcore.utils.logging.doctree Binary files differindex a4200fd4..aa9187eb 100644 --- a/v7.2.0-alpha/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.2.0-alpha/.doctrees/output/botcore.utils.members.doctree b/v7.2.0/.doctrees/output/botcore.utils.members.doctree Binary files differindex 87cef153..7d5a3405 100644 --- a/v7.2.0-alpha/.doctrees/output/botcore.utils.members.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.2.0-alpha/.doctrees/output/botcore.utils.regex.doctree b/v7.2.0/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 77ca529b..9867b781 100644 --- a/v7.2.0-alpha/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.2.0-alpha/.doctrees/output/botcore.utils.scheduling.doctree b/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex 9fdfd284..86c09686 100644 --- a/v7.2.0-alpha/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.2.0/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.2.0-alpha/.nojekyll b/v7.2.0/.nojekyll index e69de29b..e69de29b 100644 --- a/v7.2.0-alpha/.nojekyll +++ b/v7.2.0/.nojekyll diff --git a/v7.2.0-alpha/_sources/changelog.rst.txt b/v7.2.0/_sources/changelog.rst.txt index 0e8fc10d..cba9e090 100644 --- a/v7.2.0-alpha/_sources/changelog.rst.txt +++ b/v7.2.0/_sources/changelog.rst.txt @@ -4,7 +4,7 @@ Changelog ========= -- :release:`7.2.0 <28th June 2022>` 93 +- :release:`7.2.0 <28th June 2022>` - :support:`93` Bump Discord.py to :literal-url:`0eb3d26 <https://github.com/Rapptz/discord.py/commit/0eb3d26343969a25ffc43ba72eca42538d2e7e7a>`: - Adds support for auto mod, of which the new auto_mod MESSAGE_TYPE is needed for our filter system. diff --git a/v7.2.0-alpha/_sources/index.rst.txt b/v7.2.0/_sources/index.rst.txt index 0a375b90..0a375b90 100644 --- a/v7.2.0-alpha/_sources/index.rst.txt +++ b/v7.2.0/_sources/index.rst.txt diff --git a/v7.2.0-alpha/_sources/output/botcore.async_stats.rst.txt b/v7.2.0/_sources/output/botcore.async_stats.rst.txt index 7fdbbbe2..7fdbbbe2 100644 --- a/v7.2.0-alpha/_sources/output/botcore.async_stats.rst.txt +++ b/v7.2.0/_sources/output/botcore.async_stats.rst.txt diff --git a/v7.2.0-alpha/_sources/output/botcore.exts.rst.txt b/v7.2.0/_sources/output/botcore.exts.rst.txt index 38d2fc2e..38d2fc2e 100644 --- a/v7.2.0-alpha/_sources/output/botcore.exts.rst.txt +++ b/v7.2.0/_sources/output/botcore.exts.rst.txt diff --git a/v7.2.0-alpha/_sources/output/botcore.rst.txt b/v7.2.0/_sources/output/botcore.rst.txt index 0a719da2..0a719da2 100644 --- a/v7.2.0-alpha/_sources/output/botcore.rst.txt +++ b/v7.2.0/_sources/output/botcore.rst.txt diff --git a/v7.2.0-alpha/_sources/output/botcore.site_api.rst.txt b/v7.2.0/_sources/output/botcore.site_api.rst.txt index 2399bbc4..2399bbc4 100644 --- a/v7.2.0-alpha/_sources/output/botcore.site_api.rst.txt +++ b/v7.2.0/_sources/output/botcore.site_api.rst.txt diff --git a/v7.2.0-alpha/_sources/output/botcore.utils.caching.rst.txt b/v7.2.0/_sources/output/botcore.utils.caching.rst.txt index 02c2105d..02c2105d 100644 --- a/v7.2.0-alpha/_sources/output/botcore.utils.caching.rst.txt +++ b/v7.2.0/_sources/output/botcore.utils.caching.rst.txt diff --git a/v7.2.0-alpha/_sources/output/botcore.utils.channel.rst.txt b/v7.2.0/_sources/output/botcore.utils.channel.rst.txt index 460975f4..460975f4 100644 --- a/v7.2.0-alpha/_sources/output/botcore.utils.channel.rst.txt +++ b/v7.2.0/_sources/output/botcore.utils.channel.rst.txt diff --git a/v7.2.0-alpha/_sources/output/botcore.utils.logging.rst.txt b/v7.2.0/_sources/output/botcore.utils.logging.rst.txt index a719bfa7..a719bfa7 100644 --- a/v7.2.0-alpha/_sources/output/botcore.utils.logging.rst.txt +++ b/v7.2.0/_sources/output/botcore.utils.logging.rst.txt diff --git a/v7.2.0-alpha/_sources/output/botcore.utils.members.rst.txt b/v7.2.0/_sources/output/botcore.utils.members.rst.txt index ab65d36b..ab65d36b 100644 --- a/v7.2.0-alpha/_sources/output/botcore.utils.members.rst.txt +++ b/v7.2.0/_sources/output/botcore.utils.members.rst.txt diff --git a/v7.2.0-alpha/_sources/output/botcore.utils.regex.rst.txt b/v7.2.0/_sources/output/botcore.utils.regex.rst.txt index 405e416a..405e416a 100644 --- a/v7.2.0-alpha/_sources/output/botcore.utils.regex.rst.txt +++ b/v7.2.0/_sources/output/botcore.utils.regex.rst.txt diff --git a/v7.2.0-alpha/_sources/output/botcore.utils.rst.txt b/v7.2.0/_sources/output/botcore.utils.rst.txt index 286b55f1..286b55f1 100644 --- a/v7.2.0-alpha/_sources/output/botcore.utils.rst.txt +++ b/v7.2.0/_sources/output/botcore.utils.rst.txt diff --git a/v7.2.0-alpha/_sources/output/botcore.utils.scheduling.rst.txt b/v7.2.0/_sources/output/botcore.utils.scheduling.rst.txt index 41ffe1c6..41ffe1c6 100644 --- a/v7.2.0-alpha/_sources/output/botcore.utils.scheduling.rst.txt +++ b/v7.2.0/_sources/output/botcore.utils.scheduling.rst.txt diff --git a/v7.2.0-alpha/_static/_sphinx_javascript_frameworks_compat.js b/v7.2.0/_static/_sphinx_javascript_frameworks_compat.js index 8549469d..8549469d 100644 --- a/v7.2.0-alpha/_static/_sphinx_javascript_frameworks_compat.js +++ b/v7.2.0/_static/_sphinx_javascript_frameworks_compat.js diff --git a/v7.2.0-alpha/_static/basic.css b/v7.2.0/_static/basic.css index 08896771..08896771 100644 --- a/v7.2.0-alpha/_static/basic.css +++ b/v7.2.0/_static/basic.css diff --git a/v7.2.0-alpha/_static/changelog.css b/v7.2.0/_static/changelog.css index 343792a1..343792a1 100644 --- a/v7.2.0-alpha/_static/changelog.css +++ b/v7.2.0/_static/changelog.css diff --git a/v7.2.0-alpha/_static/changelog.js b/v7.2.0/_static/changelog.js index 94834eaa..94834eaa 100644 --- a/v7.2.0-alpha/_static/changelog.js +++ b/v7.2.0/_static/changelog.js diff --git a/v7.2.0-alpha/_static/debug.css b/v7.2.0/_static/debug.css index 3264805c..3264805c 100644 --- a/v7.2.0-alpha/_static/debug.css +++ b/v7.2.0/_static/debug.css diff --git a/v7.2.0-alpha/_static/doctools.js b/v7.2.0/_static/doctools.js index c3db08d1..c3db08d1 100644 --- a/v7.2.0-alpha/_static/doctools.js +++ b/v7.2.0/_static/doctools.js diff --git a/v7.2.0-alpha/_static/documentation_options.js b/v7.2.0/_static/documentation_options.js index e252ab06..e252ab06 100644 --- a/v7.2.0-alpha/_static/documentation_options.js +++ b/v7.2.0/_static/documentation_options.js diff --git a/v7.2.0-alpha/_static/file.png b/v7.2.0/_static/file.png Binary files differindex a858a410..a858a410 100644 --- a/v7.2.0-alpha/_static/file.png +++ b/v7.2.0/_static/file.png diff --git a/v7.2.0-alpha/_static/index.css b/v7.2.0/_static/index.css index 54f3f771..54f3f771 100644 --- a/v7.2.0-alpha/_static/index.css +++ b/v7.2.0/_static/index.css diff --git a/v7.2.0-alpha/_static/jquery-3.6.0.js b/v7.2.0/_static/jquery-3.6.0.js index fc6c299b..fc6c299b 100644 --- a/v7.2.0-alpha/_static/jquery-3.6.0.js +++ b/v7.2.0/_static/jquery-3.6.0.js diff --git a/v7.2.0-alpha/_static/jquery.js b/v7.2.0/_static/jquery.js index c4c6022f..c4c6022f 100644 --- a/v7.2.0-alpha/_static/jquery.js +++ b/v7.2.0/_static/jquery.js diff --git a/v7.2.0-alpha/_static/language_data.js b/v7.2.0/_static/language_data.js index 2e22b06a..2e22b06a 100644 --- a/v7.2.0-alpha/_static/language_data.js +++ b/v7.2.0/_static/language_data.js diff --git a/v7.2.0-alpha/_static/logo.css b/v7.2.0/_static/logo.css index a9c28e5c..a9c28e5c 100644 --- a/v7.2.0-alpha/_static/logo.css +++ b/v7.2.0/_static/logo.css diff --git a/v7.2.0-alpha/_static/minus.png b/v7.2.0/_static/minus.png Binary files differindex d96755fd..d96755fd 100644 --- a/v7.2.0-alpha/_static/minus.png +++ b/v7.2.0/_static/minus.png diff --git a/v7.2.0-alpha/_static/plus.png b/v7.2.0/_static/plus.png Binary files differindex 7107cec9..7107cec9 100644 --- a/v7.2.0-alpha/_static/plus.png +++ b/v7.2.0/_static/plus.png diff --git a/v7.2.0-alpha/_static/pygments.css b/v7.2.0/_static/pygments.css index 053cfd3d..053cfd3d 100644 --- a/v7.2.0-alpha/_static/pygments.css +++ b/v7.2.0/_static/pygments.css diff --git a/v7.2.0-alpha/_static/scripts/furo-extensions.js b/v7.2.0/_static/scripts/furo-extensions.js index e69de29b..e69de29b 100644 --- a/v7.2.0-alpha/_static/scripts/furo-extensions.js +++ b/v7.2.0/_static/scripts/furo-extensions.js diff --git a/v7.2.0-alpha/_static/scripts/furo.js b/v7.2.0/_static/scripts/furo.js index cbf64878..cbf64878 100644 --- a/v7.2.0-alpha/_static/scripts/furo.js +++ b/v7.2.0/_static/scripts/furo.js diff --git a/v7.2.0-alpha/_static/scripts/furo.js.LICENSE.txt b/v7.2.0/_static/scripts/furo.js.LICENSE.txt index 1632189c..1632189c 100644 --- a/v7.2.0-alpha/_static/scripts/furo.js.LICENSE.txt +++ b/v7.2.0/_static/scripts/furo.js.LICENSE.txt diff --git a/v7.2.0-alpha/_static/scripts/furo.js.map b/v7.2.0/_static/scripts/furo.js.map index c9e2d048..c9e2d048 100644 --- a/v7.2.0-alpha/_static/scripts/furo.js.map +++ b/v7.2.0/_static/scripts/furo.js.map diff --git a/v7.2.0-alpha/_static/searchtools.js b/v7.2.0/_static/searchtools.js index ac4d5861..ac4d5861 100644 --- a/v7.2.0-alpha/_static/searchtools.js +++ b/v7.2.0/_static/searchtools.js diff --git a/v7.2.0-alpha/_static/skeleton.css b/v7.2.0/_static/skeleton.css index 01231167..01231167 100644 --- a/v7.2.0-alpha/_static/skeleton.css +++ b/v7.2.0/_static/skeleton.css diff --git a/v7.2.0-alpha/_static/statsd_additional_objects.inv b/v7.2.0/_static/statsd_additional_objects.inv Binary files differindex f84ab9f1..f84ab9f1 100644 --- a/v7.2.0-alpha/_static/statsd_additional_objects.inv +++ b/v7.2.0/_static/statsd_additional_objects.inv diff --git a/v7.2.0-alpha/_static/styles/furo-extensions.css b/v7.2.0/_static/styles/furo-extensions.css index bc447f22..bc447f22 100644 --- a/v7.2.0-alpha/_static/styles/furo-extensions.css +++ b/v7.2.0/_static/styles/furo-extensions.css diff --git a/v7.2.0-alpha/_static/styles/furo-extensions.css.map b/v7.2.0/_static/styles/furo-extensions.css.map index 9ba5637f..9ba5637f 100644 --- a/v7.2.0-alpha/_static/styles/furo-extensions.css.map +++ b/v7.2.0/_static/styles/furo-extensions.css.map diff --git a/v7.2.0-alpha/_static/styles/furo.css b/v7.2.0/_static/styles/furo.css index 2df20361..2df20361 100644 --- a/v7.2.0-alpha/_static/styles/furo.css +++ b/v7.2.0/_static/styles/furo.css diff --git a/v7.2.0-alpha/_static/styles/furo.css.map b/v7.2.0/_static/styles/furo.css.map index ab2d9955..ab2d9955 100644 --- a/v7.2.0-alpha/_static/styles/furo.css.map +++ b/v7.2.0/_static/styles/furo.css.map diff --git a/v7.2.0-alpha/_static/underscore-1.13.1.js b/v7.2.0/_static/underscore-1.13.1.js index ffd77af9..ffd77af9 100644 --- a/v7.2.0-alpha/_static/underscore-1.13.1.js +++ b/v7.2.0/_static/underscore-1.13.1.js diff --git a/v7.2.0-alpha/_static/underscore.js b/v7.2.0/_static/underscore.js index cf177d42..cf177d42 100644 --- a/v7.2.0-alpha/_static/underscore.js +++ b/v7.2.0/_static/underscore.js diff --git a/v7.2.0-alpha/changelog.html b/v7.2.0/changelog.html index c0684186..eed0e791 100644 --- a/v7.2.0-alpha/changelog.html +++ b/v7.2.0/changelog.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="site_api" href="output/botcore.site_api.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>Changelog - Bot Core v7.2.0-alpha</title> + <title>Changelog - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="changelog.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="changelog.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.2.0-alpha/genindex.html b/v7.2.0/genindex.html index d68d297b..200e7bd6 100644 --- a/v7.2.0-alpha/genindex.html +++ b/v7.2.0/genindex.html @@ -4,7 +4,7 @@ <meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" /> - <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/><title>Index - Bot Core v7.2.0-alpha</title> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/><title>Index - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -125,7 +125,7 @@ </label> </div> <div class="header-center"> - <a href="index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -151,7 +151,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -203,7 +203,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="genindex.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="genindex.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.2.0-alpha/index.html b/v7.2.0/index.html index 54699637..126ef6af 100644 --- a/v7.2.0-alpha/index.html +++ b/v7.2.0/index.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Botcore" href="output/botcore.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>Bot Core v7.2.0-alpha</title> + <title>Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="#"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="#"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="index.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="index.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.2.0-alpha/index_redirect.html b/v7.2.0/index_redirect.html index 14a890cc..be28d986 100644 --- a/v7.2.0-alpha/index_redirect.html +++ b/v7.2.0/index_redirect.html @@ -9,7 +9,7 @@ <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>Bot Core v7.2.0-alpha</title> + <title>Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> diff --git a/v7.2.0-alpha/objects.inv b/v7.2.0/objects.inv Binary files differindex e83e76c0..e83e76c0 100644 --- a/v7.2.0-alpha/objects.inv +++ b/v7.2.0/objects.inv diff --git a/v7.2.0-alpha/output/botcore.async_stats.html b/v7.2.0/output/botcore.async_stats.html index f1fcf078..c7559798 100644 --- a/v7.2.0-alpha/output/botcore.async_stats.html +++ b/v7.2.0/output/botcore.async_stats.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="site_api" href="botcore.site_api.html" /><link rel="prev" title="scheduling" href="botcore.utils.scheduling.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>async_stats - Bot Core v7.2.0-alpha</title> + <title>async_stats - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="../index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.async_stats.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="botcore.async_stats.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,12 +279,12 @@ <p>An async transport method for statsd communication.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncStatsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/async_stats.py#L12-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncStatsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/async_stats.py#L12-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatsClientBase</span></code></a></p> <p>An async implementation of <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statsd.client.base.StatsClientBase</span></code></a> that supports async stat communication.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/async_stats.py#L15-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/async_stats.py#L15-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Create a new <a class="reference internal" href="#botcore.async_stats.AsyncStatsClient" title="botcore.async_stats.AsyncStatsClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncStatsClient</span></code></a>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -301,7 +301,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.async_stats.AsyncStatsClient.create_socket"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_socket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/async_stats.py#L40-L47"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.create_socket" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_socket</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/async_stats.py#L40-L47"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.async_stats.AsyncStatsClient.create_socket" title="Permalink to this definition">#</a></dt> <dd><p>Use <a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code></a> from the loop given on init to create a socket.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> diff --git a/v7.2.0-alpha/output/botcore.exts.html b/v7.2.0/output/botcore.exts.html index bc7e01f7..c9cf0cff 100644 --- a/v7.2.0-alpha/output/botcore.exts.html +++ b/v7.2.0/output/botcore.exts.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Utils" href="botcore.utils.html" /><link rel="prev" title="Botcore" href="botcore.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>Exts - Bot Core v7.2.0-alpha</title> + <title>Exts - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="../index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.exts.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="botcore.exts.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.2.0-alpha/output/botcore.html b/v7.2.0/output/botcore.html index e09e4bbe..ddba95b2 100644 --- a/v7.2.0-alpha/output/botcore.html +++ b/v7.2.0/output/botcore.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Exts" href="botcore.exts.html" /><link rel="prev" title="Bot Core Project Documentation" href="../index.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>Botcore - Bot Core v7.2.0-alpha</title> + <title>Botcore - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="../index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="botcore.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,12 +279,12 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.BotBase"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">BotBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L36-L290"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">BotBase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L36-L290"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></p> <p>A sub-class that implements many common features that Python Discord bots use.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L39-L89"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">guild_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">http_session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redis_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statsd_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L39-L89"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialise the base bot instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -303,7 +303,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.add_cog"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_cog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cog</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L152-L156"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_cog" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_cog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cog</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L152-L156"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_cog" title="Permalink to this definition">#</a></dt> <dd><p>Add the given <code class="docutils literal notranslate"><span class="pre">cog</span></code> to the bot and log the operation.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -314,7 +314,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.add_command"> -<span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L157-L161"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_command" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L157-L161"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.add_command" title="Permalink to this definition">#</a></dt> <dd><p>Add <code class="docutils literal notranslate"><span class="pre">command</span></code> as normal and then add its root aliases to the bot.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -325,7 +325,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.clear"> -<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L177-L180"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.clear" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L177-L180"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.clear" title="Permalink to this definition">#</a></dt> <dd><p>Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -336,7 +336,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L256-L290"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.close" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L256-L290"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.close" title="Permalink to this definition">#</a></dt> <dd><p>Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -347,7 +347,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.load_extensions"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_extensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L119-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.load_extensions" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_extensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L119-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.load_extensions" title="Permalink to this definition">#</a></dt> <dd><p>Load all the extensions within the given module and save them to <code class="docutils literal notranslate"><span class="pre">self.all_extensions</span></code>.</p> <p>This should be ran in a task on the event loop to avoid deadlocks caused by <code class="docutils literal notranslate"><span class="pre">wait_for</span></code> calls.</p> <dl class="field-list simple"> @@ -359,7 +359,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.log_to_dev_log"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">log_to_dev_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L205-L208"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.log_to_dev_log" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">log_to_dev_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L205-L208"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.log_to_dev_log" title="Permalink to this definition">#</a></dt> <dd><p>Log the given message to #dev-log.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -370,7 +370,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.on_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L188-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_available" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L188-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_available" title="Permalink to this definition">#</a></dt> <dd><p>Set the internal guild available event when self.guild_id becomes available.</p> <p>If the cache appears to still be empty (no members, no channels, or no roles), the event will not be set and <cite>guild_available_but_cache_empty</cite> event will be emitted.</p> @@ -383,7 +383,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.on_guild_unavailable"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L181-L187"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_unavailable" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L181-L187"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.on_guild_unavailable" title="Permalink to this definition">#</a></dt> <dd><p>Clear the internal guild available event when self.guild_id becomes unavailable.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -394,7 +394,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.ping_services"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ping_services</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L252-L255"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.ping_services" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ping_services</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L252-L255"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.ping_services" title="Permalink to this definition">#</a></dt> <dd><p>Ping all required services on setup to ensure they are up before starting.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -405,7 +405,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.remove_command"> -<span class="sig-name descname"><span class="pre">remove_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L162-L176"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.remove_command" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">remove_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L162-L176"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.remove_command" title="Permalink to this definition">#</a></dt> <dd><p>Remove a command/alias as normal and then remove its root aliases from the bot.</p> <p>Individual root aliases cannot be removed by this function. To remove them, either remove the entire command or manually edit <cite>bot.all_commands</cite>.</p> @@ -418,7 +418,7 @@ To remove them, either remove the entire command or manually edit <cite>bot.all_ <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.setup_hook"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_hook</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L218-L251"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.setup_hook" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_hook</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L218-L251"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.setup_hook" title="Permalink to this definition">#</a></dt> <dd><p>An async init to startup generic services.</p> <p>Connects to statsd, and calls <a class="reference internal" href="botcore.async_stats.html#botcore.async_stats.AsyncStatsClient.create_socket" title="botcore.async_stats.AsyncStatsClient.create_socket"><code class="xref py py-func docutils literal notranslate"><span class="pre">AsyncStatsClient.create_socket</span></code></a> @@ -432,7 +432,7 @@ and <a class="reference internal" href="#botcore.BotBase.ping_services" title="b <dl class="py method"> <dt class="sig sig-object py" id="botcore.BotBase.wait_until_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait_until_guild_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L209-L217"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.wait_until_guild_available" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait_until_guild_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L209-L217"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.BotBase.wait_until_guild_available" title="Permalink to this definition">#</a></dt> <dd><p>Wait until the guild that matches the <code class="docutils literal notranslate"><span class="pre">guild_id</span></code> given at init is available (and the cache is ready).</p> <p>The on_ready event is inadequate because it only waits 2 seconds for a GUILD_CREATE gateway event before giving up and thus not populating the cache for unavailable guilds.</p> @@ -447,12 +447,12 @@ gateway event before giving up and thus not populating the cache for unavailable <dl class="py exception"> <dt class="sig sig-object py" id="botcore.StartupError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">StartupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L28-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">StartupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L28-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Exception class for startup errors.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.StartupError.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/__init__.py#L31-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/__init__.py#L31-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.StartupError.__init__" title="Permalink to this definition">#</a></dt> <dd></dd></dl> </dd></dl> diff --git a/v7.2.0-alpha/output/botcore.site_api.html b/v7.2.0/output/botcore.site_api.html index e8a349ea..2aef4f7e 100644 --- a/v7.2.0-alpha/output/botcore.site_api.html +++ b/v7.2.0/output/botcore.site_api.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Changelog" href="../changelog.html" /><link rel="prev" title="async_stats" href="botcore.async_stats.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>site_api - Bot Core v7.2.0-alpha</title> + <title>site_api - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="../index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.site_api.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="botcore.site_api.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,12 +279,12 @@ <p>An API wrapper around the Site API.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.site_api.APIClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L42-L154"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L42-L154"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>A wrapper for the Django Site API.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L48-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L48-L71"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#botcore.site_api.APIClient" title="botcore.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">APIClient</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -299,7 +299,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L75-L78"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.close" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L75-L78"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.close" title="Permalink to this definition">#</a></dt> <dd><p>Close the aiohttp session.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -310,7 +310,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.delete"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L136-L154"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.delete" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L136-L154"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.delete" title="Permalink to this definition">#</a></dt> <dd><p>Send a DELETE request to the site API and return the JSON response.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -331,7 +331,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.get"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L120-L123"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.get" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L120-L123"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.get" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with GET passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -342,7 +342,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.maybe_raise_for_status"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maybe_raise_for_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">should_raise</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L79-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.maybe_raise_for_status" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maybe_raise_for_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">should_raise</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L79-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.maybe_raise_for_status" title="Permalink to this definition">#</a></dt> <dd><p>Raise <a class="reference internal" href="#botcore.site_api.ResponseCodeError" title="botcore.site_api.ResponseCodeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a> for non-OK response if an exception should be raised.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -362,7 +362,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.patch"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">patch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L124-L127"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.patch" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">patch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L124-L127"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.patch" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PATCH passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -373,7 +373,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.post"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L128-L131"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.post" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L128-L131"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.post" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with POST passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -384,7 +384,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.put"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">put</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L132-L135"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.put" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">put</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L132-L135"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.put" title="Permalink to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PUT passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -395,7 +395,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.APIClient.request"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L99-L119"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.request" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L99-L119"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.APIClient.request" title="Permalink to this definition">#</a></dt> <dd><p>Send an HTTP request to the site API and return the JSON response.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -422,12 +422,12 @@ <dl class="py exception"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L14-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L14-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></a></p> <p>Raised in <a class="reference internal" href="#botcore.site_api.APIClient.request" title="botcore.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> when a non-OK HTTP response is received.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L17-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L17-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#botcore.site_api.ResponseCodeError" title="botcore.site_api.ResponseCodeError"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -442,7 +442,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.site_api.ResponseCodeError.__str__"> -<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/site_api.py#L36-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__str__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/site_api.py#L36-L40"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.site_api.ResponseCodeError.__str__" title="Permalink to this definition">#</a></dt> <dd><p>Return a string representation of the error.</p> </dd></dl> diff --git a/v7.2.0-alpha/output/botcore.utils.caching.html b/v7.2.0/output/botcore.utils.caching.html index 3a9ae373..d639e32a 100644 --- a/v7.2.0-alpha/output/botcore.utils.caching.html +++ b/v7.2.0/output/botcore.utils.caching.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="channel" href="botcore.utils.channel.html" /><link rel="prev" title="Utils" href="botcore.utils.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>caching - Bot Core v7.2.0-alpha</title> + <title>caching - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="../index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.caching.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="botcore.utils.caching.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,14 +279,14 @@ <p>Utilities related to custom caches.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>LRU cache implementation for coroutines.</p> <p>Once the cache exceeds the maximum size, keys are deleted in FIFO order.</p> <p>An offset may be optionally provided to be applied to the coroutine’s arguments when creating the cache key.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.__call__"> -<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__call__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__call__" title="Permalink to this definition">#</a></dt> <dd><p>Decorator for async cache.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -303,7 +303,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialise a new <a class="reference internal" href="#botcore.utils.caching.AsyncCache" title="botcore.utils.caching.AsyncCache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncCache</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -314,7 +314,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.caching.AsyncCache.clear"> -<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.clear" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.caching.AsyncCache.clear" title="Permalink to this definition">#</a></dt> <dd><p>Clear cache instance.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> diff --git a/v7.2.0-alpha/output/botcore.utils.channel.html b/v7.2.0/output/botcore.utils.channel.html index 64f4b3e6..dcbcfd13 100644 --- a/v7.2.0-alpha/output/botcore.utils.channel.html +++ b/v7.2.0/output/botcore.utils.channel.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="logging" href="botcore.utils.logging.html" /><link rel="prev" title="caching" href="botcore.utils.caching.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>channel - Bot Core v7.2.0-alpha</title> + <title>channel - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="../index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.channel.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="botcore.utils.channel.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,7 +279,7 @@ <p>Useful helper functions for interacting with various discord channel objects.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.channel.get_or_fetch_channel"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/channel.py#L25-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.get_or_fetch_channel" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/channel.py#L25-L55"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.get_or_fetch_channel" title="Permalink to this definition">#</a></dt> <dd><p>Attempt to get or fetch the given <code class="docutils literal notranslate"><span class="pre">channel_id</span></code> from the bots cache, and return it.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -307,7 +307,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.channel.is_in_category"> -<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.is_in_category" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.channel.is_in_category" title="Permalink to this definition">#</a></dt> <dd><p>Return whether the given <code class="docutils literal notranslate"><span class="pre">channel</span></code> in the the category with the id <code class="docutils literal notranslate"><span class="pre">category_id</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> diff --git a/v7.2.0-alpha/output/botcore.utils.html b/v7.2.0/output/botcore.utils.html index e8068c29..7a5b3c2a 100644 --- a/v7.2.0-alpha/output/botcore.utils.html +++ b/v7.2.0/output/botcore.utils.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="caching" href="botcore.utils.caching.html" /><link rel="prev" title="Exts" href="botcore.exts.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>Utils - Bot Core v7.2.0-alpha</title> + <title>Utils - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="../index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="botcore.utils.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,7 +279,7 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.apply_monkey_patches"> -<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/__init__.py#L7-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">apply_monkey_patches</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/__init__.py#L7-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.apply_monkey_patches" title="Permalink to this definition">#</a></dt> <dd><p>Applies all common monkey patches for our bots.</p> <dl> <dt>Patches <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Command</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Group" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Group</span></code></a> to support root aliases.</dt><dd><p>A <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code> keyword argument is added to these two objects, which is a sequence of alias names @@ -298,7 +298,7 @@ that will act as top-level groups rather than being aliases of the command’s g <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.unqualify"> -<span class="sig-name descname"><span class="pre">unqualify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/__init__.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.unqualify" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">unqualify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/__init__.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.unqualify" title="Permalink to this definition">#</a></dt> <dd><p>Return an unqualified name given a qualified module/package <code class="docutils literal notranslate"><span class="pre">name</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> diff --git a/v7.2.0-alpha/output/botcore.utils.logging.html b/v7.2.0/output/botcore.utils.logging.html index 0880f5f1..6b4dce55 100644 --- a/v7.2.0-alpha/output/botcore.utils.logging.html +++ b/v7.2.0/output/botcore.utils.logging.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="members" href="botcore.utils.members.html" /><link rel="prev" title="channel" href="botcore.utils.channel.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>logging - Bot Core v7.2.0-alpha</title> + <title>logging - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="../index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.logging.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="botcore.utils.logging.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,12 +279,12 @@ <p>Common logging related functions.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/logging.py#L14-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/logging.py#L14-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Logger</span></code></a></p> <p>Custom implementation of the <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.Logger</span></code></a> class with an added <a class="reference internal" href="#botcore.utils.logging.CustomLogger.trace" title="botcore.utils.logging.CustomLogger.trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trace</span></code></a> method.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.logging.CustomLogger.trace"> -<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/logging.py#L17-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger.trace" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/logging.py#L17-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.CustomLogger.trace" title="Permalink to this definition">#</a></dt> <dd><p>Log the given message with the severity <code class="docutils literal notranslate"><span class="pre">"TRACE"</span></code>.</p> <p>To pass exception information, use the keyword argument exc_info with a true value:</p> <div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">logger</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s2">"Houston, we have an </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"interesting problem"</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> @@ -308,7 +308,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.logging.get_logger"> -<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/logging.py#L35-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.get_logger" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/logging.py#L35-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.logging.get_logger" title="Permalink to this definition">#</a></dt> <dd><p>Utility to make mypy recognise that logger is of type <a class="reference internal" href="#botcore.utils.logging.CustomLogger" title="botcore.utils.logging.CustomLogger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CustomLogger</span></code></a>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> diff --git a/v7.2.0-alpha/output/botcore.utils.members.html b/v7.2.0/output/botcore.utils.members.html index 695b89b0..f5a99e40 100644 --- a/v7.2.0-alpha/output/botcore.utils.members.html +++ b/v7.2.0/output/botcore.utils.members.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="regex" href="botcore.utils.regex.html" /><link rel="prev" title="logging" href="botcore.utils.logging.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>members - Bot Core v7.2.0-alpha</title> + <title>members - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="../index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.members.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="botcore.utils.members.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,7 +279,7 @@ <p>Useful helper functions for interactin with <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> objects.</p> <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.members.get_or_fetch_member"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_member</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/members.py#L12-L29"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.get_or_fetch_member" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_or_fetch_member</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/members.py#L12-L29"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.get_or_fetch_member" title="Permalink to this definition">#</a></dt> <dd><p>Attempt to get a member from cache; on failure fetch from the API.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -293,7 +293,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.members.handle_role_change"> -<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_role_change</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/members.py#L31-L57"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.handle_role_change" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_role_change</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">member</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/members.py#L31-L57"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.members.handle_role_change" title="Permalink to this definition">#</a></dt> <dd><p>Await the given <code class="docutils literal notranslate"><span class="pre">coro</span></code> with <code class="docutils literal notranslate"><span class="pre">member</span></code> as the sole argument.</p> <p>Handle errors that we expect to be raised from <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> and <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.0.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p> diff --git a/v7.2.0-alpha/output/botcore.utils.regex.html b/v7.2.0/output/botcore.utils.regex.html index 664f36e7..bb50659a 100644 --- a/v7.2.0-alpha/output/botcore.utils.regex.html +++ b/v7.2.0/output/botcore.utils.regex.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="scheduling" href="botcore.utils.scheduling.html" /><link rel="prev" title="members" href="botcore.utils.members.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>regex - Bot Core v7.2.0-alpha</title> + <title>regex - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="../index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.regex.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="botcore.utils.regex.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,7 +279,7 @@ <p>Common regular expressions.</p> <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.DISCORD_INVITE"> -<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/regex.py#L5-L16"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.DISCORD_INVITE" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/regex.py#L5-L16"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.DISCORD_INVITE" title="Permalink to this definition">#</a></dt> <dd><p>Regex for Discord server invites.</p> <div class="admonition warning"> <p class="admonition-title">Warning</p> @@ -293,7 +293,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.FORMATTED_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/regex.py#L28-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.FORMATTED_CODE_REGEX" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/regex.py#L28-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.FORMATTED_CODE_REGEX" title="Permalink to this definition">#</a></dt> <dd><p>Regex for formatted code, using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> @@ -301,7 +301,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur <dl class="py data"> <dt class="sig sig-object py" id="botcore.utils.regex.RAW_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/regex.py#L43-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.RAW_CODE_REGEX" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/regex.py#L43-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.regex.RAW_CODE_REGEX" title="Permalink to this definition">#</a></dt> <dd><p>Regex for raw code, <em>not</em> using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> diff --git a/v7.2.0-alpha/output/botcore.utils.scheduling.html b/v7.2.0/output/botcore.utils.scheduling.html index 2cf4c5f6..2dfe02d3 100644 --- a/v7.2.0-alpha/output/botcore.utils.scheduling.html +++ b/v7.2.0/output/botcore.utils.scheduling.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="async_stats" href="botcore.async_stats.html" /><link rel="prev" title="regex" href="botcore.utils.regex.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>scheduling - Bot Core v7.2.0-alpha</title> + <title>scheduling - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="../index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -205,7 +205,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="botcore.utils.scheduling.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="botcore.utils.scheduling.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -279,7 +279,7 @@ <p>Generic python scheduler.</p> <dl class="py class"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/scheduling.py#L13-L209"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler" title="Permalink to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L13-L209"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler" title="Permalink to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>Schedule the execution of coroutines and keep track of them.</p> <p>When instantiating a <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a>, a name must be provided. This name is used to distinguish the @@ -293,7 +293,7 @@ the same ID used to schedule it.</p> <p>Any exception raised in a scheduled task is logged when the task is done.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.__contains__"> -<span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/scheduling.py#L43-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__contains__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L43-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__contains__" title="Permalink to this definition">#</a></dt> <dd><p>Return <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> if a task with the given <code class="docutils literal notranslate"><span class="pre">task_id</span></code> is currently scheduled.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -310,7 +310,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/scheduling.py#L31-L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__init__" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L31-L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.__init__" title="Permalink to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#botcore.utils.scheduling.Scheduler" title="botcore.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -321,7 +321,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.cancel"> -<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/scheduling.py#L125-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L125-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel" title="Permalink to this definition">#</a></dt> <dd><p>Unschedule the task identified by <code class="docutils literal notranslate"><span class="pre">task_id</span></code>. Log a warning if the task doesn’t exist.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -335,7 +335,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.cancel_all"> -<span class="sig-name descname"><span class="pre">cancel_all</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/scheduling.py#L143-L149"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel_all" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">cancel_all</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L143-L149"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.cancel_all" title="Permalink to this definition">#</a></dt> <dd><p>Unschedule all known tasks.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -346,7 +346,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule"> -<span class="sig-name descname"><span class="pre">schedule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/scheduling.py#L55-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L55-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule" title="Permalink to this definition">#</a></dt> <dd><p>Schedule the execution of a <code class="docutils literal notranslate"><span class="pre">coroutine</span></code>.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> @@ -365,7 +365,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule_at"> -<span class="sig-name descname"><span class="pre">schedule_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/scheduling.py#L82-L105"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_at" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L82-L105"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_at" title="Permalink to this definition">#</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed at the given <code class="docutils literal notranslate"><span class="pre">time</span></code>.</p> <p>If <code class="docutils literal notranslate"><span class="pre">time</span></code> is timezone aware, then use that timezone to calculate now() when subtracting. If <code class="docutils literal notranslate"><span class="pre">time</span></code> is naïve, then use UTC.</p> @@ -388,7 +388,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py method"> <dt class="sig sig-object py" id="botcore.utils.scheduling.Scheduler.schedule_later"> -<span class="sig-name descname"><span class="pre">schedule_later</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/scheduling.py#L106-L124"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_later" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule_later</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L106-L124"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.Scheduler.schedule_later" title="Permalink to this definition">#</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed after <code class="docutils literal notranslate"><span class="pre">delay</span></code> seconds.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> @@ -410,7 +410,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py function"> <dt class="sig sig-object py" id="botcore.utils.scheduling.create_task"> -<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suppressed_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_loop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/6564b225c947e4364fcc8f8df9dc7790d5f5209f/botcore/utils/scheduling.py#L211-L239"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.create_task" title="Permalink to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suppressed_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_loop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/149e278d3b6111a6f45f31e993114b38745bb545/botcore/utils/scheduling.py#L211-L239"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#botcore.utils.scheduling.create_task" title="Permalink to this definition">#</a></dt> <dd><p>Wrapper for creating an <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.Task</span></code></a> which logs exceptions raised in the task.</p> <p>If the <code class="docutils literal notranslate"><span class="pre">event_loop</span></code> kwarg is provided, the task is created from that event loop, otherwise the running loop is used.</p> diff --git a/v7.2.0-alpha/py-modindex.html b/v7.2.0/py-modindex.html index c22c8d96..a8776c32 100644 --- a/v7.2.0-alpha/py-modindex.html +++ b/v7.2.0/py-modindex.html @@ -4,7 +4,7 @@ <meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /> - <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/><title>Python Module Index - Bot Core v7.2.0-alpha</title> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/><title>Python Module Index - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -125,7 +125,7 @@ </label> </div> <div class="header-center"> - <a href="index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -151,7 +151,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -203,7 +203,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="py-modindex.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="py-modindex.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.2.0-alpha/search.html b/v7.2.0/search.html index b38f0f64..001ed1a4 100644 --- a/v7.2.0-alpha/search.html +++ b/v7.2.0/search.html @@ -4,7 +4,7 @@ <meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="#" /> - <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/><title>Search - Bot Core v7.2.0-alpha</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" /> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/><title>Search - Bot Core v7.2.0</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> <link rel="stylesheet" type="text/css" href="_static/changelog.css" /> @@ -124,7 +124,7 @@ </label> </div> <div class="header-center"> - <a href="index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -150,7 +150,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="#" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -202,7 +202,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="search.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="search.html">v7.2.0</a> </li> <li class="toctree-l2 "> diff --git a/v7.2.0-alpha/searchindex.js b/v7.2.0/searchindex.js index 61f57628..61f57628 100644 --- a/v7.2.0-alpha/searchindex.js +++ b/v7.2.0/searchindex.js diff --git a/v7.2.0-alpha/versions.html b/v7.2.0/versions.html index d34126f4..86ef4b6d 100644 --- a/v7.2.0-alpha/versions.html +++ b/v7.2.0/versions.html @@ -5,7 +5,7 @@ <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/> - <title>Versions - Bot Core v7.2.0-alpha</title> + <title>Versions - Bot Core v7.2.0</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" /> <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" /> @@ -126,7 +126,7 @@ </label> </div> <div class="header-center"> - <a href="index.html"><div class="brand">Bot Core v7.2.0-alpha</div></a> + <a href="index.html"><div class="brand">Bot Core v7.2.0</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -152,7 +152,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Bot Core v7.2.0-alpha</span> + <span class="sidebar-brand-text">Bot Core v7.2.0</span> </a><form class="sidebar-search-container" method="get" action="search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> @@ -204,7 +204,7 @@ </li> <li class="toctree-l2 current-page"> - <a class="version_link reference internal" href="versions.html">v7.2.0-alpha</a> + <a class="version_link reference internal" href="versions.html">v7.2.0</a> </li> <li class="toctree-l2 "> @@ -287,7 +287,7 @@ </li> <li> - <a class="reference internal" href="versions.html">v7.2.0-alpha</a> + <a class="reference internal" href="versions.html">v7.2.0</a> (current) </li> |