diff options
Diffstat (limited to 'v7.2.2')
33 files changed, 95 insertions, 18 deletions
diff --git a/v7.2.2/.buildinfo b/v7.2.2/.buildinfo index 4cc39b36..c47769f8 100644 --- a/v7.2.2/.buildinfo +++ b/v7.2.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: 3666040c0d5d1228763ad453ba1374ed +config: ef1cefaa28260cdbd469cf67fd873fd9 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v7.2.2/.doctrees/changelog.doctree b/v7.2.2/.doctrees/changelog.doctree Binary files differindex 3818bf50..a219e296 100644 --- a/v7.2.2/.doctrees/changelog.doctree +++ b/v7.2.2/.doctrees/changelog.doctree diff --git a/v7.2.2/.doctrees/environment.pickle b/v7.2.2/.doctrees/environment.pickle Binary files differindex 0991439c..7060bd91 100644 --- a/v7.2.2/.doctrees/environment.pickle +++ b/v7.2.2/.doctrees/environment.pickle diff --git a/v7.2.2/.doctrees/index.doctree b/v7.2.2/.doctrees/index.doctree Binary files differindex d3f53127..a06abb5e 100644 --- a/v7.2.2/.doctrees/index.doctree +++ b/v7.2.2/.doctrees/index.doctree diff --git a/v7.2.2/.doctrees/output/botcore.async_stats.doctree b/v7.2.2/.doctrees/output/botcore.async_stats.doctree Binary files differindex 47489b4d..9e5a2cbb 100644 --- a/v7.2.2/.doctrees/output/botcore.async_stats.doctree +++ b/v7.2.2/.doctrees/output/botcore.async_stats.doctree diff --git a/v7.2.2/.doctrees/output/botcore.doctree b/v7.2.2/.doctrees/output/botcore.doctree Binary files differindex 9db0981a..e8ed9893 100644 --- a/v7.2.2/.doctrees/output/botcore.doctree +++ b/v7.2.2/.doctrees/output/botcore.doctree diff --git a/v7.2.2/.doctrees/output/botcore.exts.doctree b/v7.2.2/.doctrees/output/botcore.exts.doctree Binary files differindex 889625e0..ffa8a941 100644 --- a/v7.2.2/.doctrees/output/botcore.exts.doctree +++ b/v7.2.2/.doctrees/output/botcore.exts.doctree diff --git a/v7.2.2/.doctrees/output/botcore.site_api.doctree b/v7.2.2/.doctrees/output/botcore.site_api.doctree Binary files differindex a142c859..ab6d2cad 100644 --- a/v7.2.2/.doctrees/output/botcore.site_api.doctree +++ b/v7.2.2/.doctrees/output/botcore.site_api.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.caching.doctree b/v7.2.2/.doctrees/output/botcore.utils.caching.doctree Binary files differindex 766a6903..9cfc61f9 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.caching.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.caching.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.channel.doctree b/v7.2.2/.doctrees/output/botcore.utils.channel.doctree Binary files differindex b38d78df..33dacea6 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.channel.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.channel.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.doctree b/v7.2.2/.doctrees/output/botcore.utils.doctree Binary files differindex 56f2b782..6d1b72e1 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.logging.doctree b/v7.2.2/.doctrees/output/botcore.utils.logging.doctree Binary files differindex 84ca184d..e73d88c5 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.logging.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.logging.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.members.doctree b/v7.2.2/.doctrees/output/botcore.utils.members.doctree Binary files differindex f0316e9c..52b4dfa4 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.members.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.members.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.regex.doctree b/v7.2.2/.doctrees/output/botcore.utils.regex.doctree Binary files differindex 3b70e0f3..9a0c432e 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.regex.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.regex.doctree diff --git a/v7.2.2/.doctrees/output/botcore.utils.scheduling.doctree b/v7.2.2/.doctrees/output/botcore.utils.scheduling.doctree Binary files differindex b68e103c..a280a2fb 100644 --- a/v7.2.2/.doctrees/output/botcore.utils.scheduling.doctree +++ b/v7.2.2/.doctrees/output/botcore.utils.scheduling.doctree diff --git a/v7.2.2/_static/pygments.css b/v7.2.2/_static/pygments.css index 053cfd3d..75471509 100644 --- a/v7.2.2/_static/pygments.css +++ b/v7.2.2/_static/pygments.css @@ -54,6 +54,7 @@ .highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #000000 } /* Name.Variable */ .highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ .highlight .w { color: #f8f8f8 } /* Text.Whitespace */ .highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ @@ -138,6 +139,7 @@ body[data-theme="dark"] .highlight .py { color: #d0d0d0 } /* Name.Property */ body[data-theme="dark"] .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body[data-theme="dark"] .highlight .nv { color: #40ffff } /* Name.Variable */ body[data-theme="dark"] .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body[data-theme="dark"] .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body[data-theme="dark"] .highlight .w { color: #666666 } /* Text.Whitespace */ body[data-theme="dark"] .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body[data-theme="dark"] .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ @@ -222,6 +224,7 @@ body:not([data-theme="light"]) .highlight .py { color: #d0d0d0 } /* Name.Propert body:not([data-theme="light"]) .highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */ body:not([data-theme="light"]) .highlight .nv { color: #40ffff } /* Name.Variable */ body:not([data-theme="light"]) .highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */ +body:not([data-theme="light"]) .highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */ body:not([data-theme="light"]) .highlight .w { color: #666666 } /* Text.Whitespace */ body:not([data-theme="light"]) .highlight .mb { color: #51b2fd } /* Literal.Number.Bin */ body:not([data-theme="light"]) .highlight .mf { color: #51b2fd } /* Literal.Number.Float */ diff --git a/v7.2.2/changelog.html b/v7.2.2/changelog.html index 8a688ed8..b2c0c939 100644 --- a/v7.2.2/changelog.html +++ b/v7.2.2/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.2/genindex.html b/v7.2.2/genindex.html index 6f6a05d0..73891c3f 100644 --- a/v7.2.2/genindex.html +++ b/v7.2.2/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.2/index.html b/v7.2.2/index.html index 2d3958fd..2b620e17 100644 --- a/v7.2.2/index.html +++ b/v7.2.2/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.2/output/botcore.async_stats.html b/v7.2.2/output/botcore.async_stats.html index 7c6446b4..9a9fde43 100644 --- a/v7.2.2/output/botcore.async_stats.html +++ b/v7.2.2/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.2/output/botcore.exts.html b/v7.2.2/output/botcore.exts.html index 4c10503d..4c078d3a 100644 --- a/v7.2.2/output/botcore.exts.html +++ b/v7.2.2/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.2/output/botcore.html b/v7.2.2/output/botcore.html index 762a6c4d..d2a1723c 100644 --- a/v7.2.2/output/botcore.html +++ b/v7.2.2/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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.2/output/botcore.site_api.html b/v7.2.2/output/botcore.site_api.html index a6fb5ece..5477ae36 100644 --- a/v7.2.2/output/botcore.site_api.html +++ b/v7.2.2/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.2/output/botcore.utils.caching.html b/v7.2.2/output/botcore.utils.caching.html index 4b4ab2ba..dec2a6ce 100644 --- a/v7.2.2/output/botcore.utils.caching.html +++ b/v7.2.2/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.2/output/botcore.utils.channel.html b/v7.2.2/output/botcore.utils.channel.html index ffa47575..b0fa107d 100644 --- a/v7.2.2/output/botcore.utils.channel.html +++ b/v7.2.2/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.2/output/botcore.utils.html b/v7.2.2/output/botcore.utils.html index 41458bf2..1f521085 100644 --- a/v7.2.2/output/botcore.utils.html +++ b/v7.2.2/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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.2/output/botcore.utils.logging.html b/v7.2.2/output/botcore.utils.logging.html index eaa9465d..8b3f8591 100644 --- a/v7.2.2/output/botcore.utils.logging.html +++ b/v7.2.2/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.2/output/botcore.utils.members.html b/v7.2.2/output/botcore.utils.members.html index 19ee3880..c23cd4d2 100644 --- a/v7.2.2/output/botcore.utils.members.html +++ b/v7.2.2/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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/70bdf0f7e50cf182390dbeed38232438d54ea16e/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.2/output/botcore.utils.regex.html b/v7.2.2/output/botcore.utils.regex.html index e9a45b57..806f60c7 100644 --- a/v7.2.2/output/botcore.utils.regex.html +++ b/v7.2.2/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.2/output/botcore.utils.scheduling.html b/v7.2.2/output/botcore.utils.scheduling.html index 5e11318b..c88dfd3d 100644 --- a/v7.2.2/output/botcore.utils.scheduling.html +++ b/v7.2.2/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.2/py-modindex.html b/v7.2.2/py-modindex.html index a969ba44..7e1ea2c6 100644 --- a/v7.2.2/py-modindex.html +++ b/v7.2.2/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.2/search.html b/v7.2.2/search.html index 618df21b..b44d330b 100644 --- a/v7.2.2/search.html +++ b/v7.2.2/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.2/versions.html b/v7.2.2/versions.html index 55ccd5b8..2ef9652b 100644 --- a/v7.2.2/versions.html +++ b/v7.2.2/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> |