aboutsummaryrefslogtreecommitdiffstats
path: root/main/output/pydis_core.utils.checks.html
diff options
context:
space:
mode:
authorGravatar ChrisLovering <[email protected]>2024-03-04 14:53:52 +0000
committerGravatar ChrisLovering <[email protected]>2024-03-04 14:53:52 +0000
commit3eb5ff4e3f0a841d28d8c742eba2e562f9fc2231 (patch)
treecc57ad52e9e9efb2ab82c0bd8596522ace108556 /main/output/pydis_core.utils.checks.html
parentDeploying to docs from @ python-discord/bot-core@69eeda8a1914b671af68871dcf55... (diff)
Deploying to docs from @ python-discord/bot-core@c72b515aec03b1d9df49a3d58bfa90a3d864160e 🚀
Diffstat (limited to 'main/output/pydis_core.utils.checks.html')
-rw-r--r--main/output/pydis_core.utils.checks.html94
1 files changed, 7 insertions, 87 deletions
diff --git a/main/output/pydis_core.utils.checks.html b/main/output/pydis_core.utils.checks.html
index cd544ee0..4c04dc35 100644
--- a/main/output/pydis_core.utils.checks.html
+++ b/main/output/pydis_core.utils.checks.html
@@ -280,86 +280,6 @@
</li>
<li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.3.0-beta/index.html">v8.3.0-beta</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.2.1/index.html">v8.2.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.2.0/index.html">v8.2.0</a>
- </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>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0-beta.3/index.html">v8.0.0-beta.3</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0-beta.2/index.html">v8.0.0-beta.2</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0-beta.1/index.html">v8.0.0-beta.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v8.0.0/index.html">v8.0.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.5.0/index.html">v7.5.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.4.0-beta1/index.html">v7.4.0-beta1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.4.0/index.html">v7.4.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.3.1/index.html">v7.3.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.3.0/index.html">v7.3.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.2.2/index.html">v7.2.2</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.2.1/index.html">v7.2.1</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.2.0/index.html">v7.2.0</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.1.3/index.html">v7.1.3</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.1.2/index.html">v7.1.2</a>
- </li>
-
- <li class="toctree-l2 ">
- <a class="version_link reference internal" href="../../v7.1.1/index.html">v7.1.1</a>
- </li>
-
- <li class="toctree-l2 ">
<a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.checks.html">v10.7.0</a>
</li>
@@ -454,26 +374,26 @@
<span id="checks"></span><h1>checks<a class="headerlink" href="#module-pydis_core.utils.checks" title="Link to this heading">#</a></h1>
<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/69eeda8a1914b671af68871dcf55661c5089b338/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>
+<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/c72b515aec03b1d9df49a3d58bfa90a3d864160e/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.4.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__">
-<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">redirect_channel</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/69eeda8a1914b671af68871dcf55661c5089b338/pydis_core/utils/checks.py#L23-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.ContextCheckFailure.__init__" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">redirect_channel</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c72b515aec03b1d9df49a3d58bfa90a3d864160e/pydis_core/utils/checks.py#L23-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.ContextCheckFailure.__init__" title="Link to this definition">#</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="pydis_core.utils.checks.InWhitelistCheckFailure">
-<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">InWhitelistCheckFailure</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/69eeda8a1914b671af68871dcf55661c5089b338/pydis_core/utils/checks.py#L36-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.InWhitelistCheckFailure" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">InWhitelistCheckFailure</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/c72b515aec03b1d9df49a3d58bfa90a3d864160e/pydis_core/utils/checks.py#L36-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.InWhitelistCheckFailure" title="Link to this definition">#</a></dt>
<dd><p>Bases: <a class="reference internal" href="#pydis_core.utils.checks.ContextCheckFailure" title="pydis_core.utils.checks.ContextCheckFailure"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContextCheckFailure</span></code></a></p>
<p>Raised when the <cite>in_whitelist</cite> check fails.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pydis_core.utils.checks.cooldown_with_role_bypass">
-<span class="sig-name descname"><span class="pre">cooldown_with_role_bypass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rate</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">per</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('default',</span> <span class="pre">0)</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bypass_roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/69eeda8a1914b671af68871dcf55661c5089b338/pydis_core/utils/checks.py#L99-L160"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.cooldown_with_role_bypass" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">cooldown_with_role_bypass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rate</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">per</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type_</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('default',</span> <span class="pre">0)</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bypass_roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c72b515aec03b1d9df49a3d58bfa90a3d864160e/pydis_core/utils/checks.py#L100-L161"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.cooldown_with_role_bypass" title="Link to this definition">#</a></dt>
<dd><p>Decorate a command to have a cooldown, which can be bypassed by users with specified roles.</p>
<p>Note: This replaces the <cite>Command.before_invoke</cite> callback, which <em>might</em> introduce problems in the future.</p>
<dl class="field-list simple">
@@ -499,7 +419,7 @@
<dl class="py function">
<dt class="sig sig-object py" id="pydis_core.utils.checks.has_any_role_check">
-<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">has_any_role_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/69eeda8a1914b671af68871dcf55661c5089b338/pydis_core/utils/checks.py#L162-L192"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.has_any_role_check" title="Link to this definition">#</a></dt>
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">has_any_role_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c72b515aec03b1d9df49a3d58bfa90a3d864160e/pydis_core/utils/checks.py#L163-L193"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.has_any_role_check" title="Link to this definition">#</a></dt>
<dd><p>Verify if the context’s author has any of the specified roles.</p>
<p>This check will always fail if the context is a DM, since DMs don’t have roles.</p>
<dl class="field-list simple">
@@ -520,7 +440,7 @@
<dl class="py function">
<dt class="sig sig-object py" id="pydis_core.utils.checks.has_no_roles_check">
-<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">has_no_roles_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/69eeda8a1914b671af68871dcf55661c5089b338/pydis_core/utils/checks.py#L194-L221"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.has_no_roles_check" title="Link to this definition">#</a></dt>
+<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">has_no_roles_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">roles</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c72b515aec03b1d9df49a3d58bfa90a3d864160e/pydis_core/utils/checks.py#L195-L222"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.has_no_roles_check" title="Link to this definition">#</a></dt>
<dd><p>Verify if the context’s author doesn’t have any of the specified roles.</p>
<p>This check will always fail if the context is a DM, since DMs don’t have roles.</p>
<dl class="field-list simple">
@@ -541,7 +461,7 @@
<dl class="py function">
<dt class="sig sig-object py" id="pydis_core.utils.checks.in_whitelist_check">
-<span class="sig-name descname"><span class="pre">in_whitelist_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redirect</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">categories</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fail_silently</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/69eeda8a1914b671af68871dcf55661c5089b338/pydis_core/utils/checks.py#L40-L97"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.in_whitelist_check" title="Link to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">in_whitelist_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">redirect</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">categories</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fail_silently</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/c72b515aec03b1d9df49a3d58bfa90a3d864160e/pydis_core/utils/checks.py#L40-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.checks.in_whitelist_check" title="Link to this definition">#</a></dt>
<dd><p>Check if a command was issued in a context that is whitelisted by channel, category, or roles.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>