diff options
Diffstat (limited to 'v7.2.1')
33 files changed, 95 insertions, 18 deletions
diff --git a/v7.2.1/.buildinfo b/v7.2.1/.buildinfo index ba30a3bb..7dd1a0c4 100644 --- a/v7.2.1/.buildinfo +++ b/v7.2.1/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: e8b08ae34208c2284bb4194b53bfa0db +config: b4e073a89c30e3e4dac61857af171c01 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.2.1/.doctrees/changelog.doctree b/v7.2.1/.doctrees/changelog.doctree Binary files differindex f4af6cf7..e5afa7a4 100644 --- a/v7.2.1/.doctrees/changelog.doctree +++ b/v7.2.1/.doctrees/changelog.doctree diff --git a/v7.2.1/.doctrees/environment.pickle b/v7.2.1/.doctrees/environment.pickle Binary files differindex 22da07f1..12962083 100644 --- a/v7.2.1/.doctrees/environment.pickle +++ b/v7.2.1/.doctrees/environment.pickle diff --git a/v7.2.1/.doctrees/index.doctree b/v7.2.1/.doctrees/index.doctree Binary files differindex a72c2acb..6aa456c8 100644 --- a/v7.2.1/.doctrees/index.doctree +++ b/v7.2.1/.doctrees/index.doctree diff --git a/v7.2.1/.doctrees/output/botcore.async_stats.doctree b/v7.2.1/.doctrees/output/botcore.async_stats.doctree Binary files differindex 3e89ded2..c2250d4c 100644 --- a/v7.2.1/.doctrees/output/botcore.async_stats.doctree +++ b/v7.2.1/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.2.1/.doctrees/output/botcore.doctree b/v7.2.1/.doctrees/output/botcore.doctree Binary files differindex 0ca62b3d..e70e0bb3 100644 --- a/v7.2.1/.doctrees/output/botcore.doctree +++ b/v7.2.1/.doctrees/output/botcore.doctree diff --git a/v7.2.1/.doctrees/output/botcore.exts.doctree b/v7.2.1/.doctrees/output/botcore.exts.doctree Binary files differindex 1f18544d..105f892e 100644 --- a/v7.2.1/.doctrees/output/botcore.exts.doctree +++ b/v7.2.1/.doctrees/output/botcore.exts.doctree diff --git a/v7.2.1/.doctrees/output/botcore.site_api.doctree b/v7.2.1/.doctrees/output/botcore.site_api.doctree Binary files differindex 7777f8b4..110e18e9 100644 --- a/v7.2.1/.doctrees/output/botcore.site_api.doctree +++ b/v7.2.1/.doctrees/output/botcore.site_api.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.caching.doctree b/v7.2.1/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 7f5a35ba..f0ab958f 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.channel.doctree b/v7.2.1/.doctrees/output/botcore.utils.channel.doctree Binary files differindex 55856f23..2b678e47 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.doctree b/v7.2.1/.doctrees/output/botcore.utils.doctree Binary files differindex a987fe65..ad18ec6e 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.logging.doctree b/v7.2.1/.doctrees/output/botcore.utils.logging.doctree Binary files differindex fc9b11d7..c3574f1d 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.members.doctree b/v7.2.1/.doctrees/output/botcore.utils.members.doctree Binary files differindex 9c13d015..406d6a12 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.members.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.regex.doctree b/v7.2.1/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 519d5c60..c6b20a11 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree b/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex 8533dd70..4fc47fe4 100644 --- a/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.2.1/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.2.1/_static/pygments.css b/v7.2.1/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v7.2.1/_static/pygments.css +++ b/v7.2.1/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v7.2.1/changelog.html b/v7.2.1/changelog.html index 647f0bd4..079e7043 100644 --- a/v7.2.1/changelog.html +++ b/v7.2.1/changelog.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v8.1.0/changelog.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v8.0.0-beta.4/changelog.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/genindex.html b/v7.2.1/genindex.html index 39757575..c0fa7916 100644 --- a/v7.2.1/genindex.html +++ b/v7.2.1/genindex.html @@ -203,6 +203,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v8.1.0/index.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/index.html b/v7.2.1/index.html index 9d1e15c5..003d2a74 100644 --- a/v7.2.1/index.html +++ b/v7.2.1/index.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v8.1.0/index.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/output/botcore.async_stats.html b/v7.2.1/output/botcore.async_stats.html index 0e9e8335..be87d17c 100644 --- a/v7.2.1/output/botcore.async_stats.html +++ b/v7.2.1/output/botcore.async_stats.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/output/botcore.async_stats.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.async_stats.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/output/botcore.exts.html b/v7.2.1/output/botcore.exts.html index 40d6e484..a04eca6a 100644 --- a/v7.2.1/output/botcore.exts.html +++ b/v7.2.1/output/botcore.exts.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/output/botcore.exts.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.exts.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/output/botcore.html b/v7.2.1/output/botcore.html index 29e9d19f..70885829 100644 --- a/v7.2.1/output/botcore.html +++ b/v7.2.1/output/botcore.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/output/botcore.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.html">v8.0.0-beta.4</a> </li> @@ -328,7 +332,7 @@ <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/259eeb84f1d935e5254acbf673144f0b98aad965/botcore/_bot.py#L36-L292"><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> +<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.1.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__"> @@ -459,7 +463,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><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.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a>]</p> </dd> </dl> </dd></dl> diff --git a/v7.2.1/output/botcore.site_api.html b/v7.2.1/output/botcore.site_api.html index f7a84354..90beefc2 100644 --- a/v7.2.1/output/botcore.site_api.html +++ b/v7.2.1/output/botcore.site_api.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/output/botcore.site_api.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.site_api.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/output/botcore.utils.caching.html b/v7.2.1/output/botcore.utils.caching.html index 2f1f960f..c2a74ba9 100644 --- a/v7.2.1/output/botcore.utils.caching.html +++ b/v7.2.1/output/botcore.utils.caching.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.caching.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.utils.caching.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/output/botcore.utils.channel.html b/v7.2.1/output/botcore.utils.channel.html index 5a6ddda5..77023589 100644 --- a/v7.2.1/output/botcore.utils.channel.html +++ b/v7.2.1/output/botcore.utils.channel.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.channel.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.utils.channel.html">v8.0.0-beta.4</a> </li> @@ -332,20 +336,20 @@ <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>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>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.1.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.1.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> </ul> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> <dd class="field-even"><ul class="simple"> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.InvalidData" title="(in discord.py v2.0.0a)"><strong>discord.InvalidData</strong></a> – An unknown channel type was received from Discord.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.HTTPException" title="(in discord.py v2.0.0a)"><strong>discord.HTTPException</strong></a> – Retrieving the channel failed.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.NotFound" title="(in discord.py v2.0.0a)"><strong>discord.NotFound</strong></a> – Invalid Channel ID.</p></li> -<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.0.0a)"><strong>discord.Forbidden</strong></a> – You do not have permission to fetch this channel.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.InvalidData" title="(in discord.py v2.1.0a)"><strong>discord.InvalidData</strong></a> – An unknown channel type was received from Discord.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.HTTPException" title="(in discord.py v2.1.0a)"><strong>discord.HTTPException</strong></a> – Retrieving the channel failed.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.NotFound" title="(in discord.py v2.1.0a)"><strong>discord.NotFound</strong></a> – Invalid Channel ID.</p></li> +<li><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.1.0a)"><strong>discord.Forbidden</strong></a> – You do not have permission to fetch this channel.</p></li> </ul> </dd> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.GuildChannel" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuildChannel</span></code></a></p> +<dd class="field-odd"><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.abc.GuildChannel" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">GuildChannel</span></code></a></p> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>The channel from the ID.</p> @@ -360,7 +364,7 @@ <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>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>channel</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.TextChannel" title="(in discord.py v2.1.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> </ul> </dd> diff --git a/v7.2.1/output/botcore.utils.html b/v7.2.1/output/botcore.utils.html index 3281912a..c83ce9c4 100644 --- a/v7.2.1/output/botcore.utils.html +++ b/v7.2.1/output/botcore.utils.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.utils.html">v8.0.0-beta.4</a> </li> @@ -330,7 +334,7 @@ <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/259eeb84f1d935e5254acbf673144f0b98aad965/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 +<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.1.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.1.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 that will act as top-level groups rather than being aliases of the command’s group.</p> <p>It’s stored as an attribute also named <code class="docutils literal notranslate"><span class="pre">root_aliases</span></code></p> </dd> diff --git a/v7.2.1/output/botcore.utils.logging.html b/v7.2.1/output/botcore.utils.logging.html index b7bbc128..49456a03 100644 --- a/v7.2.1/output/botcore.utils.logging.html +++ b/v7.2.1/output/botcore.utils.logging.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.logging.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.utils.logging.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/output/botcore.utils.members.html b/v7.2.1/output/botcore.utils.members.html index 01fab044..b60d4c1a 100644 --- a/v7.2.1/output/botcore.utils.members.html +++ b/v7.2.1/output/botcore.utils.members.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.members.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.utils.members.html">v8.0.0-beta.4</a> </li> @@ -324,17 +328,17 @@ <article role="main"> <section id="module-botcore.utils.members"> <span id="members"></span><h1>members<a class="headerlink" href="#module-botcore.utils.members" title="Permalink to this heading">#</a></h1> -<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> +<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.1.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/259eeb84f1d935e5254acbf673144f0b98aad965/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> -<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><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.1.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.1.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> </dl> </dd></dl> @@ -344,13 +348,13 @@ <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/259eeb84f1d935e5254acbf673144f0b98aad965/botcore/utils/members.py#L31-L58"><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">role</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> +<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.1.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.1.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</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>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 that is being modified for logging purposes.</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://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.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>role</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.0.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a>) – The role to be passed to <code class="docutils literal notranslate"><span class="pre">coro</span></code>.</p></li> +<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.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a>) – The member that is being modified for logging purposes.</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://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.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.1.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.1.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>role</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.1.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a>) – The role to be passed to <code class="docutils literal notranslate"><span class="pre">coro</span></code>.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> diff --git a/v7.2.1/output/botcore.utils.regex.html b/v7.2.1/output/botcore.utils.regex.html index a082e57c..495355be 100644 --- a/v7.2.1/output/botcore.utils.regex.html +++ b/v7.2.1/output/botcore.utils.regex.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.regex.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.utils.regex.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/output/botcore.utils.scheduling.html b/v7.2.1/output/botcore.utils.scheduling.html index 07f24789..09360878 100644 --- a/v7.2.1/output/botcore.utils.scheduling.html +++ b/v7.2.1/output/botcore.utils.scheduling.html @@ -205,6 +205,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v8.1.0/output/botcore.utils.scheduling.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v8.0.0-beta.4/output/botcore.utils.scheduling.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/py-modindex.html b/v7.2.1/py-modindex.html index f075132a..555971f1 100644 --- a/v7.2.1/py-modindex.html +++ b/v7.2.1/py-modindex.html @@ -203,6 +203,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v8.1.0/index.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/search.html b/v7.2.1/search.html index 62cd2502..c943e6c6 100644 --- a/v7.2.1/search.html +++ b/v7.2.1/search.html @@ -202,6 +202,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v8.1.0/index.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a> </li> diff --git a/v7.2.1/versions.html b/v7.2.1/versions.html index c3ab5359..a58331a5 100644 --- a/v7.2.1/versions.html +++ b/v7.2.1/versions.html @@ -204,6 +204,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../v8.1.0/index.html">v8.1.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a> </li> @@ -335,6 +339,12 @@ </li> <li> + <a class="reference internal" href="../v8.1.0/index.html">v8.1.0</a> + + + </li> + + <li> <a class="reference internal" href="../v8.0.0-beta.4/index.html">v8.0.0-beta.4</a> |