diff options
Diffstat (limited to 'v11.1.0/output/pydis_core.utils.checks.html')
-rw-r--r-- | v11.1.0/output/pydis_core.utils.checks.html | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/v11.1.0/output/pydis_core.utils.checks.html b/v11.1.0/output/pydis_core.utils.checks.html index 9488412e..2b65c3ea 100644 --- a/v11.1.0/output/pydis_core.utils.checks.html +++ b/v11.1.0/output/pydis_core.utils.checks.html @@ -10,8 +10,8 @@ <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -480,7 +480,7 @@ <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.checks.ContextCheckFailure"> <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ContextCheckFailure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">redirect_channel</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/88c2eb6a2f065ee6055db0cf4533065cc95c87c4/pydis_core/utils/checks.py#L20-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.ContextCheckFailure" title="Link 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.CheckFailure" title="(in discord.py v2.6.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckFailure</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.CheckFailure" title="(in discord.py v2.7.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">CheckFailure</span></code></a></p> <p>Raised when a context-specific check fails.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.checks.ContextCheckFailure.__init__"> @@ -504,10 +504,10 @@ <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>rate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Number of times a command can be used before triggering a cooldown.</p></li> -<li><p><strong>per</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – The duration (in seconds) for how long the cooldown lasts.</p></li> -<li><p><strong>type</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.BucketType" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.BucketType</span></code></a>) – The type of cooldown (per user, per channel, per guild, etc.).</p></li> -<li><p><strong>bypass_roles</strong> (<em>Iterable</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – An iterable of role IDs that bypass the cooldown.</p></li> +<li><p><strong>rate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Number of times a command can be used before triggering a cooldown.</p></li> +<li><p><strong>per</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – The duration (in seconds) for how long the cooldown lasts.</p></li> +<li><p><strong>type</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.BucketType" title="(in discord.py v2.7.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.BucketType</span></code></a>) – The type of cooldown (per user, per channel, per guild, etc.).</p></li> +<li><p><strong>bypass_roles</strong> (<em>Iterable</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a><em>]</em>) – An iterable of role IDs that bypass the cooldown.</p></li> </ul> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> @@ -517,7 +517,7 @@ <dd class="field-odd"><p>Callable</p> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.13)"><strong>TypeError</strong></a> – If the decorator is not applied to an instance of <cite>Command</cite>.</p> +<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.14)"><strong>TypeError</strong></a> – If the decorator is not applied to an instance of <cite>Command</cite>.</p> </dd> </dl> </dd></dl> @@ -530,15 +530,15 @@ <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>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context where the command is being invoked.</p></li> -<li><p><strong>roles</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) – A collection of role IDs.</p></li> +<li><p><strong>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.7.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context where the command is being invoked.</p></li> +<li><p><strong>roles</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) – A collection of role IDs.</p></li> </ul> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>True if the context’s author has at least one of the specified roles; False otherwise.</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/functions.html#bool" title="(in Python v3.13)">bool</a></p> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)">bool</a></p> </dd> </dl> </dd></dl> @@ -551,15 +551,15 @@ <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>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context where the command is being invoked.</p></li> -<li><p><strong>roles</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) – A collection of role IDs.</p></li> +<li><p><strong>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.7.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context where the command is being invoked.</p></li> +<li><p><strong>roles</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) – A collection of role IDs.</p></li> </ul> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>True if the context’s author doesn’t have any of the specified roles; False otherwise.</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/functions.html#bool" title="(in Python v3.13)">bool</a></p> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)">bool</a></p> </dd> </dl> </dd></dl> @@ -571,19 +571,19 @@ <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>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.6.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context in which the command is being invoked.</p></li> -<li><p><strong>redirect</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em> | </em><em>None</em>) – The channel ID to redirect the user to, if any.</p></li> -<li><p><strong>channels</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – Whitelisted channel IDs. Defaults to ().</p></li> -<li><p><strong>categories</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – Whitelisted category IDs. Defaults to ().</p></li> -<li><p><strong>roles</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – Whitelisted role IDs. Defaults to ().</p></li> -<li><p><strong>fail_silently</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Whether to fail silently without raising an exception. Defaults to False.</p></li> +<li><p><strong>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.7.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context in which the command is being invoked.</p></li> +<li><p><strong>redirect</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a><em> | </em><em>None</em>) – The channel ID to redirect the user to, if any.</p></li> +<li><p><strong>channels</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a><em>]</em>) – Whitelisted channel IDs. Defaults to ().</p></li> +<li><p><strong>categories</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a><em>]</em>) – Whitelisted category IDs. Defaults to ().</p></li> +<li><p><strong>roles</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a><em>]</em>) – Whitelisted role IDs. Defaults to ().</p></li> +<li><p><strong>fail_silently</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – Whether to fail silently without raising an exception. Defaults to False.</p></li> </ul> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>True if the command is used in a whitelisted context; False otherwise.</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/functions.html#bool" title="(in Python v3.13)">bool</a></p> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)">bool</a></p> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> <dd class="field-even"><p><a class="reference internal" href="#pydis_core.utils.checks.InWhitelistCheckFailure" title="pydis_core.utils.checks.InWhitelistCheckFailure"><strong>InWhitelistCheckFailure</strong></a> – If the context is not whitelisted and <cite>fail_silently</cite> is False.</p> |