diff options
author | 2024-11-23 18:47:50 +0000 | |
---|---|---|
committer | 2024-11-23 18:47:50 +0000 | |
commit | 4497a82c504818d61ab18c5251ae2bc42bae279e (patch) | |
tree | 787e4916831cac5ae07115fdf2b2bcc49f0a04e0 /v10.6.0/output/pydis_core.utils.checks.html | |
parent | Deploying to docs from @ python-discord/bot-core@06b1ada5772490e18a7ab1b96d05... (diff) |
Deploying to docs from @ python-discord/bot-core@bdaaa2e76d4cb32843754757532ef8d73ac97761 π
Diffstat (limited to 'v10.6.0/output/pydis_core.utils.checks.html')
-rw-r--r-- | v10.6.0/output/pydis_core.utils.checks.html | 42 |
1 files changed, 25 insertions, 17 deletions
diff --git a/v10.6.0/output/pydis_core.utils.checks.html b/v10.6.0/output/pydis_core.utils.checks.html index 278e17b0..208fdf45 100644 --- a/v10.6.0/output/pydis_core.utils.checks.html +++ b/v10.6.0/output/pydis_core.utils.checks.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="commands" href="pydis_core.utils.commands.html" /><link rel="prev" title="channel" href="pydis_core.utils.channel.html" /> - <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>checks - Pydis Core v10.6.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <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" /> @@ -323,6 +323,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.checks.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.checks.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.checks.html">v11.3.1</a> </li> @@ -472,10 +480,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.12)"><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.12)"><em>float</em></a>) β The duration (in seconds) for how long the cooldown lasts.</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.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.5.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.12)"><em>int</em></a><em>]</em>) β An iterable of role IDs that bypass the cooldown.</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> </ul> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> @@ -485,7 +493,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.12)"><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.13)"><strong>TypeError</strong></a> β If the decorator is not applied to an instance of <cite>Command</cite>.</p> </dd> </dl> </dd></dl> @@ -499,14 +507,14 @@ <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.5.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.12)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) β A collection of role IDs.</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> </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.12)">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.13)">bool</a></p> </dd> </dl> </dd></dl> @@ -520,14 +528,14 @@ <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.5.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.12)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) β A collection of role IDs.</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> </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.12)">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.13)">bool</a></p> </dd> </dl> </dd></dl> @@ -540,18 +548,18 @@ <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.5.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.12)"><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.12)"><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.12)"><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.12)"><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.12)"><em>bool</em></a>) β Whether to fail silently without raising an exception. Defaults to False.</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> </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.12)">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.13)">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> @@ -638,7 +646,7 @@ </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> |