diff options
| author | 2024-03-18 12:23:05 +0000 | |
|---|---|---|
| committer | 2024-03-18 12:23:05 +0000 | |
| commit | e79c3c076609cb244d2f9dbfe550e7d9d23d13e5 (patch) | |
| tree | 8359a0a08b77422e6865f97c4a1082e3102372c8 /main/output | |
| parent | Deploying to docs from @ python-discord/bot-core@9a497193db7cca2d64cd99251f34... (diff) | |
Deploying to docs from @ python-discord/bot-core@1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91 🚀
Diffstat (limited to 'main/output')
24 files changed, 2144 insertions, 259 deletions
diff --git a/main/output/pydis_core.async_stats.html b/main/output/pydis_core.async_stats.html index 3651c3fd..3c635253 100644 --- a/main/output/pydis_core.async_stats.html +++ b/main/output/pydis_core.async_stats.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="site_api" href="pydis_core.site_api.html" /><link rel="prev" title="scheduling" href="pydis_core.utils.scheduling.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>async_stats - Pydis Core Latest (10.7.0)</title> + <title>async_stats - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.async_stats.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.async_stats.html">v10.7.0</a> </li> @@ -375,12 +386,12 @@ <p>An async transport method for statsd communication.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.async_stats.AsyncStatsClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncStatsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/async_stats.py#L11-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncStatsClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/async_stats.py#L11-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-class docutils literal notranslate"><span class="pre">StatsClientBase</span></code></a></p> <p>An async implementation of <a class="reference external" href="https://statsd.readthedocs.io/en/v3.3/reference.html#statsd.client.base.StatsClientBase" title="(in Python StatsD - Edited by Python Discord to extend statsd base objects to also allow referencing statsd.client.base.StatsClientBase v3.3)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">statsd.client.base.StatsClientBase</span></code></a> that supports async stat communication.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.async_stats.AsyncStatsClient.__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">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/async_stats.py#L14-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient.__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">loop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'localhost'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8125</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/async_stats.py#L14-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient.__init__" title="Link to this definition">#</a></dt> <dd><p>Create a new <a class="reference internal" href="#pydis_core.async_stats.AsyncStatsClient" title="pydis_core.async_stats.AsyncStatsClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncStatsClient</span></code></a>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -397,7 +408,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.async_stats.AsyncStatsClient.create_socket"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_socket</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/async_stats.py#L39-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient.create_socket" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_socket</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/async_stats.py#L39-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.async_stats.AsyncStatsClient.create_socket" title="Link to this definition">#</a></dt> <dd><p>Use <a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code></a> from the loop given on init to create a socket.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -482,7 +493,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.exts.html b/main/output/pydis_core.exts.html index 54749437..4a0b6f5e 100644 --- a/main/output/pydis_core.exts.html +++ b/main/output/pydis_core.exts.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Utils" href="pydis_core.utils.html" /><link rel="prev" title="Pydis Core" href="pydis_core.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>Exts - Pydis Core Latest (10.7.0)</title> + <title>Exts - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Exts</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.exts.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.exts.html">v10.7.0</a> </li> @@ -424,7 +435,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.html b/main/output/pydis_core.html index 79429187..b0d3d54e 100644 --- a/main/output/pydis_core.html +++ b/main/output/pydis_core.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Exts" href="pydis_core.exts.html" /><link rel="prev" title="Bot Core Project Documentation" href="../index.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>Pydis Core - Pydis Core Latest (10.7.0)</title> + <title>Pydis Core - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.html">v10.7.0</a> </li> @@ -375,12 +386,12 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L35-L326"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase" title="Link to this definition">#</a></dt> +<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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase" 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.Bot" title="(in discord.py v2.4.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 attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.guild_id"> -<span class="sig-name descname"><span class="pre">guild_id</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L35-L326"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.guild_id" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">guild_id</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.guild_id" title="Link to this definition">#</a></dt> <dd><p>ID of the guild that the bot belongs to.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -391,7 +402,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.http_session"> -<span class="sig-name descname"><span class="pre">http_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L35-L326"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.http_session" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">http_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.http_session" title="Link to this definition">#</a></dt> <dd><p>The http session used for sending out HTTP requests.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -402,7 +413,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.api_client"> -<span class="sig-name descname"><span class="pre">api_client</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L35-L326"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.api_client" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">api_client</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.api_client" title="Link to this definition">#</a></dt> <dd><p>The API client used for communications with the site service.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -413,7 +424,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.statsd_url"> -<span class="sig-name descname"><span class="pre">statsd_url</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L35-L326"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.statsd_url" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">statsd_url</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.statsd_url" title="Link to this definition">#</a></dt> <dd><p>The url that statsd sends metrics to.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -424,7 +435,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.redis_session"> -<span class="sig-name descname"><span class="pre">redis_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L35-L326"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.redis_session" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">redis_session</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.redis_session" title="Link to this definition">#</a></dt> <dd><p>The redis session used to communicate with the Redis instance.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -435,7 +446,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.stats"> -<span class="sig-name descname"><span class="pre">stats</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L35-L326"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.stats" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">stats</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.stats" title="Link to this definition">#</a></dt> <dd><p>The statsd client that sends metrics.</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -446,7 +457,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.BotBase.all_extensions"> -<span class="sig-name descname"><span class="pre">all_extensions</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L35-L326"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.all_extensions" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">all_extensions</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L54-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.all_extensions" title="Link to this definition">#</a></dt> <dd><p>All extensions that were found within the <code class="docutils literal notranslate"><span class="pre">module</span></code> passed to <code class="docutils literal notranslate"><span class="pre">self.load_extensions</span></code>. Use <code class="docutils literal notranslate"><span class="pre">self.extensions</span></code> to get the loaded extensions.</p> <dl class="field-list simple"> @@ -458,7 +469,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.__init__"> -<span class="sig-name descname"><span class="pre">__init__</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L51-L102"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.__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="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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L70-L123"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.__init__" title="Link to this definition">#</a></dt> <dd><p>Initialise the base bot instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -477,7 +488,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.add_cog"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_cog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cog</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L181-L185"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_cog" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_cog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cog</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L212-L216"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_cog" title="Link to this definition">#</a></dt> <dd><p>Add the given <code class="docutils literal notranslate"><span class="pre">cog</span></code> to the bot and log the operation.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -488,7 +499,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.add_command"> -<span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L186-L190"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_command" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">add_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">command</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L217-L221"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.add_command" title="Link to this definition">#</a></dt> <dd><p>Add <code class="docutils literal notranslate"><span class="pre">command</span></code> as normal and then add its root aliases to the bot.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -499,7 +510,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.clear"> -<span class="sig-name descname"><span class="pre">clear</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L206-L209"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.clear" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">clear</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L237-L240"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.clear" title="Link to this definition">#</a></dt> <dd><p>Not implemented! Re-instantiate the bot instead of attempting to re-use a closed one.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -510,7 +521,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L295-L326"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.close" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L326-L357"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.close" title="Link to this definition">#</a></dt> <dd><p>Close the Discord connection, and the aiohttp session, connector, statsd client, and resolver.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -521,7 +532,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.load_extensions"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_extensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</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">sync_app_commands</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L149-L159"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.load_extensions" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">load_extensions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">module</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">sync_app_commands</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L180-L190"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.load_extensions" title="Link to this definition">#</a></dt> <dd><p>Load all the extensions within the given <code class="docutils literal notranslate"><span class="pre">module</span></code> and save them to <code class="docutils literal notranslate"><span class="pre">self.all_extensions</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -535,7 +546,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.log_to_dev_log"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">log_to_dev_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L234-L236"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.log_to_dev_log" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">log_to_dev_log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L265-L267"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.log_to_dev_log" title="Link to this definition">#</a></dt> <dd><p>Log the given message to #dev-log.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -546,7 +557,7 @@ a dummy statsd client will be created.</p></li> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.on_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L217-L233"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_available" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_available</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L248-L264"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_available" title="Link to this definition">#</a></dt> <dd><p>Set the internal guild available event when self.guild_id becomes available.</p> <p>If the cache appears to still be empty (no members, no channels, or no roles), the event will not be set and <cite>guild_available_but_cache_empty</cite> event will be emitted.</p> @@ -559,7 +570,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.on_guild_unavailable"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L210-L216"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_unavailable" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_guild_unavailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">guild</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L241-L247"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.on_guild_unavailable" title="Link to this definition">#</a></dt> <dd><p>Clear the internal guild available event when self.guild_id becomes unavailable.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -570,7 +581,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.ping_services"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ping_services</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L292-L294"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.ping_services" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ping_services</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L323-L325"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.ping_services" title="Link to this definition">#</a></dt> <dd><p>Ping all required services on setup to ensure they are up before starting.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -581,7 +592,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.process_commands"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_commands</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L246-L255"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.process_commands" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_commands</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L277-L286"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.process_commands" title="Link to this definition">#</a></dt> <dd><p>Overwrite default Discord.py behaviour to process commands only after ensuring extensions are loaded.</p> <p>This extension check is only relevant for clients that make use of <a class="reference internal" href="#pydis_core.BotBase.load_extensions" title="pydis_core.BotBase.load_extensions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.BotBase.load_extensions</span></code></a>.</p> <dl class="field-list simple"> @@ -592,8 +603,21 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e </dd></dl> <dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.BotBase.register_command_error_manager"> +<span class="sig-name descname"><span class="pre">register_command_error_manager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manager</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L124-L133"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.register_command_error_manager" title="Link to this definition">#</a></dt> +<dd><p>Bind an instance of the command error manager to both the bot and the command tree.</p> +<p>The reason this doesn’t happen in the constructor is because error handlers might need an instance of the bot. +So registration needs to happen once the bot instance has been created.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.remove_command"> -<span class="sig-name descname"><span class="pre">remove_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L191-L205"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.remove_command" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">remove_command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L222-L236"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.remove_command" title="Link to this definition">#</a></dt> <dd><p>Remove a command/alias as normal and then remove its root aliases from the bot.</p> <p>Individual root aliases cannot be removed by this function. To remove them, either remove the entire command or manually edit <cite>bot.all_commands</cite>.</p> @@ -606,7 +630,7 @@ To remove them, either remove the entire command or manually edit <cite>bot.all_ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.setup_hook"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_hook</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L256-L291"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.setup_hook" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setup_hook</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L287-L322"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.setup_hook" title="Link to this definition">#</a></dt> <dd><p>An async init to startup generic services.</p> <p>Connects to statsd, and calls <a class="reference internal" href="pydis_core.async_stats.html#pydis_core.async_stats.AsyncStatsClient.create_socket" title="pydis_core.async_stats.AsyncStatsClient.create_socket"><code class="xref py py-func docutils literal notranslate"><span class="pre">AsyncStatsClient.create_socket</span></code></a> @@ -620,7 +644,7 @@ and <a class="reference internal" href="#pydis_core.BotBase.ping_services" title <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.BotBase.wait_until_guild_available"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait_until_guild_available</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L237-L245"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.wait_until_guild_available" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait_until_guild_available</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L268-L276"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.BotBase.wait_until_guild_available" title="Link to this definition">#</a></dt> <dd><p>Wait until the guild that matches the <code class="docutils literal notranslate"><span class="pre">guild_id</span></code> given at init is available (and the cache is ready).</p> <p>The on_ready event is inadequate because it only waits 2 seconds for a GUILD_CREATE gateway event before giving up and thus not populating the cache for unavailable guilds.</p> @@ -635,14 +659,14 @@ gateway event before giving up and thus not populating the cache for unavailable <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.EmptyPaginatorEmbedError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.EmptyPaginatorEmbedError" 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">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.EmptyPaginatorEmbedError" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when attempting to paginate with empty contents.</p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.LinePaginator"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator" 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.Paginator" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Paginator</span></code></a></p> <p>A class that aids in paginating code blocks for Discord messages.</p> <dl class="field-list simple"> @@ -659,14 +683,14 @@ gateway event before giving up and thus not populating the cache for unavailable </dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.LinePaginator.__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">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.__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">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.__init__" title="Link to this definition">#</a></dt> <dd><p>This function overrides the Paginator.__init__ from inside discord.ext.commands.</p> <p>It overrides in order to allow us to configure the maximum number of lines per page.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.LinePaginator.add_line"> -<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</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">empty</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.add_line" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</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">empty</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.add_line" title="Link to this definition">#</a></dt> <dd><p>Adds a line to the current page.</p> <p>If a line on a page exceeds <cite>max_size</cite> characters, then <cite>max_size</cite> will go up to <cite>scale_to_size</cite> for a single line before creating a new page for the overflow words. If it @@ -694,7 +718,7 @@ page at a reasonable size.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.LinePaginator.paginate"> -<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</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">prefix</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">suffix</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">max_lines</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restrict_to_user</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</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">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="n"><span class="pre">exception_on_empty_embed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.paginate" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</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">prefix</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">suffix</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">max_lines</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restrict_to_user</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</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">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="n"><span class="pre">exception_on_empty_embed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.LinePaginator.paginate" title="Link to this definition">#</a></dt> <dd><p>Use a paginator and set of reactions to provide pagination over a set of lines.</p> <p>The reactions are used to switch page, or to finish with pagination.</p> <p>When used, this will send a message using <cite>ctx.send()</cite> and apply a set of reactions to it. These reactions may @@ -738,7 +762,7 @@ to any user with a moderation role.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.PaginationEmojis"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PaginationEmojis</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.PaginationEmojis" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PaginationEmojis</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.PaginationEmojis" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel" title="(in Pydantic v0.0.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></a></p> <p>The emojis that will be used for pagination.</p> <dl class="py attribute"> @@ -765,12 +789,12 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</ <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.StartupError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">StartupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L27-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError" 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">StartupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L29-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Exception class for startup errors.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.StartupError.__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">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/_bot.py#L30-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError.__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">base</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/_bot.py#L32-L35"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.StartupError.__init__" title="Link to this definition">#</a></dt> <dd></dd></dl> </dd></dl> @@ -783,6 +807,14 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</ <li class="toctree-l1"><a class="reference internal" href="pydis_core.utils.html">Utils</a><ul> <li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.html#pydis_core.utils.apply_monkey_patches"><code class="docutils literal notranslate"><span class="pre">apply_monkey_patches()</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.html#pydis_core.utils.unqualify"><code class="docutils literal notranslate"><span class="pre">unqualify()</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.html#subpackages">Subpackages</a><ul> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><ul> +<li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.error_handling.html#pydis_core.utils.error_handling.handle_forbidden_from_block"><code class="docutils literal notranslate"><span class="pre">handle_forbidden_from_block()</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.error_handling.html#subpackages">Subpackages</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.html#submodules">Submodules</a><ul> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a><ul> <li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.caching.html#pydis_core.utils.caching.AsyncCache"><code class="docutils literal notranslate"><span class="pre">AsyncCache</span></code></a></li> @@ -813,10 +845,6 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</ <li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.cooldown.html#pydis_core.utils.cooldown.block_duplicate_invocations"><code class="docutils literal notranslate"><span class="pre">block_duplicate_invocations()</span></code></a></li> </ul> </li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a><ul> -<li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.error_handling.html#pydis_core.utils.error_handling.handle_forbidden_from_block"><code class="docutils literal notranslate"><span class="pre">handle_forbidden_from_block()</span></code></a></li> -</ul> -</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a><ul> <li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.function.html#pydis_core.utils.function.GlobalNameConflictError"><code class="docutils literal notranslate"><span class="pre">GlobalNameConflictError</span></code></a></li> <li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.function.html#pydis_core.utils.function.command_wraps"><code class="docutils literal notranslate"><span class="pre">command_wraps()</span></code></a></li> @@ -1000,6 +1028,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</ <li><a class="reference internal" href="#pydis_core.BotBase.on_guild_unavailable"><code class="docutils literal notranslate"><span class="pre">BotBase.on_guild_unavailable()</span></code></a></li> <li><a class="reference internal" href="#pydis_core.BotBase.ping_services"><code class="docutils literal notranslate"><span class="pre">BotBase.ping_services()</span></code></a></li> <li><a class="reference internal" href="#pydis_core.BotBase.process_commands"><code class="docutils literal notranslate"><span class="pre">BotBase.process_commands()</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.BotBase.register_command_error_manager"><code class="docutils literal notranslate"><span class="pre">BotBase.register_command_error_manager()</span></code></a></li> <li><a class="reference internal" href="#pydis_core.BotBase.remove_command"><code class="docutils literal notranslate"><span class="pre">BotBase.remove_command()</span></code></a></li> <li><a class="reference internal" href="#pydis_core.BotBase.setup_hook"><code class="docutils literal notranslate"><span class="pre">BotBase.setup_hook()</span></code></a></li> <li><a class="reference internal" href="#pydis_core.BotBase.wait_until_guild_available"><code class="docutils literal notranslate"><span class="pre">BotBase.wait_until_guild_available()</span></code></a></li> @@ -1035,7 +1064,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.site_api.html b/main/output/pydis_core.site_api.html index 55ebc2e3..fc788d90 100644 --- a/main/output/pydis_core.site_api.html +++ b/main/output/pydis_core.site_api.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Local Development & Testing" href="../development.html" /><link rel="prev" title="async_stats" href="pydis_core.async_stats.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>site_api - Pydis Core Latest (10.7.0)</title> + <title>site_api - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.site_api.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.site_api.html">v10.7.0</a> </li> @@ -375,12 +386,12 @@ <p>An API wrapper around the Site API.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.site_api.APIClient"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L41-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">APIClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L41-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>A wrapper for the Django Site API.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.site_api.APIClient.__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">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L47-L70"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.__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">site_api_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">site_api_token</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">session_kwargs</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L47-L70"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.__init__" title="Link to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#pydis_core.site_api.APIClient" title="pydis_core.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">APIClient</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -395,7 +406,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.site_api.APIClient.close"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L74-L77"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.close" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">close</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L74-L77"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.close" title="Link to this definition">#</a></dt> <dd><p>Close the aiohttp session.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -406,7 +417,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.site_api.APIClient.delete"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L139-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.delete" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L139-L142"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.delete" title="Link to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#pydis_core.site_api.APIClient.request" title="pydis_core.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with DELETE passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -417,7 +428,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.site_api.APIClient.get"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L123-L126"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.get" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L123-L126"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.get" title="Link to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#pydis_core.site_api.APIClient.request" title="pydis_core.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with GET passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -428,7 +439,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.site_api.APIClient.maybe_raise_for_status"> -<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maybe_raise_for_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</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">should_raise</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L78-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.maybe_raise_for_status" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">maybe_raise_for_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</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">should_raise</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L78-L98"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.maybe_raise_for_status" title="Link to this definition">#</a></dt> <dd><p>Raise <a class="reference internal" href="#pydis_core.site_api.ResponseCodeError" title="pydis_core.site_api.ResponseCodeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a> for non-OK response if an exception should be raised.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -448,7 +459,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.site_api.APIClient.patch"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">patch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L127-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.patch" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">patch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L127-L130"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.patch" title="Link to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#pydis_core.site_api.APIClient.request" title="pydis_core.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PATCH passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -459,7 +470,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.site_api.APIClient.post"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L131-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.post" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">post</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L131-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.post" title="Link to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#pydis_core.site_api.APIClient.request" title="pydis_core.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with POST passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -470,7 +481,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.site_api.APIClient.put"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">put</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L135-L138"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.put" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">put</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L135-L138"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.put" title="Link to this definition">#</a></dt> <dd><p>Equivalent to <a class="reference internal" href="#pydis_core.site_api.APIClient.request" title="pydis_core.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> with PUT passed as the method.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -481,7 +492,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.site_api.APIClient.request"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L99-L122"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.request" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</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">raise_for_status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L99-L122"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.APIClient.request" title="Link to this definition">#</a></dt> <dd><p>Send an HTTP request to the site API and return the JSON response.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -508,12 +519,12 @@ <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.site_api.ResponseCodeError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</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">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L13-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError" 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">ResponseCodeError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</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">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L13-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></a></p> <p>Raised in <a class="reference internal" href="#pydis_core.site_api.APIClient.request" title="pydis_core.site_api.APIClient.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">APIClient.request()</span></code></a> when a non-OK HTTP response is received.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.site_api.ResponseCodeError.__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">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</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">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L16-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError.__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">response</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response_json</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">response_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L16-L34"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError.__init__" title="Link to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#pydis_core.site_api.ResponseCodeError" title="pydis_core.site_api.ResponseCodeError"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ResponseCodeError</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -528,7 +539,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.site_api.ResponseCodeError.__str__"> -<span class="sig-name descname"><span class="pre">__str__</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/site_api.py#L35-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError.__str__" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__str__</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/site_api.py#L35-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.site_api.ResponseCodeError.__str__" title="Link to this definition">#</a></dt> <dd><p>Return a string representation of the error.</p> </dd></dl> @@ -620,7 +631,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.caching.html b/main/output/pydis_core.utils.caching.html index 4de67acf..c0fad19c 100644 --- a/main/output/pydis_core.utils.caching.html +++ b/main/output/pydis_core.utils.caching.html @@ -3,10 +3,10 @@ <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> <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="channel" href="pydis_core.utils.channel.html" /><link rel="prev" title="Utils" href="pydis_core.utils.html" /> +<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="channel" href="pydis_core.utils.channel.html" /><link rel="prev" title="manager" href="pydis_core.utils.error_handling.commands.manager.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>caching - Pydis Core Latest (10.7.0)</title> + <title>caching - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.caching.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.caching.html">v10.7.0</a> </li> @@ -375,14 +386,14 @@ <p>Utilities related to custom caches.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.caching.AsyncCache"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AsyncCache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/caching.py#L8-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>LRU cache implementation for coroutines.</p> <p>Once the cache exceeds the maximum size, keys are deleted in FIFO order.</p> <p>An offset may be optionally provided to be applied to the coroutine’s arguments when creating the cache key.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.caching.AsyncCache.__call__"> -<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__call__" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg_offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/caching.py#L27-L62"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__call__" title="Link to this definition">#</a></dt> <dd><p>Decorator for async cache.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -399,7 +410,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.caching.AsyncCache.__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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">128</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/caching.py#L17-L26"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.__init__" title="Link to this definition">#</a></dt> <dd><p>Initialise a new <a class="reference internal" href="#pydis_core.utils.caching.AsyncCache" title="pydis_core.utils.caching.AsyncCache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AsyncCache</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -410,7 +421,7 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.caching.AsyncCache.clear"> -<span class="sig-name descname"><span class="pre">clear</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.clear" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">clear</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/caching.py#L63-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.caching.AsyncCache.clear" title="Link to this definition">#</a></dt> <dd><p>Clear cache instance.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -437,14 +448,14 @@ </div> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> </a> - <a class="prev-page" href="pydis_core.utils.html"> + <a class="prev-page" href="pydis_core.utils.error_handling.commands.manager.html"> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> <div class="page-info"> <div class="context"> <span>Previous</span> </div> - <div class="title">Utils</div> + <div class="title">manager</div> </div> </a> @@ -496,7 +507,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.channel.html b/main/output/pydis_core.utils.channel.html index 33282e2c..3115d5c4 100644 --- a/main/output/pydis_core.utils.channel.html +++ b/main/output/pydis_core.utils.channel.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="checks" href="pydis_core.utils.checks.html" /><link rel="prev" title="caching" href="pydis_core.utils.caching.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>channel - Pydis Core Latest (10.7.0)</title> + <title>channel - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.channel.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.channel.html">v10.7.0</a> </li> @@ -375,7 +386,7 @@ <p>Useful helper functions for interacting with various discord channel objects.</p> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.channel.get_or_fetch_channel"> -<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_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/channel.py#L25-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.get_or_fetch_channel" 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">get_or_fetch_channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bot</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/channel.py#L25-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.get_or_fetch_channel" title="Link to this definition">#</a></dt> <dd><p>Attempt to get or fetch the given <code class="docutils literal notranslate"><span class="pre">channel_id</span></code> from the bots cache, and return it.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -403,7 +414,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.channel.is_in_category"> -<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.is_in_category" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">is_in_category</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/channel.py#L11-L23"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.channel.is_in_category" title="Link to this definition">#</a></dt> <dd><p>Return whether the given <code class="docutils literal notranslate"><span class="pre">channel</span></code> in the the category with the id <code class="docutils literal notranslate"><span class="pre">category_id</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -492,7 +503,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.checks.html b/main/output/pydis_core.utils.checks.html index fa0cec5f..355b9cdf 100644 --- a/main/output/pydis_core.utils.checks.html +++ b/main/output/pydis_core.utils.checks.html @@ -6,7 +6,7 @@ <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 7.2.6 and Furo 2024.01.29 --> - <title>checks - Pydis Core Latest (10.7.0)</title> + <title>checks - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.checks.html">v11.0.0</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> @@ -374,26 +385,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/9a497193db7cca2d64cd99251f34b83bec2d9137/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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/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/9a497193db7cca2d64cd99251f34b83bec2d9137/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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/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/9a497193db7cca2d64cd99251f34b83bec2d9137/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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/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/9a497193db7cca2d64cd99251f34b83bec2d9137/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> +<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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/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"> @@ -419,7 +430,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/9a497193db7cca2d64cd99251f34b83bec2d9137/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> +<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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/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"> @@ -440,7 +451,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/9a497193db7cca2d64cd99251f34b83bec2d9137/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> +<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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/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"> @@ -461,7 +472,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="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/9a497193db7cca2d64cd99251f34b83bec2d9137/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> +<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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/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> @@ -564,7 +575,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.commands.html b/main/output/pydis_core.utils.commands.html index bff8aa66..807f62ff 100644 --- a/main/output/pydis_core.utils.commands.html +++ b/main/output/pydis_core.utils.commands.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="cooldown" href="pydis_core.utils.cooldown.html" /><link rel="prev" title="checks" href="pydis_core.utils.checks.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>commands - Pydis Core Latest (10.7.0)</title> + <title>commands - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.commands.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.commands.html">v10.7.0</a> </li> @@ -374,7 +385,7 @@ <span id="commands"></span><h1>commands<a class="headerlink" href="#module-pydis_core.utils.commands" title="Link to this heading">#</a></h1> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.commands.clean_text_or_reply"> -<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">clean_text_or_reply</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">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/commands.py#L6-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.commands.clean_text_or_reply" 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">clean_text_or_reply</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">text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/commands.py#L6-L38"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.commands.clean_text_or_reply" title="Link to this definition">#</a></dt> <dd><p>Cleans a text argument or replied message’s content.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -465,7 +476,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.cooldown.html b/main/output/pydis_core.utils.cooldown.html index 8487516a..7bfc145c 100644 --- a/main/output/pydis_core.utils.cooldown.html +++ b/main/output/pydis_core.utils.cooldown.html @@ -3,10 +3,10 @@ <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> <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="error_handling" href="pydis_core.utils.error_handling.html" /><link rel="prev" title="commands" href="pydis_core.utils.commands.html" /> +<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="function" href="pydis_core.utils.function.html" /><link rel="prev" title="commands" href="pydis_core.utils.commands.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>cooldown - Pydis Core Latest (10.7.0)</title> + <title>cooldown - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.cooldown.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.cooldown.html">v10.7.0</a> </li> @@ -375,17 +386,17 @@ <p>Helpers for setting a cooldown on commands.</p> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.cooldown.CommandOnCooldown"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CommandOnCooldown</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <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="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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/cooldown.py#L36-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown" 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">CommandOnCooldown</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <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="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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/cooldown.py#L36-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown" 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.CommandError" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">CommandError</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Generic" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Generic</span></code></a>[<a class="reference internal" href="#pydis_core.utils.cooldown.P" title="pydis_core.utils.cooldown.P"><code class="xref py py-obj docutils literal notranslate"><span class="pre">P</span></code></a>, <a class="reference internal" href="#pydis_core.utils.cooldown.R" title="pydis_core.utils.cooldown.R"><code class="xref py py-obj docutils literal notranslate"><span class="pre">R</span></code></a>]</p> <p>Raised when a command is invoked while on cooldown.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.cooldown.CommandOnCooldown.__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">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <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="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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/cooldown.py#L39-L51"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown.__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">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em>, <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="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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/cooldown.py#L39-L51"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown.__init__" title="Link to this definition">#</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.cooldown.CommandOnCooldown.call_without_cooldown"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">call_without_cooldown</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/cooldown.py#L52-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown.call_without_cooldown" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">call_without_cooldown</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/cooldown.py#L52-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.CommandOnCooldown.call_without_cooldown" title="Link to this definition">#</a></dt> <dd><p>Run the command this cooldown blocked.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -401,20 +412,20 @@ <dl class="py data"> <dt class="sig sig-object py" id="pydis_core.utils.cooldown.P"> -<span class="sig-name descname"><span class="pre">P</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">~P</span></em><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/cooldown.py#L30"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.P" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">P</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">~P</span></em><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/cooldown.py#L30"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.P" title="Link to this definition">#</a></dt> <dd><p>The command’s signature.</p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.cooldown.R"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">R</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/cooldown.py#L32"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.R" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">R</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/cooldown.py#L32"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.R" title="Link to this definition">#</a></dt> <dd><p>The command’s return value.</p> <p>alias of TypeVar(‘R’)</p> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.cooldown.block_duplicate_invocations"> -<span class="sig-name descname"><span class="pre">block_duplicate_invocations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cooldown_duration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">send_notice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args_preprocessor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/cooldown.py#L174-L220"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.block_duplicate_invocations" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">block_duplicate_invocations</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cooldown_duration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">send_notice</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args_preprocessor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/cooldown.py#L174-L220"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.cooldown.block_duplicate_invocations" title="Link to this definition">#</a></dt> <dd><p>Prevent duplicate invocations of a command with the same arguments in a channel for <code class="docutils literal notranslate"><span class="pre">cooldown_duration</span></code> seconds.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -445,12 +456,12 @@ its return value is then used to check for the cooldown instead of the raw argum <footer> <div class="related-pages"> - <a class="next-page" href="pydis_core.utils.error_handling.html"> + <a class="next-page" href="pydis_core.utils.function.html"> <div class="page-info"> <div class="context"> <span>Next</span> </div> - <div class="title">error_handling</div> + <div class="title">function</div> </div> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> </a> @@ -515,7 +526,7 @@ its return value is then used to check for the cooldown instead of the raw argum </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.error_handling.commands.abc.html b/main/output/pydis_core.utils.error_handling.commands.abc.html new file mode 100644 index 00000000..4bdbc964 --- /dev/null +++ b/main/output/pydis_core.utils.error_handling.commands.abc.html @@ -0,0 +1,507 @@ +<!doctype html> +<html class="no-js" lang="en" data-content_root="../"> + <head><meta charset="utf-8"/> + <meta name="viewport" content="width=device-width,initial-scale=1"/> + <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="manager" href="pydis_core.utils.error_handling.commands.manager.html" /><link rel="prev" title="commands package" href="pydis_core.utils.error_handling.commands.html" /> + + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> + <title>abc - Pydis Core Latest (11.0.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=135e06be" /> + <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + + + + +<style> + body { + --color-code-background: #f8f8f8; + --color-code-foreground: black; + --color-api-name: var(--color-link); + + } + @media not print { + body[data-theme="dark"] { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + @media (prefers-color-scheme: dark) { + body:not([data-theme="light"]) { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + } + } +</style></head> + <body> + + <script> + document.body.dataset.theme = localStorage.getItem("theme") || "auto"; + </script> + + +<svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> + <symbol id="svg-toc" viewBox="0 0 24 24"> + <title>Contents</title> + <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> + <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> + </svg> + </symbol> + <symbol id="svg-menu" viewBox="0 0 24 24"> + <title>Menu</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> + <line x1="3" y1="12" x2="21" y2="12"></line> + <line x1="3" y1="6" x2="21" y2="6"></line> + <line x1="3" y1="18" x2="21" y2="18"></line> + </svg> + </symbol> + <symbol id="svg-arrow-right" viewBox="0 0 24 24"> + <title>Expand</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> + <polyline points="9 18 15 12 9 6"></polyline> + </svg> + </symbol> + <symbol id="svg-sun" viewBox="0 0 24 24"> + <title>Light mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> + <circle cx="12" cy="12" r="5"></circle> + <line x1="12" y1="1" x2="12" y2="3"></line> + <line x1="12" y1="21" x2="12" y2="23"></line> + <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> + <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> + <line x1="1" y1="12" x2="3" y2="12"></line> + <line x1="21" y1="12" x2="23" y2="12"></line> + <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> + <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> + </svg> + </symbol> + <symbol id="svg-moon" viewBox="0 0 24 24"> + <title>Dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> + <path stroke="none" d="M0 0h24v24H0z" fill="none" /> + <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> + </svg> + </symbol> + <symbol id="svg-sun-half" viewBox="0 0 24 24"> + <title>Auto light/dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> + <path stroke="none" d="M0 0h24v24H0z" fill="none"/> + <circle cx="12" cy="12" r="9" /> + <path d="M13 12h5" /> + <path d="M13 15h4" /> + <path d="M13 18h1" /> + <path d="M13 9h4" /> + <path d="M13 6h1" /> + </svg> + </symbol> +</svg> + +<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> +<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> +<label class="overlay sidebar-overlay" for="__navigation"> + <div class="visually-hidden">Hide navigation sidebar</div> +</label> +<label class="overlay toc-overlay" for="__toc"> + <div class="visually-hidden">Hide table of contents sidebar</div> +</label> + + + +<div class="page"> + <header class="mobile-header"> + <div class="header-left"> + <label class="nav-overlay-icon" for="__navigation"> + <div class="visually-hidden">Toggle site navigation sidebar</div> + <i class="icon"><svg><use href="#svg-menu"></use></svg></i> + </label> + </div> + <div class="header-center"> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> + </div> + <div class="header-right"> + <div class="theme-toggle-container theme-toggle-header"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-header-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + </header> + <aside class="sidebar-drawer"> + <div class="sidebar-container"> + + <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html"> + + <div class="sidebar-logo-container"> + <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> + </div> + + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> + +</a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> + <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> + <input type="hidden" name="check_keywords" value="yes"> + <input type="hidden" name="area" value="default"> +</form> +<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> + <p class="caption" role="heading"><span class="caption-text">Modules:</span></p> +<ul class="current"> +<li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> +<li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 current has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l4 current has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l5 current current-page"><a class="current reference internal" href="#">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.logging.html">logging</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.members.html">members</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.messages.html">messages</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html">pagination</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html">paste_service</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.regex.html">regex</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.scheduling.html">scheduling</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.async_stats.html">async_stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.site_api.html">site_api</a></li> +</ul> +</li> +</ul> +<p class="caption" role="heading"><span class="caption-text">Other:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Local Development & Testing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li> +</ul> + + + + + <ul> + <li class="toctree-l1 has-children "> + + <a class="reference internal" href="../versions.html">Versions</a> + <input class="toctree-checkbox" id="toctree-checkbox-versions" name="toctree-checkbox-versions" role="switch" type="checkbox"> + <label for="toctree-checkbox-versions"> + <div class="visually-hidden">Toggle child pages in navigation</div> + <i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i> + </label> + + + <ul> + + <li class="toctree-l2 current-page"> + <a class="version_link reference internal" href="pydis_core.utils.error_handling.commands.abc.html">main</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.9.2/index.html">v9.9.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.9.1/index.html">v9.9.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.9.0/index.html">v9.9.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.8.0/index.html">v9.8.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.7.0/index.html">v9.7.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.6.0/index.html">v9.6.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.5.1/index.html">v9.5.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.5.0/index.html">v9.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.4.1/index.html">v9.4.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.4.0/index.html">v9.4.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.3.0/index.html">v9.3.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.2.0/index.html">v9.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.10.0-alpha.2/index.html">v9.10.0-alpha.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.10.0-alpha.1/index.html">v9.10.0-alpha.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.1.1/index.html">v9.1.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.0.0/index.html">v9.0.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.error_handling.commands.abc.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.7.0/index.html">v10.7.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.6.0/index.html">v10.6.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.5.1/index.html">v10.5.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.5.0/index.html">v10.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.4.0/index.html">v10.4.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.3.0/index.html">v10.3.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.2.0/index.html">v10.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.1.0/index.html">v10.1.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.0.0/index.html">v10.0.0</a> + </li> + + + <script> + // Make sure we keep any hyperlinked resources when switching version + function updateHash() { + for (let tag of document.getElementsByClassName("version_link")) { + // Extract the original URL + let destination = tag.getAttribute("href"); + if (destination.indexOf("#") !== -1) { + destination = destination.slice(0, destination.indexOf("#")); + } + + // Update the url with the current hash + tag.setAttribute("href", destination + document.location.hash); + } + } + + updateHash(); + addEventListener("hashchange", _ => { updateHash() }); + </script> + </ul> + </li> + </ul> + +</div> +</div> + + </div> + + </div> + </aside> + <div class="main"> + <div class="content"> + <div class="article-container"> + <a href="#" class="back-to-top muted-link"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> + <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> + </svg> + <span>Back to top</span> + </a> + <div class="content-icon-container"> + +<div class="theme-toggle-container theme-toggle-content"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-content-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + <article role="main"> + <section id="module-pydis_core.utils.error_handling.commands.abc"> +<span id="abc"></span><h1>abc<a class="headerlink" href="#module-pydis_core.utils.error_handling.commands.abc" title="Link to this heading">#</a></h1> +<dl class="py class"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AbstractCommandErrorHandler</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/abc.py#L8-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler" title="Link to this definition">#</a></dt> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></a></p> +<p>An abstract command error handler.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_app_command_error"> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_app_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/abc.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_app_command_error" title="Link to this definition">#</a></dt> +<dd><p>Handle error raised in the context of app commands.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.NoReturn" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">NoReturn</span></code></a></span></p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_text_command_error"> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_text_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/abc.py#L21-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_text_command_error" title="Link to this definition">#</a></dt> +<dd><p>Handle error raised in the context of text commands.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.NoReturn" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">NoReturn</span></code></a></span></p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.should_handle_error"> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">should_handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/abc.py#L11-L15"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.should_handle_error" title="Link to this definition">#</a></dt> +<dd><p>A predicate that determines whether the error should be handled.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> +</dd> +</dl> +</dd></dl> + +</dd></dl> + +</section> + + </article> + </div> + <footer> + + <div class="related-pages"> + <a class="next-page" href="pydis_core.utils.error_handling.commands.manager.html"> + <div class="page-info"> + <div class="context"> + <span>Next</span> + </div> + <div class="title">manager</div> + </div> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + </a> + <a class="prev-page" href="pydis_core.utils.error_handling.commands.html"> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + <div class="page-info"> + <div class="context"> + <span>Previous</span> + </div> + + <div class="title">commands package</div> + + </div> + </a> + </div> + <div class="bottom-of-page"> + <div class="left-details"> + <div class="copyright"> + Copyright © 2021, Python Discord + </div> + Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s + + <a href="https://github.com/pradyunsg/furo">Furo</a> + + </div> + <div class="right-details"> + + </div> + </div> + + </footer> + </div> + <aside class="toc-drawer"> + + + <div class="toc-sticky toc-scroll"> + <div class="toc-title-container"> + <span class="toc-title"> + On this page + </span> + </div> + <div class="toc-tree-container"> + <div class="toc-tree"> + <ul> +<li><a class="reference internal" href="#">abc</a><ul> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler</span></code></a><ul> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_app_command_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.handle_app_command_error()</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_text_command_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.handle_text_command_error()</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.should_handle_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.should_handle_error()</span></code></a></li> +</ul> +</li> +</ul> +</li> +</ul> + + </div> + </div> + </div> + + + </aside> + </div> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> + <script src="../_static/doctools.js?v=888ff710"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/scripts/furo.js?v=32e29ea5"></script> + <script src="../_static/changelog.js?v=11ff7913"></script> + </body> +</html>
\ No newline at end of file diff --git a/main/output/pydis_core.utils.error_handling.commands.html b/main/output/pydis_core.utils.error_handling.commands.html new file mode 100644 index 00000000..2572ecf9 --- /dev/null +++ b/main/output/pydis_core.utils.error_handling.commands.html @@ -0,0 +1,575 @@ +<!doctype html> +<html class="no-js" lang="en" data-content_root="../"> + <head><meta charset="utf-8"/> + <meta name="viewport" content="width=device-width,initial-scale=1"/> + <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="abc" href="pydis_core.utils.error_handling.commands.abc.html" /><link rel="prev" title="error_handling package" href="pydis_core.utils.error_handling.html" /> + + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> + <title>commands package - Pydis Core Latest (11.0.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=135e06be" /> + <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + + + + +<style> + body { + --color-code-background: #f8f8f8; + --color-code-foreground: black; + --color-api-name: var(--color-link); + + } + @media not print { + body[data-theme="dark"] { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + @media (prefers-color-scheme: dark) { + body:not([data-theme="light"]) { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + } + } +</style></head> + <body> + + <script> + document.body.dataset.theme = localStorage.getItem("theme") || "auto"; + </script> + + +<svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> + <symbol id="svg-toc" viewBox="0 0 24 24"> + <title>Contents</title> + <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> + <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> + </svg> + </symbol> + <symbol id="svg-menu" viewBox="0 0 24 24"> + <title>Menu</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> + <line x1="3" y1="12" x2="21" y2="12"></line> + <line x1="3" y1="6" x2="21" y2="6"></line> + <line x1="3" y1="18" x2="21" y2="18"></line> + </svg> + </symbol> + <symbol id="svg-arrow-right" viewBox="0 0 24 24"> + <title>Expand</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> + <polyline points="9 18 15 12 9 6"></polyline> + </svg> + </symbol> + <symbol id="svg-sun" viewBox="0 0 24 24"> + <title>Light mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> + <circle cx="12" cy="12" r="5"></circle> + <line x1="12" y1="1" x2="12" y2="3"></line> + <line x1="12" y1="21" x2="12" y2="23"></line> + <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> + <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> + <line x1="1" y1="12" x2="3" y2="12"></line> + <line x1="21" y1="12" x2="23" y2="12"></line> + <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> + <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> + </svg> + </symbol> + <symbol id="svg-moon" viewBox="0 0 24 24"> + <title>Dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> + <path stroke="none" d="M0 0h24v24H0z" fill="none" /> + <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> + </svg> + </symbol> + <symbol id="svg-sun-half" viewBox="0 0 24 24"> + <title>Auto light/dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> + <path stroke="none" d="M0 0h24v24H0z" fill="none"/> + <circle cx="12" cy="12" r="9" /> + <path d="M13 12h5" /> + <path d="M13 15h4" /> + <path d="M13 18h1" /> + <path d="M13 9h4" /> + <path d="M13 6h1" /> + </svg> + </symbol> +</svg> + +<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> +<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> +<label class="overlay sidebar-overlay" for="__navigation"> + <div class="visually-hidden">Hide navigation sidebar</div> +</label> +<label class="overlay toc-overlay" for="__toc"> + <div class="visually-hidden">Hide table of contents sidebar</div> +</label> + + + +<div class="page"> + <header class="mobile-header"> + <div class="header-left"> + <label class="nav-overlay-icon" for="__navigation"> + <div class="visually-hidden">Toggle site navigation sidebar</div> + <i class="icon"><svg><use href="#svg-menu"></use></svg></i> + </label> + </div> + <div class="header-center"> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> + </div> + <div class="header-right"> + <div class="theme-toggle-container theme-toggle-header"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-header-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + </header> + <aside class="sidebar-drawer"> + <div class="sidebar-container"> + + <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html"> + + <div class="sidebar-logo-container"> + <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> + </div> + + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> + +</a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> + <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> + <input type="hidden" name="check_keywords" value="yes"> + <input type="hidden" name="area" value="default"> +</form> +<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> + <p class="caption" role="heading"><span class="caption-text">Modules:</span></p> +<ul class="current"> +<li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> +<li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 current has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l4 current has-children current-page"><a class="current reference internal" href="#">commands package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.logging.html">logging</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.members.html">members</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.messages.html">messages</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html">pagination</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html">paste_service</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.regex.html">regex</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.scheduling.html">scheduling</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.async_stats.html">async_stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.site_api.html">site_api</a></li> +</ul> +</li> +</ul> +<p class="caption" role="heading"><span class="caption-text">Other:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Local Development & Testing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li> +</ul> + + + + + <ul> + <li class="toctree-l1 has-children "> + + <a class="reference internal" href="../versions.html">Versions</a> + <input class="toctree-checkbox" id="toctree-checkbox-versions" name="toctree-checkbox-versions" role="switch" type="checkbox"> + <label for="toctree-checkbox-versions"> + <div class="visually-hidden">Toggle child pages in navigation</div> + <i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i> + </label> + + + <ul> + + <li class="toctree-l2 current-page"> + <a class="version_link reference internal" href="pydis_core.utils.error_handling.commands.html">main</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.9.2/index.html">v9.9.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.9.1/index.html">v9.9.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.9.0/index.html">v9.9.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.8.0/index.html">v9.8.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.7.0/index.html">v9.7.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.6.0/index.html">v9.6.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.5.1/index.html">v9.5.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.5.0/index.html">v9.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.4.1/index.html">v9.4.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.4.0/index.html">v9.4.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.3.0/index.html">v9.3.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.2.0/index.html">v9.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.10.0-alpha.2/index.html">v9.10.0-alpha.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.10.0-alpha.1/index.html">v9.10.0-alpha.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.1.1/index.html">v9.1.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.0.0/index.html">v9.0.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.error_handling.commands.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.7.0/index.html">v10.7.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.6.0/index.html">v10.6.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.5.1/index.html">v10.5.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.5.0/index.html">v10.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.4.0/index.html">v10.4.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.3.0/index.html">v10.3.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.2.0/index.html">v10.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.1.0/index.html">v10.1.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.0.0/index.html">v10.0.0</a> + </li> + + + <script> + // Make sure we keep any hyperlinked resources when switching version + function updateHash() { + for (let tag of document.getElementsByClassName("version_link")) { + // Extract the original URL + let destination = tag.getAttribute("href"); + if (destination.indexOf("#") !== -1) { + destination = destination.slice(0, destination.indexOf("#")); + } + + // Update the url with the current hash + tag.setAttribute("href", destination + document.location.hash); + } + } + + updateHash(); + addEventListener("hashchange", _ => { updateHash() }); + </script> + </ul> + </li> + </ul> + +</div> +</div> + + </div> + + </div> + </aside> + <div class="main"> + <div class="content"> + <div class="article-container"> + <a href="#" class="back-to-top muted-link"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> + <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> + </svg> + <span>Back to top</span> + </a> + <div class="content-icon-container"> + +<div class="theme-toggle-container theme-toggle-content"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-content-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + <article role="main"> + <section id="module-pydis_core.utils.error_handling.commands"> +<span id="commands-package"></span><h1>commands package<a class="headerlink" href="#module-pydis_core.utils.error_handling.commands" title="Link to this heading">#</a></h1> +<dl class="py class"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AbstractCommandErrorHandler</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/abc.py#L8-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler" title="Link to this definition">#</a></dt> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/abc.html#abc.ABC" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></a></p> +<p>An abstract command error handler.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_app_command_error"> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_app_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/abc.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_app_command_error" title="Link to this definition">#</a></dt> +<dd><p>Handle error raised in the context of app commands.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.NoReturn" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">NoReturn</span></code></a></span></p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_text_command_error"> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_text_command_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/abc.py#L21-L25"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_text_command_error" title="Link to this definition">#</a></dt> +<dd><p>Handle error raised in the context of text commands.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.NoReturn" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">NoReturn</span></code></a></span></p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.should_handle_error"> +<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">should_handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/abc.py#L11-L15"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.should_handle_error" title="Link to this definition">#</a></dt> +<dd><p>A predicate that determines whether the error should be handled.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> +</dd> +</dl> +</dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.CommandErrorManager"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CommandErrorManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/manager.py#L13-L59"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager" title="Link to this definition">#</a></dt> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> +<p>A class that registers error handlers and handles all command related errors.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.CommandErrorManager.__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">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/manager.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.__init__" title="Link to this definition">#</a></dt> +<dd></dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.CommandErrorManager.handle_error"> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context_or_interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/manager.py#L21-L37"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.handle_error" title="Link to this definition">#</a></dt> +<dd><p>Handle a Discord exception.</p> +<p>Iterate through available handlers by registration order, and choose the first one capable of handling +the error as determined by <cite>should_handle_error</cite>; there is no priority system.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.CommandErrorManager.register_handler"> +<span class="sig-name descname"><span class="pre">register_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/manager.py#L38-L47"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.register_handler" title="Link to this definition">#</a></dt> +<dd><p>Register a command error handler.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> +</dd> +</dl> +</dd></dl> + +</dd></dl> + +<section id="submodules"> +<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a><ul> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler</span></code></a><ul> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_app_command_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.handle_app_command_error()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.handle_text_command_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.handle_text_command_error()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler.should_handle_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.should_handle_error()</span></code></a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a><ul> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html#pydis_core.utils.error_handling.commands.manager.CommandErrorManager"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager</span></code></a><ul> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.__init__"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.__init__()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.handle_error"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.handle_error()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.register_handler"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.register_handler()</span></code></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</section> +</section> + + </article> + </div> + <footer> + + <div class="related-pages"> + <a class="next-page" href="pydis_core.utils.error_handling.commands.abc.html"> + <div class="page-info"> + <div class="context"> + <span>Next</span> + </div> + <div class="title">abc</div> + </div> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + </a> + <a class="prev-page" href="pydis_core.utils.error_handling.html"> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + <div class="page-info"> + <div class="context"> + <span>Previous</span> + </div> + + <div class="title">error_handling package</div> + + </div> + </a> + </div> + <div class="bottom-of-page"> + <div class="left-details"> + <div class="copyright"> + Copyright © 2021, Python Discord + </div> + Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s + + <a href="https://github.com/pradyunsg/furo">Furo</a> + + </div> + <div class="right-details"> + + </div> + </div> + + </footer> + </div> + <aside class="toc-drawer"> + + + <div class="toc-sticky toc-scroll"> + <div class="toc-title-container"> + <span class="toc-title"> + On this page + </span> + </div> + <div class="toc-tree-container"> + <div class="toc-tree"> + <ul> +<li><a class="reference internal" href="#">commands package</a><ul> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler</span></code></a><ul> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_app_command_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.handle_app_command_error()</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_text_command_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.handle_text_command_error()</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.should_handle_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.should_handle_error()</span></code></a></li> +</ul> +</li> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.CommandErrorManager"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager</span></code></a><ul> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.__init__"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.__init__()</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.handle_error"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.handle_error()</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.CommandErrorManager.register_handler"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.register_handler()</span></code></a></li> +</ul> +</li> +<li><a class="reference internal" href="#submodules">Submodules</a></li> +</ul> +</li> +</ul> + + </div> + </div> + </div> + + + </aside> + </div> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> + <script src="../_static/doctools.js?v=888ff710"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/scripts/furo.js?v=32e29ea5"></script> + <script src="../_static/changelog.js?v=11ff7913"></script> + </body> +</html>
\ No newline at end of file diff --git a/main/output/pydis_core.utils.error_handling.commands.manager.html b/main/output/pydis_core.utils.error_handling.commands.manager.html new file mode 100644 index 00000000..28b88dcf --- /dev/null +++ b/main/output/pydis_core.utils.error_handling.commands.manager.html @@ -0,0 +1,503 @@ +<!doctype html> +<html class="no-js" lang="en" data-content_root="../"> + <head><meta charset="utf-8"/> + <meta name="viewport" content="width=device-width,initial-scale=1"/> + <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="caching" href="pydis_core.utils.caching.html" /><link rel="prev" title="abc" href="pydis_core.utils.error_handling.commands.abc.html" /> + + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> + <title>manager - Pydis Core Latest (11.0.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=135e06be" /> + <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> + <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> + <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + + + + +<style> + body { + --color-code-background: #f8f8f8; + --color-code-foreground: black; + --color-api-name: var(--color-link); + + } + @media not print { + body[data-theme="dark"] { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + @media (prefers-color-scheme: dark) { + body:not([data-theme="light"]) { + --color-code-background: #202020; + --color-code-foreground: #d0d0d0; + + } + } + } +</style></head> + <body> + + <script> + document.body.dataset.theme = localStorage.getItem("theme") || "auto"; + </script> + + +<svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> + <symbol id="svg-toc" viewBox="0 0 24 24"> + <title>Contents</title> + <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> + <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> + </svg> + </symbol> + <symbol id="svg-menu" viewBox="0 0 24 24"> + <title>Menu</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> + <line x1="3" y1="12" x2="21" y2="12"></line> + <line x1="3" y1="6" x2="21" y2="6"></line> + <line x1="3" y1="18" x2="21" y2="18"></line> + </svg> + </symbol> + <symbol id="svg-arrow-right" viewBox="0 0 24 24"> + <title>Expand</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> + <polyline points="9 18 15 12 9 6"></polyline> + </svg> + </symbol> + <symbol id="svg-sun" viewBox="0 0 24 24"> + <title>Light mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> + <circle cx="12" cy="12" r="5"></circle> + <line x1="12" y1="1" x2="12" y2="3"></line> + <line x1="12" y1="21" x2="12" y2="23"></line> + <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> + <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> + <line x1="1" y1="12" x2="3" y2="12"></line> + <line x1="21" y1="12" x2="23" y2="12"></line> + <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> + <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> + </svg> + </symbol> + <symbol id="svg-moon" viewBox="0 0 24 24"> + <title>Dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> + <path stroke="none" d="M0 0h24v24H0z" fill="none" /> + <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> + </svg> + </symbol> + <symbol id="svg-sun-half" viewBox="0 0 24 24"> + <title>Auto light/dark mode</title> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" + stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> + <path stroke="none" d="M0 0h24v24H0z" fill="none"/> + <circle cx="12" cy="12" r="9" /> + <path d="M13 12h5" /> + <path d="M13 15h4" /> + <path d="M13 18h1" /> + <path d="M13 9h4" /> + <path d="M13 6h1" /> + </svg> + </symbol> +</svg> + +<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> +<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> +<label class="overlay sidebar-overlay" for="__navigation"> + <div class="visually-hidden">Hide navigation sidebar</div> +</label> +<label class="overlay toc-overlay" for="__toc"> + <div class="visually-hidden">Hide table of contents sidebar</div> +</label> + + + +<div class="page"> + <header class="mobile-header"> + <div class="header-left"> + <label class="nav-overlay-icon" for="__navigation"> + <div class="visually-hidden">Toggle site navigation sidebar</div> + <i class="icon"><svg><use href="#svg-menu"></use></svg></i> + </label> + </div> + <div class="header-center"> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> + </div> + <div class="header-right"> + <div class="theme-toggle-container theme-toggle-header"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-header-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + </header> + <aside class="sidebar-drawer"> + <div class="sidebar-container"> + + <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html"> + + <div class="sidebar-logo-container"> + <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> + </div> + + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> + +</a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> + <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> + <input type="hidden" name="check_keywords" value="yes"> + <input type="hidden" name="area" value="default"> +</form> +<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> + <p class="caption" role="heading"><span class="caption-text">Modules:</span></p> +<ul class="current"> +<li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> +<li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 current has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l4 current has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5 current current-page"><a class="current reference internal" href="#">manager</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.logging.html">logging</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.members.html">members</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.messages.html">messages</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html">pagination</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html">paste_service</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.regex.html">regex</a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.scheduling.html">scheduling</a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.async_stats.html">async_stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.site_api.html">site_api</a></li> +</ul> +</li> +</ul> +<p class="caption" role="heading"><span class="caption-text">Other:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development.html">Local Development & Testing</a></li> +<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li> +</ul> + + + + + <ul> + <li class="toctree-l1 has-children "> + + <a class="reference internal" href="../versions.html">Versions</a> + <input class="toctree-checkbox" id="toctree-checkbox-versions" name="toctree-checkbox-versions" role="switch" type="checkbox"> + <label for="toctree-checkbox-versions"> + <div class="visually-hidden">Toggle child pages in navigation</div> + <i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i> + </label> + + + <ul> + + <li class="toctree-l2 current-page"> + <a class="version_link reference internal" href="pydis_core.utils.error_handling.commands.manager.html">main</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.9.2/index.html">v9.9.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.9.1/index.html">v9.9.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.9.0/index.html">v9.9.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.8.0/index.html">v9.8.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.7.0/index.html">v9.7.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.6.0/index.html">v9.6.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.5.1/index.html">v9.5.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.5.0/index.html">v9.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.4.1/index.html">v9.4.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.4.0/index.html">v9.4.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.3.0/index.html">v9.3.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.2.0/index.html">v9.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.10.0-alpha.2/index.html">v9.10.0-alpha.2</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.10.0-alpha.1/index.html">v9.10.0-alpha.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.1.1/index.html">v9.1.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v9.0.0/index.html">v9.0.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.error_handling.commands.manager.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.7.0/index.html">v10.7.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.6.0/index.html">v10.6.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.5.1/index.html">v10.5.1</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.5.0/index.html">v10.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.4.0/index.html">v10.4.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.3.0/index.html">v10.3.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.2.0/index.html">v10.2.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.1.0/index.html">v10.1.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v10.0.0/index.html">v10.0.0</a> + </li> + + + <script> + // Make sure we keep any hyperlinked resources when switching version + function updateHash() { + for (let tag of document.getElementsByClassName("version_link")) { + // Extract the original URL + let destination = tag.getAttribute("href"); + if (destination.indexOf("#") !== -1) { + destination = destination.slice(0, destination.indexOf("#")); + } + + // Update the url with the current hash + tag.setAttribute("href", destination + document.location.hash); + } + } + + updateHash(); + addEventListener("hashchange", _ => { updateHash() }); + </script> + </ul> + </li> + </ul> + +</div> +</div> + + </div> + + </div> + </aside> + <div class="main"> + <div class="content"> + <div class="article-container"> + <a href="#" class="back-to-top muted-link"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> + <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> + </svg> + <span>Back to top</span> + </a> + <div class="content-icon-container"> + +<div class="theme-toggle-container theme-toggle-content"> + <button class="theme-toggle"> + <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> + <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> + <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> + <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> + </button> + </div> + <label class="toc-overlay-icon toc-content-icon" for="__toc"> + <div class="visually-hidden">Toggle table of contents sidebar</div> + <i class="icon"><svg><use href="#svg-toc"></use></svg></i> + </label> + </div> + <article role="main"> + <section id="module-pydis_core.utils.error_handling.commands.manager"> +<span id="manager"></span><h1>manager<a class="headerlink" href="#module-pydis_core.utils.error_handling.commands.manager" title="Link to this heading">#</a></h1> +<dl class="py class"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.manager.CommandErrorManager"> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CommandErrorManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/manager.py#L13-L59"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager" title="Link to this definition">#</a></dt> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> +<p>A class that registers error handlers and handles all command related errors.</p> +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.manager.CommandErrorManager.__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">default</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/manager.py#L16-L20"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.__init__" title="Link to this definition">#</a></dt> +<dd></dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.manager.CommandErrorManager.handle_error"> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">handle_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context_or_interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/manager.py#L21-L37"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.handle_error" title="Link to this definition">#</a></dt> +<dd><p>Handle a Discord exception.</p> +<p>Iterate through available handlers by registration order, and choose the first one capable of handling +the error as determined by <cite>should_handle_error</cite>; there is no priority system.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> +</dd> +</dl> +</dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="pydis_core.utils.error_handling.commands.manager.CommandErrorManager.register_handler"> +<span class="sig-name descname"><span class="pre">register_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">handler</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/commands/manager.py#L38-L47"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.register_handler" title="Link to this definition">#</a></dt> +<dd><p>Register a command error handler.</p> +<dl class="field-list simple"> +<dt class="field-odd">Return type<span class="colon">:</span></dt> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> +</dd> +</dl> +</dd></dl> + +</dd></dl> + +</section> + + </article> + </div> + <footer> + + <div class="related-pages"> + <a class="next-page" href="pydis_core.utils.caching.html"> + <div class="page-info"> + <div class="context"> + <span>Next</span> + </div> + <div class="title">caching</div> + </div> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + </a> + <a class="prev-page" href="pydis_core.utils.error_handling.commands.abc.html"> + <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> + <div class="page-info"> + <div class="context"> + <span>Previous</span> + </div> + + <div class="title">abc</div> + + </div> + </a> + </div> + <div class="bottom-of-page"> + <div class="left-details"> + <div class="copyright"> + Copyright © 2021, Python Discord + </div> + Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s + + <a href="https://github.com/pradyunsg/furo">Furo</a> + + </div> + <div class="right-details"> + + </div> + </div> + + </footer> + </div> + <aside class="toc-drawer"> + + + <div class="toc-sticky toc-scroll"> + <div class="toc-title-container"> + <span class="toc-title"> + On this page + </span> + </div> + <div class="toc-tree-container"> + <div class="toc-tree"> + <ul> +<li><a class="reference internal" href="#">manager</a><ul> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager</span></code></a><ul> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.__init__"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.__init__()</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.handle_error"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.handle_error()</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.error_handling.commands.manager.CommandErrorManager.register_handler"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.register_handler()</span></code></a></li> +</ul> +</li> +</ul> +</li> +</ul> + + </div> + </div> + </div> + + + </aside> + </div> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> + <script src="../_static/doctools.js?v=888ff710"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/scripts/furo.js?v=32e29ea5"></script> + <script src="../_static/changelog.js?v=11ff7913"></script> + </body> +</html>
\ No newline at end of file diff --git a/main/output/pydis_core.utils.error_handling.html b/main/output/pydis_core.utils.error_handling.html index 1d790816..9910dcf3 100644 --- a/main/output/pydis_core.utils.error_handling.html +++ b/main/output/pydis_core.utils.error_handling.html @@ -3,10 +3,10 @@ <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> <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="function" href="pydis_core.utils.function.html" /><link rel="prev" title="cooldown" href="pydis_core.utils.cooldown.html" /> +<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="commands package" href="pydis_core.utils.error_handling.commands.html" /><link rel="prev" title="Utils" href="pydis_core.utils.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>error_handling - Pydis Core Latest (10.7.0)</title> + <title>error_handling package - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 current has-children current-page"><a class="current reference internal" href="#">error_handling package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3 current current-page"><a class="current reference internal" href="#">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.error_handling.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.error_handling.html">v10.7.0</a> </li> @@ -371,10 +382,10 @@ </div> <article role="main"> <section id="module-pydis_core.utils.error_handling"> -<span id="error-handling"></span><h1>error_handling<a class="headerlink" href="#module-pydis_core.utils.error_handling" title="Link to this heading">#</a></h1> +<span id="error-handling-package"></span><h1>error_handling package<a class="headerlink" href="#module-pydis_core.utils.error_handling" title="Link to this heading">#</a></h1> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.error_handling.handle_forbidden_from_block"> -<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_forbidden_from_block</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/error_handling.py#L8-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.handle_forbidden_from_block" 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">handle_forbidden_from_block</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/error_handling/__init__.py#L8-L36"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.error_handling.handle_forbidden_from_block" title="Link to this definition">#</a></dt> <dd><p>Handles <code class="docutils literal notranslate"><span class="pre">discord.Forbidden</span></code> 90001 errors, or re-raises if <code class="docutils literal notranslate"><span class="pre">error</span></code> isn’t a 90001 error.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -389,6 +400,39 @@ </dl> </dd></dl> +<section id="subpackages"> +<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading">#</a></h2> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><ul> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler</span></code></a><ul> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_app_command_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.handle_app_command_error()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.handle_text_command_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.handle_text_command_error()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler.should_handle_error"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler.should_handle_error()</span></code></a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#pydis_core.utils.error_handling.commands.CommandErrorManager"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager</span></code></a><ul> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#pydis_core.utils.error_handling.commands.CommandErrorManager.__init__"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.__init__()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#pydis_core.utils.error_handling.commands.CommandErrorManager.handle_error"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.handle_error()</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#pydis_core.utils.error_handling.commands.CommandErrorManager.register_handler"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager.register_handler()</span></code></a></li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#submodules">Submodules</a><ul> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a><ul> +<li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html#pydis_core.utils.error_handling.commands.abc.AbstractCommandErrorHandler"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler</span></code></a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a><ul> +<li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html#pydis_core.utils.error_handling.commands.manager.CommandErrorManager"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager</span></code></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</section> </section> </article> @@ -396,23 +440,23 @@ <footer> <div class="related-pages"> - <a class="next-page" href="pydis_core.utils.function.html"> + <a class="next-page" href="pydis_core.utils.error_handling.commands.html"> <div class="page-info"> <div class="context"> <span>Next</span> </div> - <div class="title">function</div> + <div class="title">commands package</div> </div> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> </a> - <a class="prev-page" href="pydis_core.utils.cooldown.html"> + <a class="prev-page" href="pydis_core.utils.html"> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> <div class="page-info"> <div class="context"> <span>Previous</span> </div> - <div class="title">cooldown</div> + <div class="title">Utils</div> </div> </a> @@ -446,8 +490,9 @@ <div class="toc-tree-container"> <div class="toc-tree"> <ul> -<li><a class="reference internal" href="#">error_handling</a><ul> +<li><a class="reference internal" href="#">error_handling package</a><ul> <li><a class="reference internal" href="#pydis_core.utils.error_handling.handle_forbidden_from_block"><code class="docutils literal notranslate"><span class="pre">handle_forbidden_from_block()</span></code></a></li> +<li><a class="reference internal" href="#subpackages">Subpackages</a></li> </ul> </li> </ul> @@ -459,7 +504,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.function.html b/main/output/pydis_core.utils.function.html index a89f586e..a41c0d3e 100644 --- a/main/output/pydis_core.utils.function.html +++ b/main/output/pydis_core.utils.function.html @@ -3,10 +3,10 @@ <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> <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="interactions" href="pydis_core.utils.interactions.html" /><link rel="prev" title="error_handling" href="pydis_core.utils.error_handling.html" /> +<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="interactions" href="pydis_core.utils.interactions.html" /><link rel="prev" title="cooldown" href="pydis_core.utils.cooldown.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>function - Pydis Core Latest (10.7.0)</title> + <title>function - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.function.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.function.html">v10.7.0</a> </li> @@ -375,14 +386,14 @@ <p>Utils for manipulating functions.</p> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.function.GlobalNameConflictError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">GlobalNameConflictError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/function.py#L31-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.GlobalNameConflictError" 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">GlobalNameConflictError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/function.py#L31-L33"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.GlobalNameConflictError" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised on a conflict between the globals used to resolve annotations of a wrapped function and its wrapper.</p> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.function.command_wraps"> -<span class="sig-name descname"><span class="pre">command_wraps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wrapped</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">assigned</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('__module__',</span> <span class="pre">'__name__',</span> <span class="pre">'__qualname__',</span> <span class="pre">'__doc__',</span> <span class="pre">'__annotations__')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updated</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('__dict__',)</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">ignored_conflict_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">frozenset({})</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/function.py#L173-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.command_wraps" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">command_wraps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wrapped</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">assigned</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('__module__',</span> <span class="pre">'__name__',</span> <span class="pre">'__qualname__',</span> <span class="pre">'__doc__',</span> <span class="pre">'__annotations__')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updated</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('__dict__',)</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">ignored_conflict_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">frozenset({})</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/function.py#L173-L204"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.command_wraps" title="Link to this definition">#</a></dt> <dd><p>Update the decorated function to look like <code class="docutils literal notranslate"><span class="pre">wrapped</span></code>, and update globals for discord.py forwardref evaluation.</p> <p>See <a class="reference internal" href="#pydis_core.utils.function.update_wrapper_globals" title="pydis_core.utils.function.update_wrapper_globals"><code class="xref py py-func docutils literal notranslate"><span class="pre">update_wrapper_globals()</span></code></a> for more details on how the globals are updated.</p> <dl class="field-list simple"> @@ -406,7 +417,7 @@ with the wrapper replaced with the function <a class="reference internal" href=" <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.function.get_arg_value"> -<span class="sig-name descname"><span class="pre">get_arg_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arguments</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/function.py#L35-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_arg_value" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">get_arg_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">arguments</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/function.py#L35-L66"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_arg_value" title="Link to this definition">#</a></dt> <dd><p>Return a value from <cite>arguments</cite> based on a name or position.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -429,7 +440,7 @@ with the wrapper replaced with the function <a class="reference internal" href=" <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.function.get_arg_value_wrapper"> -<span class="sig-name descname"><span class="pre">get_arg_value_wrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">decorator_func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/function.py#L68-L92"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_arg_value_wrapper" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">get_arg_value_wrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">decorator_func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/function.py#L68-L92"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_arg_value_wrapper" title="Link to this definition">#</a></dt> <dd><p>Call <cite>decorator_func</cite> with the value of the arg at the given name/position.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -451,7 +462,7 @@ parameter names to argument values of the function it’s decorating.</p></li> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.function.get_bound_args"> -<span class="sig-name descname"><span class="pre">get_bound_args</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/function.py#L94-L112"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_bound_args" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">get_bound_args</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/function.py#L94-L112"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.get_bound_args" title="Link to this definition">#</a></dt> <dd><p>Bind <cite>args</cite> and <cite>kwargs</cite> to <cite>func</cite> and return a mapping of parameter names to argument values.</p> <p>Default parameter values are also set.</p> <dl class="field-list simple"> @@ -473,7 +484,7 @@ parameter names to argument values of the function it’s decorating.</p></li> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.function.update_wrapper_globals"> -<span class="sig-name descname"><span class="pre">update_wrapper_globals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wrapper</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wrapped</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">ignored_conflict_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">frozenset({})</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/function.py#L114-L171"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.update_wrapper_globals" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">update_wrapper_globals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wrapper</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wrapped</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">ignored_conflict_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">frozenset({})</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/function.py#L114-L171"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.function.update_wrapper_globals" title="Link to this definition">#</a></dt> <dd><p>Create a copy of <code class="docutils literal notranslate"><span class="pre">wrapper</span></code>, the copy’s globals are updated with <code class="docutils literal notranslate"><span class="pre">wrapped</span></code>'s globals.</p> <p>For forwardrefs in command annotations, discord.py uses the <code class="docutils literal notranslate"><span class="pre">__global__</span></code> attribute of the function to resolve their values. This breaks for decorators that replace the function because they have @@ -517,14 +528,14 @@ changes won’t be reflected in the new function’s globals.</p> </div> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> </a> - <a class="prev-page" href="pydis_core.utils.error_handling.html"> + <a class="prev-page" href="pydis_core.utils.cooldown.html"> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> <div class="page-info"> <div class="context"> <span>Previous</span> </div> - <div class="title">error_handling</div> + <div class="title">cooldown</div> </div> </a> @@ -576,7 +587,7 @@ changes won’t be reflected in the new function’s globals.</p> </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.html b/main/output/pydis_core.utils.html index be7c4d5e..9bca6ba1 100644 --- a/main/output/pydis_core.utils.html +++ b/main/output/pydis_core.utils.html @@ -3,10 +3,10 @@ <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> <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="caching" href="pydis_core.utils.caching.html" /><link rel="prev" title="Exts" href="pydis_core.exts.html" /> +<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="error_handling package" href="pydis_core.utils.error_handling.html" /><link rel="prev" title="Exts" href="pydis_core.exts.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>Utils - Pydis Core Latest (10.7.0)</title> + <title>Utils - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children current-page"><a class="current reference internal" href="#">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.html">v10.7.0</a> </li> @@ -375,7 +386,7 @@ <p>Useful utilities and tools for Discord bot development.</p> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.apply_monkey_patches"> -<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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/__init__.py#L25-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.apply_monkey_patches" title="Link to this definition">#</a></dt> +<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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/__init__.py#L28-L42"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.apply_monkey_patches" title="Link to this definition">#</a></dt> <dd><p>Applies all common monkey patches for our bots.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -394,7 +405,7 @@ that will act as top-level groups rather than being aliases of the command’s g <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.unqualify"> -<span class="sig-name descname"><span class="pre">unqualify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/_extensions.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.unqualify" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">unqualify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/_extensions.py#L10-L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.unqualify" title="Link to this definition">#</a></dt> <dd><p>Return an unqualified name given a qualified module/package <code class="docutils literal notranslate"><span class="pre">name</span></code>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -409,6 +420,26 @@ that will act as top-level groups rather than being aliases of the command’s g </dl> </dd></dl> +<section id="subpackages"> +<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading">#</a></h2> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><ul> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.error_handling.html#pydis_core.utils.error_handling.handle_forbidden_from_block"><code class="docutils literal notranslate"><span class="pre">handle_forbidden_from_block()</span></code></a></li> +<li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.error_handling.html#subpackages">Subpackages</a><ul> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><ul> +<li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#pydis_core.utils.error_handling.commands.AbstractCommandErrorHandler"><code class="docutils literal notranslate"><span class="pre">AbstractCommandErrorHandler</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#pydis_core.utils.error_handling.commands.CommandErrorManager"><code class="docutils literal notranslate"><span class="pre">CommandErrorManager</span></code></a></li> +<li class="toctree-l4"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html#submodules">Submodules</a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</section> <section id="submodules"> <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2> <div class="toctree-wrapper compound"> @@ -454,10 +485,6 @@ that will act as top-level groups rather than being aliases of the command’s g <li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.cooldown.html#pydis_core.utils.cooldown.block_duplicate_invocations"><code class="docutils literal notranslate"><span class="pre">block_duplicate_invocations()</span></code></a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a><ul> -<li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.error_handling.html#pydis_core.utils.error_handling.handle_forbidden_from_block"><code class="docutils literal notranslate"><span class="pre">handle_forbidden_from_block()</span></code></a></li> -</ul> -</li> <li class="toctree-l1"><a class="reference internal" href="pydis_core.utils.function.html">function</a><ul> <li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.function.html#pydis_core.utils.function.GlobalNameConflictError"><code class="docutils literal notranslate"><span class="pre">GlobalNameConflictError</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.function.html#pydis_core.utils.function.command_wraps"><code class="docutils literal notranslate"><span class="pre">command_wraps()</span></code></a></li> @@ -585,12 +612,12 @@ that will act as top-level groups rather than being aliases of the command’s g <footer> <div class="related-pages"> - <a class="next-page" href="pydis_core.utils.caching.html"> + <a class="next-page" href="pydis_core.utils.error_handling.html"> <div class="page-info"> <div class="context"> <span>Next</span> </div> - <div class="title">caching</div> + <div class="title">error_handling package</div> </div> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> </a> @@ -638,6 +665,7 @@ that will act as top-level groups rather than being aliases of the command’s g <li><a class="reference internal" href="#">Utils</a><ul> <li><a class="reference internal" href="#pydis_core.utils.apply_monkey_patches"><code class="docutils literal notranslate"><span class="pre">apply_monkey_patches()</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.unqualify"><code class="docutils literal notranslate"><span class="pre">unqualify()</span></code></a></li> +<li><a class="reference internal" href="#subpackages">Subpackages</a></li> <li><a class="reference internal" href="#submodules">Submodules</a></li> </ul> </li> @@ -650,7 +678,7 @@ that will act as top-level groups rather than being aliases of the command’s g </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.interactions.html b/main/output/pydis_core.utils.interactions.html index 6081cbc8..68a7bf26 100644 --- a/main/output/pydis_core.utils.interactions.html +++ b/main/output/pydis_core.utils.interactions.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="lock" href="pydis_core.utils.lock.html" /><link rel="prev" title="function" href="pydis_core.utils.function.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>interactions - Pydis Core Latest (10.7.0)</title> + <title>interactions - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.interactions.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.interactions.html">v10.7.0</a> </li> @@ -374,7 +385,7 @@ <span id="interactions"></span><h1>interactions<a class="headerlink" href="#module-pydis_core.utils.interactions" title="Link to this heading">#</a></h1> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.interactions.DeleteMessageButton"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DeleteMessageButton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('secondary',</span> <span class="pre">2)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Delete'</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/interactions.py#L110-L136"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DeleteMessageButton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('secondary',</span> <span class="pre">2)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Delete'</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/interactions.py#L110-L136"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.Button" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Button</span></code></a></p> <p>A button that can be added to a view to delete the message containing the view on click.</p> <p>This button itself carries out no interaction checks, these should be done by the parent view.</p> @@ -389,12 +400,12 @@ </dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.interactions.DeleteMessageButton.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('secondary',</span> <span class="pre">2)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Delete'</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/interactions.py#L124-L132"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton.__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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('secondary',</span> <span class="pre">2)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'Delete'</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/interactions.py#L124-L132"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton.__init__" title="Link to this definition">#</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.interactions.DeleteMessageButton.callback"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">callback</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/interactions.py#L133-L136"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton.callback" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">callback</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/interactions.py#L133-L136"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.DeleteMessageButton.callback" title="Link to this definition">#</a></dt> <dd><p>Delete the original message on button click.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -407,7 +418,7 @@ <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.interactions.ViewWithUserAndRoleCheck"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ViewWithUserAndRoleCheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/interactions.py#L49-L108"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ViewWithUserAndRoleCheck</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/interactions.py#L49-L108"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ui.View" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">View</span></code></a></p> <p>A view that allows the original invoker and moderators to interact with it.</p> <dl class="field-list simple"> @@ -424,12 +435,12 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod </dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.interactions.ViewWithUserAndRoleCheck.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/interactions.py#L62-L74"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.__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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">180.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/interactions.py#L62-L74"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.__init__" title="Link to this definition">#</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.interactions.ViewWithUserAndRoleCheck.interaction_check"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">interaction_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/interactions.py#L75-L97"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.interaction_check" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">interaction_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">interaction</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/interactions.py#L75-L97"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.interaction_check" title="Link to this definition">#</a></dt> <dd><p>Ensure the user clicking the button is the view invoker, or a moderator.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -443,7 +454,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.interactions.ViewWithUserAndRoleCheck.on_timeout"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_timeout</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/interactions.py#L104-L108"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.on_timeout" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_timeout</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/interactions.py#L104-L108"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.on_timeout" title="Link to this definition">#</a></dt> <dd><p>Remove the view from <code class="docutils literal notranslate"><span class="pre">self.message</span></code> if set.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -454,7 +465,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.interactions.ViewWithUserAndRoleCheck.stop"> -<span class="sig-name descname"><span class="pre">stop</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/interactions.py#L98-L103"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.stop" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">stop</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/interactions.py#L98-L103"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.ViewWithUserAndRoleCheck.stop" title="Link to this definition">#</a></dt> <dd><p>Stop listening for interactions, and remove the view from <code class="docutils literal notranslate"><span class="pre">self.message</span></code> if set.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -467,7 +478,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.interactions.user_has_access"> -<span class="sig-name descname"><span class="pre">user_has_access</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</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">allowed_users</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">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/interactions.py#L12-L29"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.user_has_access" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">user_has_access</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</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">allowed_users</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">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">()</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/interactions.py#L12-L29"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.interactions.user_has_access" title="Link to this definition">#</a></dt> <dd><p>Return whether the user is in the allowed_users list, or has a role from allowed_roles.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -565,7 +576,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.lock.html b/main/output/pydis_core.utils.lock.html index 1cf1be56..2081d636 100644 --- a/main/output/pydis_core.utils.lock.html +++ b/main/output/pydis_core.utils.lock.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="logging" href="pydis_core.utils.logging.html" /><link rel="prev" title="interactions" href="pydis_core.utils.interactions.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>lock - Pydis Core Latest (10.7.0)</title> + <title>lock - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3 current current-page"><a class="current reference internal" href="#">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.lock.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.lock.html">v10.7.0</a> </li> @@ -374,12 +385,12 @@ <span id="lock"></span><h1>lock<a class="headerlink" href="#module-pydis_core.utils.lock" title="Link to this heading">#</a></h1> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.lock.LockedResourceError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LockedResourceError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError" 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">LockedResourceError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">RuntimeError</span></code></a></p> <p>Exception raised when an operation is attempted on a locked resource.</p> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.lock.LockedResourceError.type"> -<span class="sig-name descname"><span class="pre">type</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.type" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">type</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.type" title="Link to this definition">#</a></dt> <dd><p>Name of the locked resource’s type</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -390,7 +401,7 @@ <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.lock.LockedResourceError.id"> -<span class="sig-name descname"><span class="pre">id</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.id" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">id</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/lock.py#L22-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.id" title="Link to this definition">#</a></dt> <dd><p>ID of the locked resource</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> @@ -401,38 +412,38 @@ <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.lock.LockedResourceError.__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">resource_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/lock.py#L31-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.__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">resource_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/lock.py#L31-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.LockedResourceError.__init__" title="Link to this definition">#</a></dt> <dd></dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.lock.SharedEvent"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SharedEvent</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/lock.py#L41-L68"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SharedEvent</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/lock.py#L41-L68"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>Context manager managing an internal event exposed through the wait coro.</p> <p>While any code is executing in this context manager, the underlying event will not be set; when all of the holders finish the event will be set.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.lock.SharedEvent.__enter__"> -<span class="sig-name descname"><span class="pre">__enter__</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/lock.py#L54-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__enter__" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__enter__</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/lock.py#L54-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__enter__" title="Link to this definition">#</a></dt> <dd><p>Increment the count of the active holders and clear the internal event.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.lock.SharedEvent.__exit__"> -<span class="sig-name descname"><span class="pre">__exit__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_exc_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_exc_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_exc_tb</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/lock.py#L59-L64"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__exit__" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__exit__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_exc_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_exc_val</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_exc_tb</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/lock.py#L59-L64"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__exit__" title="Link to this definition">#</a></dt> <dd><p>Decrement the count of the active holders; if 0 is reached set the internal event.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.lock.SharedEvent.__init__"> -<span class="sig-name descname"><span class="pre">__init__</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/lock.py#L49-L53"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__init__" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__init__</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/lock.py#L49-L53"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.__init__" title="Link to this definition">#</a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.lock.SharedEvent.wait"> -<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/lock.py#L65-L68"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.wait" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">wait</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/lock.py#L65-L68"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.SharedEvent.wait" title="Link to this definition">#</a></dt> <dd><p>Wait for all active holders to exit.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -445,7 +456,7 @@ when all of the holders finish the event will be set.</p> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.lock.lock"> -<span class="sig-name descname"><span class="pre">lock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</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">raise_error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/lock.py#L70-L137"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.lock" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">lock</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_id</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">raise_error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/lock.py#L70-L137"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.lock" title="Link to this definition">#</a></dt> <dd><p>Turn the decorated coroutine function into a mutually exclusive operation on a <cite>resource_id</cite>.</p> <p>If decorating a command, this decorator must go before (below) the <cite>command</cite> decorator.</p> <dl class="field-list simple"> @@ -472,7 +483,7 @@ and return None.</p></li> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.lock.lock_arg"> -<span class="sig-name descname"><span class="pre">lock_arg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</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></em>, <em class="sig-param"><span class="n"><span class="pre">raise_error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/lock.py#L139-L157"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.lock_arg" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">lock_arg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_or_pos</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">func</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></em>, <em class="sig-param"><span class="n"><span class="pre">raise_error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/lock.py#L139-L157"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.lock.lock_arg" title="Link to this definition">#</a></dt> <dd><p>Apply the <cite>lock</cite> decorator using the value of the arg at the given name/position as the ID.</p> <p>See <cite>lock</cite> docs for more information.</p> <dl class="field-list simple"> @@ -569,7 +580,7 @@ and return None.</p></li> </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.logging.html b/main/output/pydis_core.utils.logging.html index af268440..8664748c 100644 --- a/main/output/pydis_core.utils.logging.html +++ b/main/output/pydis_core.utils.logging.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="members" href="pydis_core.utils.members.html" /><link rel="prev" title="lock" href="pydis_core.utils.lock.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>logging - Pydis Core Latest (10.7.0)</title> + <title>logging - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.logging.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.logging.html">v10.7.0</a> </li> @@ -375,12 +386,12 @@ <p>Common logging related functions.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.logging.CustomLogger"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/logging.py#L20-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.CustomLogger" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CustomLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/logging.py#L20-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.CustomLogger" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Logger</span></code></a></p> <p>Custom implementation of the <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.Logger</span></code></a> class with an added <a class="reference internal" href="#pydis_core.utils.logging.CustomLogger.trace" title="pydis_core.utils.logging.CustomLogger.trace"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trace</span></code></a> method.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.logging.CustomLogger.trace"> -<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <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="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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/logging.py#L23-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.CustomLogger.trace" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <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="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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/logging.py#L23-L39"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.CustomLogger.trace" title="Link to this definition">#</a></dt> <dd><p>Log the given message with the severity <code class="docutils literal notranslate"><span class="pre">"TRACE"</span></code>.</p> <p>To pass exception information, use the keyword argument exc_info with a true value:</p> <div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="n">logger</span><span class="o">.</span><span class="n">trace</span><span class="p">(</span><span class="s2">"Houston, we have an </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"interesting problem"</span><span class="p">,</span> <span class="n">exc_info</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> @@ -404,7 +415,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.logging.get_logger"> -<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/logging.py#L41-L52"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.get_logger" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">get_logger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/logging.py#L41-L52"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.get_logger" title="Link to this definition">#</a></dt> <dd><p>Utility to make mypy recognise that logger is of type <a class="reference internal" href="#pydis_core.utils.logging.CustomLogger" title="pydis_core.utils.logging.CustomLogger"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CustomLogger</span></code></a>.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -421,7 +432,7 @@ <dl class="py data"> <dt class="sig sig-object py" id="pydis_core.utils.logging.log_format"> -<span class="sig-name descname"><span class="pre">log_format</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/logging.py#L12"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.log_format" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">log_format</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/logging.py#L12"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.logging.log_format" title="Link to this definition">#</a></dt> <dd><p>A <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Formatter" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.Formatter</span></code></a> that can be used to standardise logging across all projects using pydis_core.</p> <dl class="field-list simple"> </dl> @@ -502,7 +513,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.members.html b/main/output/pydis_core.utils.members.html index 204956a5..54d07474 100644 --- a/main/output/pydis_core.utils.members.html +++ b/main/output/pydis_core.utils.members.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="messages" href="pydis_core.utils.messages.html" /><link rel="prev" title="logging" href="pydis_core.utils.logging.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>members - Pydis Core Latest (10.7.0)</title> + <title>members - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.members.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.members.html">v10.7.0</a> </li> @@ -375,7 +386,7 @@ <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.4.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="pydis_core.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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/members.py#L12-L31"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.members.get_or_fetch_member" 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">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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/members.py#L12-L31"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.members.get_or_fetch_member" title="Link 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> @@ -389,7 +400,7 @@ <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.members.handle_role_change"> -<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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/members.py#L33-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.members.handle_role_change" 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">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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/members.py#L33-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.members.handle_role_change" title="Link 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.4.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.4.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p> @@ -478,7 +489,7 @@ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.messages.html b/main/output/pydis_core.utils.messages.html index 75561aa9..853bad09 100644 --- a/main/output/pydis_core.utils.messages.html +++ b/main/output/pydis_core.utils.messages.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="pagination" href="pydis_core.utils.pagination.html" /><link rel="prev" title="members" href="pydis_core.utils.members.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>messages - Pydis Core Latest (10.7.0)</title> + <title>messages - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.messages.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.messages.html">v10.7.0</a> </li> @@ -374,7 +385,7 @@ <span id="messages"></span><h1>messages<a class="headerlink" href="#module-pydis_core.utils.messages" title="Link to this heading">#</a></h1> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.messages.reaction_check"> -<span class="sig-name descname"><span class="pre">reaction_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</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">message_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_emoji</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/messages.py#L11-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.messages.reaction_check" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">reaction_check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</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">message_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_emoji</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_users</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/messages.py#L11-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.messages.reaction_check" title="Link to this definition">#</a></dt> <dd><p>Check if a reaction’s emoji and author are allowed and the message is <cite>message_id</cite>.</p> <p>If the user is not allowed, remove the reaction. Ignore reactions made by the bot. If <cite>allow_mods</cite> is True, allow users with moderator roles even if they’re not in <cite>allowed_users</cite>.</p> @@ -455,7 +466,7 @@ If <cite>allow_mods</cite> is True, allow users with moderator roles even if the </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.pagination.html b/main/output/pydis_core.utils.pagination.html index 5f3308b1..600eff8d 100644 --- a/main/output/pydis_core.utils.pagination.html +++ b/main/output/pydis_core.utils.pagination.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="paste_service" href="pydis_core.utils.paste_service.html" /><link rel="prev" title="messages" href="pydis_core.utils.messages.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>pagination - Pydis Core Latest (10.7.0)</title> + <title>pagination - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.pagination.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.pagination.html">v10.7.0</a> </li> @@ -374,14 +385,14 @@ <span id="pagination"></span><h1>pagination<a class="headerlink" href="#module-pydis_core.utils.pagination" title="Link to this heading">#</a></h1> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.EmptyPaginatorEmbedError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.EmptyPaginatorEmbedError" 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">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.EmptyPaginatorEmbedError" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when attempting to paginate with empty contents.</p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator" 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.Paginator" title="(in discord.py v2.4.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Paginator</span></code></a></p> <p>A class that aids in paginating code blocks for Discord messages.</p> <dl class="field-list simple"> @@ -398,14 +409,14 @@ </dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator.__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">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.__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">prefix</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">suffix</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</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">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.__init__" title="Link to this definition">#</a></dt> <dd><p>This function overrides the Paginator.__init__ from inside discord.ext.commands.</p> <p>It overrides in order to allow us to configure the maximum number of lines per page.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator.add_line"> -<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</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">empty</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.add_line" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</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">empty</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.add_line" title="Link to this definition">#</a></dt> <dd><p>Adds a line to the current page.</p> <p>If a line on a page exceeds <cite>max_size</cite> characters, then <cite>max_size</cite> will go up to <cite>scale_to_size</cite> for a single line before creating a new page for the overflow words. If it @@ -433,7 +444,7 @@ page at a reasonable size.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator.paginate"> -<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</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">prefix</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">suffix</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">max_lines</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restrict_to_user</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</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">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="n"><span class="pre">exception_on_empty_embed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.paginate" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</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">prefix</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">suffix</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">max_lines</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">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restrict_to_user</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">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</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">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="n"><span class="pre">exception_on_empty_embed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.paginate" title="Link to this definition">#</a></dt> <dd><p>Use a paginator and set of reactions to provide pagination over a set of lines.</p> <p>The reactions are used to switch page, or to finish with pagination.</p> <p>When used, this will send a message using <cite>ctx.send()</cite> and apply a set of reactions to it. These reactions may @@ -477,7 +488,7 @@ to any user with a moderation role.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PaginationEmojis</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PaginationEmojis</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel" title="(in Pydantic v0.0.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></a></p> <p>The emojis that will be used for pagination.</p> <dl class="py attribute"> @@ -584,7 +595,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.paste_service.html b/main/output/pydis_core.utils.paste_service.html index aaa49455..017404e3 100644 --- a/main/output/pydis_core.utils.paste_service.html +++ b/main/output/pydis_core.utils.paste_service.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="regex" href="pydis_core.utils.regex.html" /><link rel="prev" title="pagination" href="pydis_core.utils.pagination.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>paste_service - Pydis Core Latest (10.7.0)</title> + <title>paste_service - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.paste_service.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.paste_service.html">v10.7.0</a> </li> @@ -374,13 +385,13 @@ <span id="paste-service"></span><h1>paste_service<a class="headerlink" href="#module-pydis_core.utils.paste_service" title="Link to this heading">#</a></h1> <dl class="py data"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.MAX_PASTE_SIZE"> -<span class="sig-name descname"><span class="pre">MAX_PASTE_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">524288</span></em><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/paste_service.py#L13"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.MAX_PASTE_SIZE" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">MAX_PASTE_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">524288</span></em><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/paste_service.py#L13"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.MAX_PASTE_SIZE" title="Link to this definition">#</a></dt> <dd><p>The maximum allows size of a paste, in bytes.</p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteFile</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/paste_service.py#L33-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteFile</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/paste_service.py#L33-L46"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel" title="(in Pydantic v0.0.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></a></p> <p>A file to be pasted to the paste service.</p> <dl class="field-list simple"> @@ -416,7 +427,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</ <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteResponse</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/paste_service.py#L20-L31"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteResponse</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">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/paste_service.py#L20-L31"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel" title="(in Pydantic v0.0.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></a></p> <p>A successful response from the paste service.</p> <dl class="field-list simple"> @@ -451,28 +462,28 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</ <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteTooLongError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteTooLongError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/paste_service.py#L56-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteTooLongError" 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">PasteTooLongError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/paste_service.py#L56-L58"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteTooLongError" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when content is too large to upload to the paste service.</p> </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteUnsupportedLexerError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteUnsupportedLexerError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/paste_service.py#L52-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteUnsupportedLexerError" 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">PasteUnsupportedLexerError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/paste_service.py#L52-L54"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteUnsupportedLexerError" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when an unsupported lexer is used.</p> </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteUploadError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PasteUploadError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/paste_service.py#L48-L50"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteUploadError" 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">PasteUploadError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/paste_service.py#L48-L50"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.PasteUploadError" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when an error is encountered uploading to the paste service.</p> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.send_to_paste_service"> -<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">send_to_paste_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</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">paste_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'https://paste.pythondiscord.com'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">524288</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/paste_service.py#L70-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.send_to_paste_service" 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">send_to_paste_service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</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">paste_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'https://paste.pythondiscord.com'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">524288</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/paste_service.py#L70-L155"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.paste_service.send_to_paste_service" title="Link to this definition">#</a></dt> <dd><p>Upload some contents to the paste service.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -585,7 +596,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</ </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.regex.html b/main/output/pydis_core.utils.regex.html index 37190e5b..1e3b1e94 100644 --- a/main/output/pydis_core.utils.regex.html +++ b/main/output/pydis_core.utils.regex.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="scheduling" href="pydis_core.utils.scheduling.html" /><link rel="prev" title="paste_service" href="pydis_core.utils.paste_service.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>regex - Pydis Core Latest (10.7.0)</title> + <title>regex - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.regex.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.regex.html">v10.7.0</a> </li> @@ -375,7 +386,7 @@ <p>Common regular expressions.</p> <dl class="py data"> <dt class="sig sig-object py" id="pydis_core.utils.regex.DISCORD_INVITE"> -<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/regex.py#L5-L17"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.DISCORD_INVITE" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">DISCORD_INVITE</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/regex.py#L5-L17"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.DISCORD_INVITE" title="Link to this definition">#</a></dt> <dd><p>Regex for Discord server invites.</p> <div class="admonition warning"> <p class="admonition-title">Warning</p> @@ -389,7 +400,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur <dl class="py data"> <dt class="sig sig-object py" id="pydis_core.utils.regex.FORMATTED_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/regex.py#L29-L37"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.FORMATTED_CODE_REGEX" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">FORMATTED_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/regex.py#L29-L37"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.FORMATTED_CODE_REGEX" title="Link to this definition">#</a></dt> <dd><p>Regex for formatted code, using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> @@ -397,7 +408,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur <dl class="py data"> <dt class="sig sig-object py" id="pydis_core.utils.regex.RAW_CODE_REGEX"> -<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/regex.py#L44-L49"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.RAW_CODE_REGEX" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">RAW_CODE_REGEX</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/regex.py#L44-L49"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.regex.RAW_CODE_REGEX" title="Link to this definition">#</a></dt> <dd><p>Regex for raw code, <em>not</em> using Discord’s code blocks.</p> <dl class="field-list simple"> </dl> @@ -475,7 +486,7 @@ such as <a class="reference external" href="https://docs.python.org/3/library/ur </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> diff --git a/main/output/pydis_core.utils.scheduling.html b/main/output/pydis_core.utils.scheduling.html index f76958ae..df48e319 100644 --- a/main/output/pydis_core.utils.scheduling.html +++ b/main/output/pydis_core.utils.scheduling.html @@ -6,7 +6,7 @@ <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="async_stats" href="pydis_core.async_stats.html" /><link rel="prev" title="regex" href="pydis_core.utils.regex.html" /> <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --> - <title>scheduling - Pydis Core Latest (10.7.0)</title> + <title>scheduling - Pydis Core Latest (11.0.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=135e06be" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" /> @@ -127,7 +127,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (10.7.0)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.0.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -153,7 +153,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (10.7.0)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.0.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -166,12 +166,19 @@ <li class="toctree-l1 current has-children"><a class="reference internal" href="pydis_core.html">Pydis Core</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Pydis Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pydis_core.exts.html">Exts</a></li> <li class="toctree-l2 current has-children"><a class="reference internal" href="pydis_core.utils.html">Utils</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Utils</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> +<li class="toctree-l3 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of error_handling package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l4 has-children"><a class="reference internal" href="pydis_core.utils.error_handling.commands.html">commands package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of commands package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.abc.html">abc</a></li> +<li class="toctree-l5"><a class="reference internal" href="pydis_core.utils.error_handling.commands.manager.html">manager</a></li> +</ul> +</li> +</ul> +</li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.caching.html">caching</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.channel.html">channel</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.checks.html">checks</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.commands.html">commands</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.cooldown.html">cooldown</a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.error_handling.html">error_handling</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.function.html">function</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.interactions.html">interactions</a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.lock.html">lock</a></li> @@ -280,6 +287,10 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.0.0/output/pydis_core.utils.scheduling.html">v11.0.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v10.7.0/output/pydis_core.utils.scheduling.html">v10.7.0</a> </li> @@ -375,7 +386,7 @@ <p>Generic python scheduler.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.scheduling.Scheduler"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/scheduling.py#L19-L216"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler" title="Link to this definition">#</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Scheduler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/scheduling.py#L19-L216"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler" title="Link to this definition">#</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> <p>Schedule the execution of coroutines and keep track of them.</p> <p>When instantiating a <a class="reference internal" href="#pydis_core.utils.scheduling.Scheduler" title="pydis_core.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a>, a name must be provided. This name is used to distinguish the @@ -389,7 +400,7 @@ the same ID used to schedule it.</p> <p>Any exception raised in a scheduled task is logged when the task is done.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.scheduling.Scheduler.__contains__"> -<span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/scheduling.py#L49-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.__contains__" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/scheduling.py#L49-L60"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.__contains__" title="Link to this definition">#</a></dt> <dd><p>Return <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> if a task with the given <code class="docutils literal notranslate"><span class="pre">task_id</span></code> is currently scheduled.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -406,7 +417,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.scheduling.Scheduler.__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">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/scheduling.py#L37-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.__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">name</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/scheduling.py#L37-L48"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.__init__" title="Link to this definition">#</a></dt> <dd><p>Initialize a new <a class="reference internal" href="#pydis_core.utils.scheduling.Scheduler" title="pydis_core.utils.scheduling.Scheduler"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scheduler</span></code></a> instance.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -417,7 +428,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.scheduling.Scheduler.cancel"> -<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/scheduling.py#L132-L149"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.cancel" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/scheduling.py#L132-L149"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.cancel" title="Link to this definition">#</a></dt> <dd><p>Unschedule the task identified by <code class="docutils literal notranslate"><span class="pre">task_id</span></code>. Log a warning if the task doesn’t exist.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> @@ -431,7 +442,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.scheduling.Scheduler.cancel_all"> -<span class="sig-name descname"><span class="pre">cancel_all</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/scheduling.py#L150-L156"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.cancel_all" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">cancel_all</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/scheduling.py#L150-L156"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.cancel_all" title="Link to this definition">#</a></dt> <dd><p>Unschedule all known tasks.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> @@ -442,7 +453,7 @@ the same ID used to schedule it.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.scheduling.Scheduler.schedule"> -<span class="sig-name descname"><span class="pre">schedule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/scheduling.py#L61-L88"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/scheduling.py#L61-L88"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule" title="Link to this definition">#</a></dt> <dd><p>Schedule the execution of a <code class="docutils literal notranslate"><span class="pre">coroutine</span></code>.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> @@ -461,7 +472,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.scheduling.Scheduler.schedule_at"> -<span class="sig-name descname"><span class="pre">schedule_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/scheduling.py#L89-L112"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule_at" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/scheduling.py#L89-L112"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule_at" title="Link to this definition">#</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed at the given <code class="docutils literal notranslate"><span class="pre">time</span></code>.</p> <p>If <code class="docutils literal notranslate"><span class="pre">time</span></code> is timezone aware, then use that timezone to calculate now() when subtracting. If <code class="docutils literal notranslate"><span class="pre">time</span></code> is naïve, then use UTC.</p> @@ -484,7 +495,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.scheduling.Scheduler.schedule_later"> -<span class="sig-name descname"><span class="pre">schedule_later</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/scheduling.py#L113-L131"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule_later" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">schedule_later</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">task_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">coroutine</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/scheduling.py#L113-L131"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.Scheduler.schedule_later" title="Link to this definition">#</a></dt> <dd><p>Schedule <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> to be executed after <code class="docutils literal notranslate"><span class="pre">delay</span></code> seconds.</p> <p>If a task with <code class="docutils literal notranslate"><span class="pre">task_id</span></code> already exists, close <code class="docutils literal notranslate"><span class="pre">coroutine</span></code> instead of scheduling it. This prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re-used elsewhere.</p> @@ -506,7 +517,7 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="py function"> <dt class="sig sig-object py" id="pydis_core.utils.scheduling.create_task"> -<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</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">suppressed_exceptions</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">event_loop</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/9a497193db7cca2d64cd99251f34b83bec2d9137/pydis_core/utils/scheduling.py#L221-L252"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.create_task" title="Link to this definition">#</a></dt> +<span class="sig-name descname"><span class="pre">create_task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coro</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">suppressed_exceptions</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">event_loop</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/1c35bf5f8d9a02dfbfba3a1093c1b92253ec2f91/pydis_core/utils/scheduling.py#L221-L252"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.scheduling.create_task" title="Link to this definition">#</a></dt> <dd><p>Wrapper for creating an <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.Task</span></code></a> which logs exceptions raised in the task.</p> <p>If the <code class="docutils literal notranslate"><span class="pre">event_loop</span></code> kwarg is provided, the task is created from that event loop, otherwise the running loop is used.</p> @@ -608,7 +619,7 @@ otherwise the running loop is used.</p> </aside> </div> -</div><script src="../_static/documentation_options.js?v=bd02792a"></script> +</div><script src="../_static/documentation_options.js?v=ce29b7a2"></script> <script src="../_static/doctools.js?v=888ff710"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=32e29ea5"></script> |