diff options
Diffstat (limited to 'v10.7.0/output')
21 files changed, 539 insertions, 375 deletions
diff --git a/v10.7.0/output/pydis_core.async_stats.html b/v10.7.0/output/pydis_core.async_stats.html index 7a8e2255..6063f9a0 100644 --- a/v10.7.0/output/pydis_core.async_stats.html +++ b/v10.7.0/output/pydis_core.async_stats.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>async_stats - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.async_stats.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.async_stats.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.async_stats.html">v11.3.1</a> </li> @@ -459,11 +467,11 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>loop</strong> (<a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.AbstractEventLoop" title="(in Python v3.12)"><em>asyncio.AbstractEventLoop</em></a>) – The event loop to use when creating the -<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>.</p></li> -<li><p><strong>host</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The host to connect to.</p></li> -<li><p><strong>port</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The port to connect to.</p></li> -<li><p><strong>prefix</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <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>) – The prefix to use for all stats.</p></li> +<li><p><strong>loop</strong> (<a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.AbstractEventLoop" title="(in Python v3.13)"><em>asyncio.AbstractEventLoop</em></a>) – The event loop to use when creating the +<a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.loop.create_datagram_endpoint</span></code></a>.</p></li> +<li><p><strong>host</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The host to connect to.</p></li> +<li><p><strong>port</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The port to connect to.</p></li> +<li><p><strong>prefix</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The prefix to use for all stats.</p></li> </ul> </dd> </dl> @@ -472,10 +480,10 @@ <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/07f517225fc59157233f74edb136ee39046fda00/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> +<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.13)"><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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -557,7 +565,7 @@ </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.exts.html b/v10.7.0/output/pydis_core.exts.html index fde6cbf0..772635ef 100644 --- a/v10.7.0/output/pydis_core.exts.html +++ b/v10.7.0/output/pydis_core.exts.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>Exts - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.exts.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.exts.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.exts.html">v11.3.1</a> </li> @@ -499,7 +507,7 @@ </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.html b/v10.7.0/output/pydis_core.html index ce0d7cad..a9d38301 100644 --- a/v10.7.0/output/pydis_core.html +++ b/v10.7.0/output/pydis_core.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>Pydis Core - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.html">v11.3.1</a> </li> @@ -459,12 +467,12 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>guild_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The ID of the guild used for <a class="reference internal" href="#pydis_core.BotBase.wait_until_guild_available" title="pydis_core.BotBase.wait_until_guild_available"><code class="xref py py-func docutils literal notranslate"><span class="pre">wait_until_guild_available()</span></code></a>.</p></li> -<li><p><strong>allowed_roles</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a></span>) – A list of role IDs that the bot is allowed to mention.</p></li> -<li><p><strong>http_session</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.10)"><em>aiohttp.ClientSession</em></a>) – The session to use for the bot.</p></li> -<li><p><strong>redis_session</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">RedisSession</span></code> | <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>) – The <a class="reference external" href="https://github.com/SebastiaanZ/async-rediscache#creating-a-redissession">async_rediscache.RedisSession</a> to use for the bot.</p></li> -<li><p><strong>api_client</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="pydis_core.site_api.html#pydis_core.site_api.APIClient" title="pydis_core.site_api.APIClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIClient</span></code></a> | <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>) – The <a class="reference internal" href="pydis_core.site_api.html#pydis_core.site_api.APIClient" title="pydis_core.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.site_api.APIClient</span></code></a> instance to use for the bot.</p></li> -<li><p><strong>statsd_url</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <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>) – The URL of the statsd server to use for the bot. If not given, +<li><p><strong>guild_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The ID of the guild used for <a class="reference internal" href="#pydis_core.BotBase.wait_until_guild_available" title="pydis_core.BotBase.wait_until_guild_available"><code class="xref py py-func docutils literal notranslate"><span class="pre">wait_until_guild_available()</span></code></a>.</p></li> +<li><p><strong>allowed_roles</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a></span>) – A list of role IDs that the bot is allowed to mention.</p></li> +<li><p><strong>http_session</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.11)"><em>aiohttp.ClientSession</em></a>) – The session to use for the bot.</p></li> +<li><p><strong>redis_session</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">RedisSession</span></code> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The <a class="reference external" href="https://github.com/SebastiaanZ/async-rediscache#creating-a-redissession">async_rediscache.RedisSession</a> to use for the bot.</p></li> +<li><p><strong>api_client</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="pydis_core.site_api.html#pydis_core.site_api.APIClient" title="pydis_core.site_api.APIClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIClient</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The <a class="reference internal" href="pydis_core.site_api.html#pydis_core.site_api.APIClient" title="pydis_core.site_api.APIClient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pydis_core.site_api.APIClient</span></code></a> instance to use for the bot.</p></li> +<li><p><strong>statsd_url</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The URL of the statsd server to use for the bot. If not given, a dummy statsd client will be created.</p></li> </ul> </dd> @@ -477,7 +485,7 @@ a dummy statsd client will be created.</p></li> <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -488,7 +496,7 @@ a dummy statsd client will be created.</p></li> <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -499,7 +507,7 @@ a dummy statsd client will be created.</p></li> <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -510,7 +518,7 @@ a dummy statsd client will be created.</p></li> <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -521,10 +529,10 @@ a dummy statsd client will be created.</p></li> <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> -<dd class="field-odd"><p><strong>sync_app_commands</strong> (<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>) – Whether to sync app commands after all extensions are loaded.</p> +<dd class="field-odd"><p><strong>sync_app_commands</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span>) – Whether to sync app commands after all extensions are loaded.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -535,7 +543,7 @@ a dummy statsd client will be created.</p></li> <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -548,7 +556,7 @@ a dummy statsd client will be created.</p></li> will not be set and <cite>guild_available_but_cache_empty</cite> event will be emitted.</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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -559,7 +567,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -570,7 +578,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -582,7 +590,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e <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"> <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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -595,7 +603,7 @@ will not be set and <cite>guild_available_but_cache_empty</cite> event will be e To remove them, either remove the entire command or manually edit <cite>bot.all_commands</cite>.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a> | <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 class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Command" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -609,7 +617,7 @@ To remove them, either remove the entire command or manually edit <cite>bot.all_ and <a class="reference internal" href="#pydis_core.BotBase.ping_services" title="pydis_core.BotBase.ping_services"><code class="xref py py-func docutils literal notranslate"><span class="pre">ping_services()</span></code></a>.</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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -622,7 +630,7 @@ and <a class="reference internal" href="#pydis_core.BotBase.ping_services" title gateway event before giving up and thus not populating the cache for unavailable guilds.</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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -632,7 +640,7 @@ 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/07f517225fc59157233f74edb136ee39046fda00/pydis_core/utils/pagination.py#L27-L29"><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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><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> @@ -645,11 +653,11 @@ gateway event before giving up and thus not populating the cache for unavailable <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>pagination_emojis</strong> (<a class="reference internal" href="#pydis_core.PaginationEmojis" title="pydis_core.PaginationEmojis"><em>PaginationEmojis</em></a>) – The emojis used to navigate pages.</p></li> -<li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The prefix inserted to every page. e.g. three backticks.</p></li> -<li><p><strong>suffix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The suffix appended at the end of every page. e.g. three backticks.</p></li> -<li><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of codepoints allowed in a page.</p></li> -<li><p><strong>scale_to_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of characters a single line can scale up to.</p></li> -<li><p><strong>max_lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of lines allowed in a page.</p></li> +<li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The prefix inserted to every page. e.g. three backticks.</p></li> +<li><p><strong>suffix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The suffix appended at the end of every page. e.g. three backticks.</p></li> +<li><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of codepoints allowed in a page.</p></li> +<li><p><strong>scale_to_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of characters a single line can scale up to.</p></li> +<li><p><strong>max_lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of lines allowed in a page.</p></li> </ul> </dd> </dl> @@ -678,12 +686,12 @@ page at a reasonable size.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The line to add to the paginated content.</p></li> -<li><p><strong>empty</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether an empty line should be added at the end.</p></li> +<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The line to add to the paginated content.</p></li> +<li><p><strong>empty</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Indicates whether an empty line should be added at the end.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -702,26 +710,26 @@ to any user with a moderation role.</p> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>pagination_emojis</strong> (<a class="reference internal" href="#pydis_core.PaginationEmojis" title="pydis_core.PaginationEmojis"><em>PaginationEmojis</em></a>) – The emojis used to navigate pages.</p></li> -<li><p><strong>lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – A list of lines to be added to the paginated content.</p></li> +<li><p><strong>lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>]</em>) – A list of lines to be added to the paginated content.</p></li> <li><p><strong>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context in which the pagination is needed.</p></li> <li><p><strong>embed</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Embed" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Embed</span></code></a>) – The embed that holds the content, it serves as the page.</p></li> -<li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The prefix inserted to every page. e.g. three backticks.</p></li> -<li><p><strong>suffix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The suffix appended at the end of every page. e.g. three backticks.</p></li> -<li><p><strong>max_lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of lines allowed in a page.</p></li> -<li><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of codepoints allowed in a page.</p></li> -<li><p><strong>scale_to_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of characters a single line can scale up to.</p></li> -<li><p><strong>empty</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether an empty line should be added to each provided line.</p></li> +<li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The prefix inserted to every page. e.g. three backticks.</p></li> +<li><p><strong>suffix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The suffix appended at the end of every page. e.g. three backticks.</p></li> +<li><p><strong>max_lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of lines allowed in a page.</p></li> +<li><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of codepoints allowed in a page.</p></li> +<li><p><strong>scale_to_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of characters a single line can scale up to.</p></li> +<li><p><strong>empty</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Indicates whether an empty line should be added to each provided line.</p></li> <li><p><strong>restrict_to_user</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.User" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.User</span></code></a>) – The user to whom interaction with the pages should be restricted.</p></li> -<li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The timeout after which users cannot change pages anymore.</p></li> -<li><p><strong>footer_text</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Text to be added as a footer for each page.</p></li> -<li><p><strong>url</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The url to be set for the pagination embed.</p></li> -<li><p><strong>exception_on_empty_embed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether to raise an exception when no lines are provided.</p></li> -<li><p><strong>reply</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether to send the page as a reply to the context’s message.</p></li> -<li><p><strong>allowed_roles</strong> (<em>Sequence</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – A list of role ids that are allowed to change pages.</p></li> +<li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The timeout after which users cannot change pages anymore.</p></li> +<li><p><strong>footer_text</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Text to be added as a footer for each page.</p></li> +<li><p><strong>url</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The url to be set for the pagination embed.</p></li> +<li><p><strong>exception_on_empty_embed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Indicates whether to raise an exception when no lines are provided.</p></li> +<li><p><strong>reply</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Indicates whether to send the page as a reply to the context’s message.</p></li> +<li><p><strong>allowed_roles</strong> (<em>Sequence</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – A list of role ids that are allowed to change pages.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <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 class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> <p>Example: @@ -756,8 +764,14 @@ to any user with a moderation role.</p> </dd></dl> <dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.PaginationEmojis.__pydantic_computed_fields__"> +<span class="sig-name descname"><span class="pre">__pydantic_computed_fields__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_computed_fields__" title="Link to this definition">¶</a></dt> +<dd><p>A dictionary of computed field names and their corresponding [<cite>ComputedFieldInfo</cite>][pydantic.fields.ComputedFieldInfo] objects.</p> +</dd></dl> + +<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.PaginationEmojis.__pydantic_core_schema__"> -<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PaginationEmojis'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[functools.partial(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis:94045091270064',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'delete':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'<:trashcan:637136429717389331>',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'first':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏮',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'last':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏭',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'left':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⬅',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'right':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'➡',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PaginationEmojis',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PaginationEmojis'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis:94606429014352',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'delete':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'<:trashcan:637136429717389331>',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'first':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏮',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'last':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏭',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'left':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⬅',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'right':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'➡',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PaginationEmojis',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> <dd><p>The core schema of the model.</p> </dd></dl> @@ -781,6 +795,13 @@ This replaces <cite>Model.__validators__</cite> and <cite>Model.__root_validator </dd></dl> <dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.PaginationEmojis.__pydantic_fields__"> +<span class="sig-name descname"><span class="pre">__pydantic_fields__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'delete':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='<:trashcan:637136429717389331>'),</span> <span class="pre">'first':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⏮'),</span> <span class="pre">'last':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⏭'),</span> <span class="pre">'left':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⬅'),</span> <span class="pre">'right':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='➡')}</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_fields__" title="Link to this definition">¶</a></dt> +<dd><p>A dictionary of field names and their corresponding [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects. +This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p> +</dd></dl> + +<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.PaginationEmojis.__pydantic_fields_set__"> <span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_fields_set__" title="Link to this definition">¶</a></dt> <dd><p>The names of fields explicitly set during instantiation.</p> @@ -813,13 +834,13 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.PaginationEmojis.__pydantic_serializer__"> -<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000558894420db0,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"left":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863b79730,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85e1ae380,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"first":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863bf48b0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85e1ae3d0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"delete":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863f60eb0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85e1ae4c0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"right":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863b796f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85e1ae420,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"last":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863bd2270,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85e1ae470,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">5,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_serializer__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000560b46984950,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"left":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb317d870,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdad539700,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"first":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb31f87b0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdad539750,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"last":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb31d61f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdad5397f0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"right":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb317d830,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdad5397a0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"delete":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb350ceb0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdad539840,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">5,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_serializer__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaSerializer</cite> used to dump instances of the model.</p> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.PaginationEmojis.__pydantic_validator__"> -<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PaginationEmojis",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"first",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"first",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd860e2ccb0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"first",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85e82ca30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863bf48b0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd85e1ae3d0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd85ea647c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"left",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"left",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85e82cbf0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"left",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d78cc70,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863b79730,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd85e1ae380,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd85ea647c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"right",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"right",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85d78c430,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"right",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d78ff30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863b796f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd85e1ae420,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd85ea647c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"last",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"last",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85d78ffb0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"last",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d78c9b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863bd2270,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd85e1ae470,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd85ea647c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"delete",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"delete",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85d78c6f0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"delete",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d78df70,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863f60eb0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd85e1ae4c0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd85ea647c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PaginationEmojis",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000558894420db0,</span>         <span class="pre">),</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fd85ea647c0,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_validator__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PaginationEmojis",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"first",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"first",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdadbe5670,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"first",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdb00ccc30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb31f87b0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdad539750,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdadcc45c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"left",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"left",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdadbcb030,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"left",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac1057b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb317d870,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdad539700,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdadcc45c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"right",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"right",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdac1079f0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"right",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac1056b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb317d830,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdad5397a0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdadcc45c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"last",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"last",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdac107f70,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"last",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac107eb0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb31d61f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdad5397f0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdadcc45c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"delete",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"delete",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdac105af0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"delete",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac1058b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb350ceb0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdad539840,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdadcc45c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PaginationEmojis",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000560b46984950,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fbdadcc45c0,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.__pydantic_validator__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaValidator</cite> used to validate instances of the model.</p> </dd></dl> @@ -830,31 +851,17 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b </dd></dl> <dl class="py attribute"> -<dt class="sig sig-object py" id="pydis_core.PaginationEmojis.model_computed_fields"> -<span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.model_computed_fields" title="Link to this definition">¶</a></dt> -<dd><p>A dictionary of computed field names and their corresponding <cite>ComputedFieldInfo</cite> objects.</p> -</dd></dl> - -<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.PaginationEmojis.model_config"> <span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.model_config" title="Link to this definition">¶</a></dt> <dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p> </dd></dl> -<dl class="py attribute"> -<dt class="sig sig-object py" id="pydis_core.PaginationEmojis.model_fields"> -<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'delete':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='<:trashcan:637136429717389331>'),</span> <span class="pre">'first':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⏮'),</span> <span class="pre">'last':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⏭'),</span> <span class="pre">'left':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⬅'),</span> <span class="pre">'right':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='➡')}</span></em><a class="headerlink" href="#pydis_core.PaginationEmojis.model_fields" title="Link to this definition">¶</a></dt> -<dd><p>Metadata about the fields defined on the model, -mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects.</p> -<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p> -</dd></dl> - </dd></dl> <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/07f517225fc59157233f74edb136ee39046fda00/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> -<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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><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__"> @@ -1097,10 +1104,12 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__class_vars__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__class_vars__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__private_attributes__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_complete__</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_computed_fields__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_computed_fields__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_core_schema__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_custom_init__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_decorators__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_extra__</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_fields__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_fields__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_fields_set__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_generic_metadata__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_parent_namespace__</span></code></a></li> @@ -1109,9 +1118,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_serializer__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_validator__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.__signature__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__signature__</span></code></a></li> -<li><a class="reference internal" href="#pydis_core.PaginationEmojis.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.model_computed_fields</span></code></a></li> <li><a class="reference internal" href="#pydis_core.PaginationEmojis.model_config"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.model_config</span></code></a></li> -<li><a class="reference internal" href="#pydis_core.PaginationEmojis.model_fields"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.model_fields</span></code></a></li> </ul> </li> <li><a class="reference internal" href="#pydis_core.StartupError"><code class="docutils literal notranslate"><span class="pre">StartupError</span></code></a><ul> @@ -1132,7 +1139,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.site_api.html b/v10.7.0/output/pydis_core.site_api.html index d79f4537..2b38b33c 100644 --- a/v10.7.0/output/pydis_core.site_api.html +++ b/v10.7.0/output/pydis_core.site_api.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>site_api - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.site_api.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.site_api.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.site_api.html">v11.3.1</a> </li> @@ -450,7 +458,7 @@ <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/07f517225fc59157233f74edb136ee39046fda00/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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><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__"> @@ -459,9 +467,9 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>site_api_url</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The URL of the site API.</p></li> -<li><p><strong>site_api_token</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The token to use for authentication.</p></li> -<li><p><strong>session_kwargs</strong> – Keyword arguments to pass to the <a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientSession</span></code></a> constructor.</p></li> +<li><p><strong>site_api_url</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The URL of the site API.</p></li> +<li><p><strong>site_api_token</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The token to use for authentication.</p></li> +<li><p><strong>session_kwargs</strong> – Keyword arguments to pass to the <a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientSession</span></code></a> constructor.</p></li> </ul> </dd> </dl> @@ -473,7 +481,7 @@ <dd><p>Close the aiohttp session.</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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -484,7 +492,7 @@ <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> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <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 class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -495,7 +503,7 @@ <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> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <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 class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -507,15 +515,15 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>response</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientResponse" title="(in aiohttp v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientResponse</span></code></a>) – The response to check.</p></li> -<li><p><strong>should_raise</strong> (<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>) – Whether or not to raise an exception.</p></li> +<li><p><strong>response</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientResponse" title="(in aiohttp v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientResponse</span></code></a>) – The response to check.</p></li> +<li><p><strong>should_raise</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span>) – Whether or not to raise an exception.</p></li> </ul> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> <dd class="field-even"><p><a class="reference internal" href="#pydis_core.site_api.ResponseCodeError" title="pydis_core.site_api.ResponseCodeError"><strong>ResponseCodeError</strong></a> – If the response is not OK and <code class="docutils literal notranslate"><span class="pre">should_raise</span></code> is True.</p> </dd> <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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -526,7 +534,7 @@ <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> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <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 class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -537,7 +545,7 @@ <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> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <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 class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -548,7 +556,7 @@ <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> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <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 class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -560,17 +568,17 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>method</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The HTTP method to use.</p></li> -<li><p><strong>endpoint</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The endpoint to send the request to.</p></li> -<li><p><strong>raise_for_status</strong> (<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>) – Whether or not to raise an exception if the response is not OK.</p></li> -<li><p><strong>**kwargs</strong> – Any extra keyword arguments to pass to <a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.request" title="(in aiohttp v3.10)"><code class="xref py py-func docutils literal notranslate"><span class="pre">aiohttp.request()</span></code></a>.</p></li> +<li><p><strong>method</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The HTTP method to use.</p></li> +<li><p><strong>endpoint</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The endpoint to send the request to.</p></li> +<li><p><strong>raise_for_status</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span>) – Whether or not to raise an exception if the response is not OK.</p></li> +<li><p><strong>**kwargs</strong> – Any extra keyword arguments to pass to <a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.request" title="(in aiohttp v3.11)"><code class="xref py py-func docutils literal notranslate"><span class="pre">aiohttp.request()</span></code></a>.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <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 class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p>The JSON response the API returns, or <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> if the response code is 204.</p> +<dd class="field-odd"><p>The JSON response the API returns, or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a> if the response code is 204.</p> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> <dd class="field-even"><p><a class="reference internal" href="#pydis_core.site_api.ResponseCodeError" title="pydis_core.site_api.ResponseCodeError"><strong>ResponseCodeError</strong></a> – If the response is not OK and <code class="docutils literal notranslate"><span class="pre">raise_for_status</span></code> is True.</p> @@ -583,7 +591,7 @@ <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/07f517225fc59157233f74edb136ee39046fda00/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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><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__"> @@ -592,9 +600,9 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>response</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientResponse" title="(in aiohttp v3.10)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientResponse</span></code></a>) – The response object from the request.</p></li> -<li><p><strong>response_json</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <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>) – The JSON response returned from the request, if any.</p></li> -<li><p><strong>response_text</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <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>) – The text of the request, if any.</p></li> +<li><p><strong>response</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientResponse" title="(in aiohttp v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">aiohttp.ClientResponse</span></code></a>) – The response object from the request.</p></li> +<li><p><strong>response_json</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The JSON response returned from the request, if any.</p></li> +<li><p><strong>response_text</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The text of the request, if any.</p></li> </ul> </dd> </dl> @@ -695,7 +703,7 @@ </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.caching.html b/v10.7.0/output/pydis_core.utils.caching.html index 75d34c2d..af38b3e4 100644 --- a/v10.7.0/output/pydis_core.utils.caching.html +++ b/v10.7.0/output/pydis_core.utils.caching.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="channel" href="pydis_core.utils.channel.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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>caching - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.caching.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.caching.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.caching.html">v11.3.1</a> </li> @@ -450,7 +458,7 @@ <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/07f517225fc59157233f74edb136ee39046fda00/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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><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> @@ -460,10 +468,10 @@ <dd><p>Decorator for async cache.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>arg_offset</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The offset for the position of the key argument.</p> +<dd class="field-odd"><p><strong>arg_offset</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The offset for the position of the key argument.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a></span></p> +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a></span></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>A decorator to wrap the target function.</p> @@ -477,7 +485,7 @@ <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> -<dd class="field-odd"><p><strong>max_size</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – How many items to store in the cache.</p> +<dd class="field-odd"><p><strong>max_size</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – How many items to store in the cache.</p> </dd> </dl> </dd></dl> @@ -488,7 +496,7 @@ <dd><p>Clear cache instance.</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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -571,7 +579,7 @@ </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.channel.html b/v10.7.0/output/pydis_core.utils.channel.html index a865832b..f5c0e64e 100644 --- a/v10.7.0/output/pydis_core.utils.channel.html +++ b/v10.7.0/output/pydis_core.utils.channel.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>channel - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.channel.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.channel.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.channel.html">v11.3.1</a> </li> @@ -455,7 +463,7 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>bot</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bot</span></code></a></span>) – The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Bot" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Bot</span></code></a> instance to use for getting/fetching.</p></li> -<li><p><strong>channel_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The channel to get/fetch.</p></li> +<li><p><strong>channel_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The channel to get/fetch.</p></li> </ul> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> @@ -483,11 +491,11 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.TextChannel" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextChannel</span></code></a></span>) – The channel to check.</p></li> -<li><p><strong>category_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The category to check for.</p></li> +<li><p><strong>category_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The category to check for.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>A bool depending on whether the channel is in the category.</p> @@ -567,7 +575,7 @@ </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.checks.html b/v10.7.0/output/pydis_core.utils.checks.html index e4745a9e..8e27bed3 100644 --- a/v10.7.0/output/pydis_core.utils.checks.html +++ b/v10.7.0/output/pydis_core.utils.checks.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="commands" href="pydis_core.utils.commands.html" /><link rel="prev" title="channel" href="pydis_core.utils.channel.html" /> - <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>checks - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.checks.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.checks.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.checks.html">v11.3.1</a> </li> @@ -473,10 +481,10 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>rate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – Number of times a command can be used before triggering a cooldown.</p></li> -<li><p><strong>per</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – The duration (in seconds) for how long the cooldown lasts.</p></li> +<li><p><strong>rate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Number of times a command can be used before triggering a cooldown.</p></li> +<li><p><strong>per</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – The duration (in seconds) for how long the cooldown lasts.</p></li> <li><p><strong>type</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.BucketType" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.BucketType</span></code></a>) – The type of cooldown (per user, per channel, per guild, etc.).</p></li> -<li><p><strong>bypass_roles</strong> (<em>Iterable</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – An iterable of role IDs that bypass the cooldown.</p></li> +<li><p><strong>bypass_roles</strong> (<em>Iterable</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – An iterable of role IDs that bypass the cooldown.</p></li> </ul> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> @@ -486,7 +494,7 @@ <dd class="field-odd"><p>Callable</p> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> -<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.12)"><strong>TypeError</strong></a> – If the decorator is not applied to an instance of <cite>Command</cite>.</p> +<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.13)"><strong>TypeError</strong></a> – If the decorator is not applied to an instance of <cite>Command</cite>.</p> </dd> </dl> </dd></dl> @@ -500,14 +508,14 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context where the command is being invoked.</p></li> -<li><p><strong>roles</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) – A collection of role IDs.</p></li> +<li><p><strong>roles</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) – A collection of role IDs.</p></li> </ul> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>True if the context’s author has at least one of the specified roles; False otherwise.</p> </dd> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)">bool</a></p> </dd> </dl> </dd></dl> @@ -521,14 +529,14 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context where the command is being invoked.</p></li> -<li><p><strong>roles</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) – A collection of role IDs.</p></li> +<li><p><strong>roles</strong> (<em>Union</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em><em>, </em><em>...</em>) – A collection of role IDs.</p></li> </ul> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>True if the context’s author doesn’t have any of the specified roles; False otherwise.</p> </dd> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)">bool</a></p> </dd> </dl> </dd></dl> @@ -541,18 +549,18 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context in which the command is being invoked.</p></li> -<li><p><strong>redirect</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em> | </em><em>None</em>) – The channel ID to redirect the user to, if any.</p></li> -<li><p><strong>channels</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – Whitelisted channel IDs. Defaults to ().</p></li> -<li><p><strong>categories</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – Whitelisted category IDs. Defaults to ().</p></li> -<li><p><strong>roles</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – Whitelisted role IDs. Defaults to ().</p></li> -<li><p><strong>fail_silently</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Whether to fail silently without raising an exception. Defaults to False.</p></li> +<li><p><strong>redirect</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em> | </em><em>None</em>) – The channel ID to redirect the user to, if any.</p></li> +<li><p><strong>channels</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – Whitelisted channel IDs. Defaults to ().</p></li> +<li><p><strong>categories</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – Whitelisted category IDs. Defaults to ().</p></li> +<li><p><strong>roles</strong> (<em>Container</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – Whitelisted role IDs. Defaults to ().</p></li> +<li><p><strong>fail_silently</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Whether to fail silently without raising an exception. Defaults to False.</p></li> </ul> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>True if the command is used in a whitelisted context; False otherwise.</p> </dd> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)">bool</a></p> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> <dd class="field-even"><p><a class="reference internal" href="#pydis_core.utils.checks.InWhitelistCheckFailure" title="pydis_core.utils.checks.InWhitelistCheckFailure"><strong>InWhitelistCheckFailure</strong></a> – If the context is not whitelisted and <cite>fail_silently</cite> is False.</p> @@ -639,7 +647,7 @@ </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.commands.html b/v10.7.0/output/pydis_core.utils.commands.html index daf6bad6..99ec34d5 100644 --- a/v10.7.0/output/pydis_core.utils.commands.html +++ b/v10.7.0/output/pydis_core.utils.commands.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>commands - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.commands.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.commands.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.commands.html">v11.3.1</a> </li> @@ -454,14 +462,14 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>ctx</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Context</span></code></a></span>) – The command’s context</p></li> -<li><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <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>) – The provided text argument of the command (if given)</p></li> +<li><p><strong>text</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The provided text argument of the command (if given)</p></li> </ul> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> <dd class="field-even"><p><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.BadArgument" title="(in discord.py v2.5.0a)"><strong>discord.ext.commands.BadArgument</strong></a> – <cite>text</cite> wasn’t provided and there’s no reply message / reply message content.</p> </dd> <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/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></p> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></p> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>The cleaned version of <cite>text</cite>, if given, else replied message.</p> @@ -540,7 +548,7 @@ </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.cooldown.html b/v10.7.0/output/pydis_core.utils.cooldown.html index 7b8f55b9..b6515a1f 100644 --- a/v10.7.0/output/pydis_core.utils.cooldown.html +++ b/v10.7.0/output/pydis_core.utils.cooldown.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="error_handling" href="pydis_core.utils.error_handling.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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>cooldown - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.cooldown.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.cooldown.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.cooldown.html">v11.3.1</a> </li> @@ -450,7 +458,7 @@ <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/07f517225fc59157233f74edb136ee39046fda00/pydis_core/utils/cooldown.py#L38-L62"><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.5.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> +<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.5.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.13)"><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__"> @@ -463,7 +471,7 @@ <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> -<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.TypeVar" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">R</span></code>)</span></p> +<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.TypeVar" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">R</span></code>)</span></p> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>The command’s return value.</p> @@ -493,14 +501,14 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>cooldown_duration</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></span>) – Length of the cooldown in seconds.</p></li> -<li><p><strong>send_notice</strong> (<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>) – If <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>, notify the user about the cooldown with a reply.</p></li> -<li><p><strong>args_preprocessor</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>[<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>]] | <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>) – If specified, this function is called with the args and kwargs the function is called with, +<li><p><strong>cooldown_duration</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></span>) – Length of the cooldown in seconds.</p></li> +<li><p><strong>send_notice</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span>) – If <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a>, notify the user about the cooldown with a reply.</p></li> +<li><p><strong>args_preprocessor</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a>]] | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – If specified, this function is called with the args and kwargs the function is called with, its return value is then used to check for the cooldown instead of the raw arguments.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Awaitable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">R</span></code>)]]], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Awaitable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">R</span></code>)]]]</span></p> +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Awaitable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">R</span></code>)]]], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Awaitable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">R</span></code>)]]]</span></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>A decorator that adds a wrapper which applies the cooldowns.</p> @@ -590,7 +598,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=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.error_handling.html b/v10.7.0/output/pydis_core.utils.error_handling.html index c716d6d8..66299cba 100644 --- a/v10.7.0/output/pydis_core.utils.error_handling.html +++ b/v10.7.0/output/pydis_core.utils.error_handling.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="function" href="pydis_core.utils.function.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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>error_handling - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.error_handling.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.error_handling.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.error_handling.html">v11.3.1</a> </li> @@ -454,11 +462,11 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>error</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Forbidden" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Forbidden</span></code></a></span>) – The raised <code class="docutils literal notranslate"><span class="pre">discord.Forbidden</span></code> to check.</p></li> -<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <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>) – The message to reply to and include in logs, if error is 90001 and message is provided.</p></li> +<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The message to reply to and include in logs, if error is 90001 and message is provided.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -534,7 +542,7 @@ </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.function.html b/v10.7.0/output/pydis_core.utils.function.html index cf1220ad..0d07ff55 100644 --- a/v10.7.0/output/pydis_core.utils.function.html +++ b/v10.7.0/output/pydis_core.utils.function.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="interactions" href="pydis_core.utils.interactions.html" /><link rel="prev" title="error_handling" 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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>function - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.function.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.function.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.function.html">v11.3.1</a> </li> @@ -450,7 +458,7 @@ <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/07f517225fc59157233f74edb136ee39046fda00/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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><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> @@ -462,17 +470,17 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>wrapped</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]</span>) – The function to wrap with.</p></li> -<li><p><strong>assigned</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – Sequence of attribute names that are directly assigned from <code class="docutils literal notranslate"><span class="pre">wrapped</span></code> to <code class="docutils literal notranslate"><span class="pre">wrapper</span></code>.</p></li> -<li><p><strong>updated</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – Sequence of attribute names that are <code class="docutils literal notranslate"><span class="pre">.update``d</span> <span class="pre">on</span> <span class="pre">``wrapper</span></code> from the attributes on <code class="docutils literal notranslate"><span class="pre">wrapped</span></code>.</p></li> -<li><p><strong>ignored_conflict_names</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – A set of names to ignore if a conflict between them is found.</p></li> +<li><p><strong>wrapped</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]</span>) – The function to wrap with.</p></li> +<li><p><strong>assigned</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – Sequence of attribute names that are directly assigned from <code class="docutils literal notranslate"><span class="pre">wrapped</span></code> to <code class="docutils literal notranslate"><span class="pre">wrapper</span></code>.</p></li> +<li><p><strong>updated</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – Sequence of attribute names that are <code class="docutils literal notranslate"><span class="pre">.update``d</span> <span class="pre">on</span> <span class="pre">``wrapper</span></code> from the attributes on <code class="docutils literal notranslate"><span class="pre">wrapped</span></code>.</p></li> +<li><p><strong>ignored_conflict_names</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Set" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – A set of names to ignore if a conflict between them is found.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]]</span></p> +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]]</span></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p>A decorator that behaves like <a class="reference external" href="https://docs.python.org/3/library/functools.html#functools.wraps" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">functools.wraps()</span></code></a>, +<dd class="field-odd"><p>A decorator that behaves like <a class="reference external" href="https://docs.python.org/3/library/functools.html#functools.wraps" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">functools.wraps()</span></code></a>, with the wrapper replaced with the function <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> returned.</p> </dd> </dl> @@ -484,18 +492,18 @@ with the wrapper replaced with the function <a class="reference internal" href=" <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> -<dd class="field-odd"><p><strong>arguments</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.OrderedDict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedDict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</span>) – An ordered mapping of parameter names to argument values.</p> +<dd class="field-odd"><p><strong>arguments</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.OrderedDict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedDict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</span>) – An ordered mapping of parameter names to argument values.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a></span></p> +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a></span></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>Value from <cite>arguments</cite> based on a name or position.</p> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> <dd class="field-even"><ul class="simple"> -<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.12)"><strong>TypeError</strong></a> – <cite>name_or_pos</cite> isn’t a str or int.</p></li> -<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><strong>ValueError</strong></a> – <cite>name_or_pos</cite> does not match any argument.</p></li> +<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.13)"><strong>TypeError</strong></a> – <cite>name_or_pos</cite> isn’t a str or int.</p></li> +<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – <cite>name_or_pos</cite> does not match any argument.</p></li> </ul> </dd> </dl> @@ -508,14 +516,14 @@ with the wrapper replaced with the function <a class="reference internal" href=" <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>decorator_func</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.OrderedDict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedDict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>]]</span>) – A function that must accept a callable as a parameter to which it will pass a mapping of +<li><p><strong>decorator_func</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.OrderedDict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedDict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>]]</span>) – A function that must accept a callable as a parameter to which it will pass a mapping of parameter names to argument values of the function it’s decorating.</p></li> -<li><p><strong>name_or_pos</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name/position of the arg to get the value from.</p></li> -<li><p><strong>func</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]]</span>) – An optional callable which will return a new value given the argument’s value.</p></li> +<li><p><strong>name_or_pos</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name/position of the arg to get the value from.</p></li> +<li><p><strong>func</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]]</span>) – An optional callable which will return a new value given the argument’s value.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>]</span></p> +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>]</span></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>The decorator returned by <cite>decorator_func</cite>.</p> @@ -531,13 +539,13 @@ parameter names to argument values of the function it’s decorating.</p></li> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>args</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></span>) – The arguments to bind to <code class="docutils literal notranslate"><span class="pre">func</span></code></p></li> -<li><p><strong>kwargs</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</span>) – The keyword arguments to bind to <code class="docutils literal notranslate"><span class="pre">func</span></code></p></li> -<li><p><strong>func</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a></span>) – The function to bind <code class="docutils literal notranslate"><span class="pre">args</span></code> and <code class="docutils literal notranslate"><span class="pre">kwargs</span></code> to</p></li> +<li><p><strong>args</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></span>) – The arguments to bind to <code class="docutils literal notranslate"><span class="pre">func</span></code></p></li> +<li><p><strong>kwargs</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</span>) – The keyword arguments to bind to <code class="docutils literal notranslate"><span class="pre">func</span></code></p></li> +<li><p><strong>func</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a></span>) – The function to bind <code class="docutils literal notranslate"><span class="pre">args</span></code> and <code class="docutils literal notranslate"><span class="pre">kwargs</span></code> to</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.OrderedDict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedDict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</span></p> +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.OrderedDict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedDict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</span></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>A mapping of parameter names to argument values.</p> @@ -560,9 +568,9 @@ changes won’t be reflected in the new function’s globals.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>wrapper</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]</span>) – The function to wrap.</p></li> -<li><p><strong>wrapped</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]</span>) – The function to wrap with.</p></li> -<li><p><strong>ignored_conflict_names</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Set" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – A set of names to ignore if a conflict between them is found.</p></li> +<li><p><strong>wrapper</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]</span>) – The function to wrap.</p></li> +<li><p><strong>wrapped</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]</span>) – The function to wrap with.</p></li> +<li><p><strong>ignored_conflict_names</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Set" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Set</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – A set of names to ignore if a conflict between them is found.</p></li> </ul> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> @@ -570,7 +578,7 @@ changes won’t be reflected in the new function’s globals.</p> and is not in <code class="docutils literal notranslate"><span class="pre">ignored_conflict_names</span></code>.</p> </dd> <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/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]</span></p> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.ParamSpec" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ParamSpec</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_P</span></code>)], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">_R</span></code>)]</span></p> </dd> </dl> </dd></dl> @@ -651,7 +659,7 @@ changes won’t be reflected in the new function’s globals.</p> </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.html b/v10.7.0/output/pydis_core.utils.html index 6fde6635..7d98eed6 100644 --- a/v10.7.0/output/pydis_core.utils.html +++ b/v10.7.0/output/pydis_core.utils.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="caching" href="pydis_core.utils.caching.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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>Utils - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.html">v11.3.1</a> </li> @@ -453,7 +461,7 @@ <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> <dl> @@ -472,10 +480,10 @@ that will act as top-level groups rather than being aliases of the command’s g <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> -<dd class="field-odd"><p><strong>name</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The module name to unqualify.</p> +<dd class="field-odd"><p><strong>name</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The module name to unqualify.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></p> +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>The unqualified module name.</p> @@ -605,10 +613,12 @@ that will act as top-level groups rather than being aliases of the command’s g <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__class_vars__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__class_vars__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__private_attributes__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_complete__</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_computed_fields__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_computed_fields__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_core_schema__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_custom_init__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_decorators__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_extra__</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_fields__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_fields_set__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_generic_metadata__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_parent_namespace__</span></code></a></li> @@ -617,9 +627,7 @@ that will act as top-level groups rather than being aliases of the command’s g <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_serializer__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_validator__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.__signature__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__signature__</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.model_computed_fields</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.model_config"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.model_config</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.pagination.html#pydis_core.utils.pagination.PaginationEmojis.model_fields"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.model_fields</span></code></a></li> </ul> </li> </ul> @@ -630,10 +638,12 @@ that will act as top-level groups rather than being aliases of the command’s g <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__class_vars__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__class_vars__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__private_attributes__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_complete__</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_computed_fields__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_computed_fields__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_core_schema__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_custom_init__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_decorators__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_extra__</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_fields__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_fields__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_fields_set__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_generic_metadata__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_parent_namespace__</span></code></a></li> @@ -642,19 +652,19 @@ that will act as top-level groups rather than being aliases of the command’s g <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_serializer__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_validator__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.__signature__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__signature__</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">PasteFile.model_computed_fields</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.model_config"><code class="docutils literal notranslate"><span class="pre">PasteFile.model_config</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteFile.model_fields"><code class="docutils literal notranslate"><span class="pre">PasteFile.model_fields</span></code></a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse"><code class="docutils literal notranslate"><span class="pre">PasteResponse</span></code></a><ul> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__class_vars__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__class_vars__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__private_attributes__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_complete__</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_computed_fields__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_computed_fields__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_core_schema__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_custom_init__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_decorators__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_extra__</span></code></a></li> +<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_fields__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_fields__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_fields_set__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_generic_metadata__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_parent_namespace__</span></code></a></li> @@ -663,9 +673,7 @@ that will act as top-level groups rather than being aliases of the command’s g <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_serializer__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_validator__</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.__signature__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__signature__</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">PasteResponse.model_computed_fields</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.model_config"><code class="docutils literal notranslate"><span class="pre">PasteResponse.model_config</span></code></a></li> -<li class="toctree-l3"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteResponse.model_fields"><code class="docutils literal notranslate"><span class="pre">PasteResponse.model_fields</span></code></a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="pydis_core.utils.paste_service.html#pydis_core.utils.paste_service.PasteTooLongError"><code class="docutils literal notranslate"><span class="pre">PasteTooLongError</span></code></a></li> @@ -770,7 +778,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=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.interactions.html b/v10.7.0/output/pydis_core.utils.interactions.html index 4b237dde..42102457 100644 --- a/v10.7.0/output/pydis_core.utils.interactions.html +++ b/v10.7.0/output/pydis_core.utils.interactions.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>interactions - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.interactions.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.interactions.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.interactions.html">v11.3.1</a> </li> @@ -457,7 +465,7 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>style</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.ButtonStyle"><code class="docutils literal notranslate"><span class="pre">ButtonStyle</span></code></a>) – The style of the button, set to <code class="docutils literal notranslate"><span class="pre">ButtonStyle.secondary</span></code> if not specified.</p></li> -<li><p><strong>label</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The label of the button, set to “Delete” if not specified.</p></li> +<li><p><strong>label</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The label of the button, set to “Delete” if not specified.</p></li> </ul> </dd> </dl> @@ -472,7 +480,7 @@ <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -487,11 +495,11 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>allowed_users</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of user’s ids who are allowed to interact with the view.</p></li> -<li><p><strong>allowed_roles</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of role ids that are allowed to interact with the view.</p></li> -<li><p><strong>timeout</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a> | <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>) – Timeout in seconds from last interaction with the UI before no longer accepting input. +<li><p><strong>allowed_users</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of user’s ids who are allowed to interact with the view.</p></li> +<li><p><strong>allowed_roles</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of role ids that are allowed to interact with the view.</p></li> +<li><p><strong>timeout</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – Timeout in seconds from last interaction with the UI before no longer accepting input. If <code class="docutils literal notranslate"><span class="pre">None</span></code> then there is no timeout.</p></li> -<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <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>) – The message to remove the view from on timeout. This can also be set with +<li><p><strong>message</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The message to remove the view from on timeout. This can also be set with <code class="docutils literal notranslate"><span class="pre">view.message</span> <span class="pre">=</span> <span class="pre">await</span> <span class="pre">ctx.send(</span> <span class="pre">...</span> <span class="pre">)`</span></code> , or similar, after the view is instantiated.</p></li> </ul> </dd> @@ -510,7 +518,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <dd class="field-odd"><p><strong>interaction</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/interactions/api.html#discord.Interaction" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Interaction</span></code></a></span>) – The interaction that occurred.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -521,7 +529,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -532,7 +540,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -547,12 +555,12 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>user</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.User" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">User</span></code></a> | <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a></span>) – The user to check</p></li> -<li><p><strong>allowed_users</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of user ids that are allowed access</p></li> -<li><p><strong>allowed_roles</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of role ids that are allowed access</p></li> +<li><p><strong>allowed_users</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of user ids that are allowed access</p></li> +<li><p><strong>allowed_roles</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</span>) – A sequence of role ids that are allowed access</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -640,7 +648,7 @@ If <code class="docutils literal notranslate"><span class="pre">None</span></cod </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.lock.html b/v10.7.0/output/pydis_core.utils.lock.html index f4491678..9cc9c074 100644 --- a/v10.7.0/output/pydis_core.utils.lock.html +++ b/v10.7.0/output/pydis_core.utils.lock.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>lock - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.lock.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.lock.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.lock.html">v11.3.1</a> </li> @@ -449,7 +457,7 @@ <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/07f517225fc59157233f74edb136ee39046fda00/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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.13)"><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"> @@ -457,7 +465,7 @@ <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> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a></p> </dd> </dl> </dd></dl> @@ -468,7 +476,7 @@ <dd><p>ID of the locked resource</p> <dl class="field-list simple"> <dt class="field-odd">Type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Hashable" title="(in Python v3.12)"><em>Hashable</em></a></p> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Hashable" title="(in Python v3.13)"><em>Hashable</em></a></p> </dd> </dl> </dd></dl> @@ -483,7 +491,7 @@ <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/07f517225fc59157233f74edb136ee39046fda00/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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><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> @@ -510,7 +518,7 @@ when all of the holders finish the event will be set.</p> <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> -<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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -525,12 +533,12 @@ when all of the holders finish the event will be set.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>namespace</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Hashable" title="(in Python v3.12)"><em>Hashable</em></a>) – An identifier used to prevent collisions among resource IDs.</p></li> -<li><p><strong>resource_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.OrderedDict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedDict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Awaitable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>]]</span>) – identifies a resource on which to perform a mutually exclusive operation. +<li><p><strong>namespace</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Hashable" title="(in Python v3.13)"><em>Hashable</em></a>) – An identifier used to prevent collisions among resource IDs.</p></li> +<li><p><strong>resource_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.OrderedDict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedDict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Awaitable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>]]</span>) – identifies a resource on which to perform a mutually exclusive operation. It may also be a callable or awaitable which will return the resource ID given an ordered mapping of the parameters’ names to arguments’ values.</p></li> -<li><p><strong>raise_error</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If True, raise <cite>LockedResourceError</cite> if the lock cannot be acquired.</p></li> -<li><p><strong>wait</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If True, wait until the lock becomes available. Otherwise, if any other mutually +<li><p><strong>raise_error</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – If True, raise <cite>LockedResourceError</cite> if the lock cannot be acquired.</p></li> +<li><p><strong>wait</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – If True, wait until the lock becomes available. Otherwise, if any other mutually exclusive function currently holds the lock for a resource, do not run the decorated function and return None.</p></li> </ul> @@ -539,7 +547,7 @@ and return None.</p></li> <dd class="field-even"><p><a class="reference internal" href="#pydis_core.utils.lock.LockedResourceError" title="pydis_core.utils.lock.LockedResourceError"><strong>LockedResourceError</strong></a> – If the lock can’t be acquired and <cite>raise_error</cite> is set to True.</p> </dd> <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/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a></span></p> +<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -551,10 +559,10 @@ and return None.</p></li> <p>See <cite>lock</cite> docs for more information.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> -<dd class="field-odd"><p><strong>func</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Awaitable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>]] | <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>) – An optional callable or awaitable which will return the ID given the argument value.</p> +<dd class="field-odd"><p><strong>func</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Awaitable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Awaitable</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a>]] | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – An optional callable or awaitable which will return the ID given the argument value.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a></span></p> +<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -644,7 +652,7 @@ and return None.</p></li> </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.logging.html b/v10.7.0/output/pydis_core.utils.logging.html index 1e6b0f9d..ce966395 100644 --- a/v10.7.0/output/pydis_core.utils.logging.html +++ b/v10.7.0/output/pydis_core.utils.logging.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>logging - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.logging.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.logging.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.logging.html">v11.3.1</a> </li> @@ -450,8 +458,8 @@ <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/07f517225fc59157233f74edb136ee39046fda00/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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.13)"><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.13)"><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/07f517225fc59157233f74edb136ee39046fda00/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> @@ -463,13 +471,13 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>msg</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The message to be logged.</p></li> +<li><p><strong>msg</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The message to be logged.</p></li> <li><p><strong>args</strong> – Passed to the base log function as is.</p></li> <li><p><strong>kwargs</strong> – Passed to the base log function as is.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -482,7 +490,7 @@ <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> -<dd class="field-odd"><p><strong>name</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <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>) – The name given to the logger.</p> +<dd class="field-odd"><p><strong>name</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span>) – The name given to the logger.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> <dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#pydis_core.utils.logging.CustomLogger" title="pydis_core.utils.logging.CustomLogger"><code class="xref py py-class docutils literal notranslate"><span class="pre">CustomLogger</span></code></a></span></p> @@ -496,7 +504,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/07f517225fc59157233f74edb136ee39046fda00/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> +<dd><p>A <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Formatter" title="(in Python v3.13)"><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> </dd></dl> @@ -577,7 +585,7 @@ </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.members.html b/v10.7.0/output/pydis_core.utils.members.html index efed4c4e..b65dd7bc 100644 --- a/v10.7.0/output/pydis_core.utils.members.html +++ b/v10.7.0/output/pydis_core.utils.members.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>members - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.members.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.members.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.members.html">v11.3.1</a> </li> @@ -453,10 +461,10 @@ <dd><p>Attempt to get a member from cache; on failure fetch from the API.</p> <dl class="field-list simple"> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a> | <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 class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> -<dd class="field-even"><p>The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a> to indicate the member could not be found.</p> +<dd class="field-even"><p>The <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a> to indicate the member could not be found.</p> </dd> </dl> </dd></dl> @@ -471,12 +479,12 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>member</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Member</span></code></a></span>) – The member that is being modified for logging purposes.</p></li> -<li><p><strong>coro</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>]</span>) – This is intended to be <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> or <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p></li> +<li><p><strong>coro</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code></a>[[<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>]</span>) – This is intended to be <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.add_roles" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.add_roles</span></code></a> or <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Member.remove_roles" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Member.remove_roles</span></code></a>.</p></li> <li><p><strong>role</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Role" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Role</span></code></a></span>) – The role to be passed to <code class="docutils literal notranslate"><span class="pre">coro</span></code>.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -553,7 +561,7 @@ </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.messages.html b/v10.7.0/output/pydis_core.utils.messages.html index 337ed3e8..37b5b667 100644 --- a/v10.7.0/output/pydis_core.utils.messages.html +++ b/v10.7.0/output/pydis_core.utils.messages.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>messages - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.messages.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.messages.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.messages.html">v11.3.1</a> </li> @@ -454,7 +462,7 @@ If <cite>allow_mods</cite> is True, allow users with moderator roles even if they’re not in <cite>allowed_users</cite>.</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 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -530,7 +538,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=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.pagination.html b/v10.7.0/output/pydis_core.utils.pagination.html index 01450c48..20ef8605 100644 --- a/v10.7.0/output/pydis_core.utils.pagination.html +++ b/v10.7.0/output/pydis_core.utils.pagination.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>pagination - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.pagination.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.pagination.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.pagination.html">v11.3.1</a> </li> @@ -449,7 +457,7 @@ <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/07f517225fc59157233f74edb136ee39046fda00/pydis_core/utils/pagination.py#L27-L29"><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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><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> @@ -462,11 +470,11 @@ <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>pagination_emojis</strong> (<a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis" title="pydis_core.utils.pagination.PaginationEmojis"><em>PaginationEmojis</em></a>) – The emojis used to navigate pages.</p></li> -<li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The prefix inserted to every page. e.g. three backticks.</p></li> -<li><p><strong>suffix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The suffix appended at the end of every page. e.g. three backticks.</p></li> -<li><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of codepoints allowed in a page.</p></li> -<li><p><strong>scale_to_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of characters a single line can scale up to.</p></li> -<li><p><strong>max_lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of lines allowed in a page.</p></li> +<li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The prefix inserted to every page. e.g. three backticks.</p></li> +<li><p><strong>suffix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The suffix appended at the end of every page. e.g. three backticks.</p></li> +<li><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of codepoints allowed in a page.</p></li> +<li><p><strong>scale_to_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of characters a single line can scale up to.</p></li> +<li><p><strong>max_lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of lines allowed in a page.</p></li> </ul> </dd> </dl> @@ -495,12 +503,12 @@ page at a reasonable size.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The line to add to the paginated content.</p></li> -<li><p><strong>empty</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether an empty line should be added at the end.</p></li> +<li><p><strong>line</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The line to add to the paginated content.</p></li> +<li><p><strong>empty</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Indicates whether an empty line should be added at the end.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -519,26 +527,26 @@ to any user with a moderation role.</p> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>pagination_emojis</strong> (<a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis" title="pydis_core.utils.pagination.PaginationEmojis"><em>PaginationEmojis</em></a>) – The emojis used to navigate pages.</p></li> -<li><p><strong>lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>]</em>) – A list of lines to be added to the paginated content.</p></li> +<li><p><strong>lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>]</em>) – A list of lines to be added to the paginated content.</p></li> <li><p><strong>ctx</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Context" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.ext.commands.Context</span></code></a>) – The context in which the pagination is needed.</p></li> <li><p><strong>embed</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Embed" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.Embed</span></code></a>) – The embed that holds the content, it serves as the page.</p></li> -<li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The prefix inserted to every page. e.g. three backticks.</p></li> -<li><p><strong>suffix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The suffix appended at the end of every page. e.g. three backticks.</p></li> -<li><p><strong>max_lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of lines allowed in a page.</p></li> -<li><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of codepoints allowed in a page.</p></li> -<li><p><strong>scale_to_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The maximum amount of characters a single line can scale up to.</p></li> -<li><p><strong>empty</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether an empty line should be added to each provided line.</p></li> +<li><p><strong>prefix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The prefix inserted to every page. e.g. three backticks.</p></li> +<li><p><strong>suffix</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The suffix appended at the end of every page. e.g. three backticks.</p></li> +<li><p><strong>max_lines</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of lines allowed in a page.</p></li> +<li><p><strong>max_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of codepoints allowed in a page.</p></li> +<li><p><strong>scale_to_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The maximum amount of characters a single line can scale up to.</p></li> +<li><p><strong>empty</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Indicates whether an empty line should be added to each provided line.</p></li> <li><p><strong>restrict_to_user</strong> (<a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.User" title="(in discord.py v2.5.0a)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">discord.User</span></code></a>) – The user to whom interaction with the pages should be restricted.</p></li> -<li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The timeout after which users cannot change pages anymore.</p></li> -<li><p><strong>footer_text</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – Text to be added as a footer for each page.</p></li> -<li><p><strong>url</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The url to be set for the pagination embed.</p></li> -<li><p><strong>exception_on_empty_embed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether to raise an exception when no lines are provided.</p></li> -<li><p><strong>reply</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – Indicates whether to send the page as a reply to the context’s message.</p></li> -<li><p><strong>allowed_roles</strong> (<em>Sequence</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a><em>]</em>) – A list of role ids that are allowed to change pages.</p></li> +<li><p><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The timeout after which users cannot change pages anymore.</p></li> +<li><p><strong>footer_text</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Text to be added as a footer for each page.</p></li> +<li><p><strong>url</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The url to be set for the pagination embed.</p></li> +<li><p><strong>exception_on_empty_embed</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Indicates whether to raise an exception when no lines are provided.</p></li> +<li><p><strong>reply</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Indicates whether to send the page as a reply to the context’s message.</p></li> +<li><p><strong>allowed_roles</strong> (<em>Sequence</em><em>[</em><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>]</em>) – A list of role ids that are allowed to change pages.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <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 class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://discordpy.readthedocs.io/en/latest/api.html#discord.Message" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> <p>Example: @@ -573,8 +581,14 @@ to any user with a moderation role.</p> </dd></dl> <dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_computed_fields__"> +<span class="sig-name descname"><span class="pre">__pydantic_computed_fields__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_computed_fields__" title="Link to this definition">¶</a></dt> +<dd><p>A dictionary of computed field names and their corresponding [<cite>ComputedFieldInfo</cite>][pydantic.fields.ComputedFieldInfo] objects.</p> +</dd></dl> + +<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_core_schema__"> -<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PaginationEmojis'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[functools.partial(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis:94045090733312',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'delete':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'<:trashcan:637136429717389331>',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'first':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏮',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'last':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏭',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'left':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⬅',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'right':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'➡',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PaginationEmojis',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PaginationEmojis'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.pagination.PaginationEmojis:94606428967872',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'delete':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'<:trashcan:637136429717389331>',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'first':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏮',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'last':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⏭',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'left':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'⬅',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'right':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'➡',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PaginationEmojis',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> <dd><p>The core schema of the model.</p> </dd></dl> @@ -598,6 +612,13 @@ This replaces <cite>Model.__validators__</cite> and <cite>Model.__root_validator </dd></dl> <dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields__"> +<span class="sig-name descname"><span class="pre">__pydantic_fields__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'delete':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='<:trashcan:637136429717389331>'),</span> <span class="pre">'first':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⏮'),</span> <span class="pre">'last':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⏭'),</span> <span class="pre">'left':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⬅'),</span> <span class="pre">'right':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='➡')}</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields__" title="Link to this definition">¶</a></dt> +<dd><p>A dictionary of field names and their corresponding [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects. +This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p> +</dd></dl> + +<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields_set__"> <span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields_set__" title="Link to this definition">¶</a></dt> <dd><p>The names of fields explicitly set during instantiation.</p> @@ -630,13 +651,13 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_serializer__"> -<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055889439dd00,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"left":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863b79730,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85e3afeb0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"last":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863bd2270,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85e3affa0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"delete":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863f60eb0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85e3b8030,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"first":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863bf48b0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85e3aff00,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"right":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863b796f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85e3aff50,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">5,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_serializer__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000560b469793c0,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"first":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb31f87b0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdad73b9b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"right":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb317d830,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdad73ba00,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"last":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb31d61f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdad73ba50,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"left":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb317d870,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdad73b960,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"delete":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb350ceb0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdad73baa0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">5,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_serializer__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaSerializer</cite> used to dump instances of the model.</p> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_validator__"> -<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PaginationEmojis",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"first",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"first",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd860e2ccb0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"first",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85c9726f0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863bf48b0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd85e3aff00,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd86271e580,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"left",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"left",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85ebc3fb0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"left",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d99cbf0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863b79730,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd85e3afeb0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd86271e580,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"right",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"right",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85d99c3b0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"right",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d99ff30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863b796f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd85e3aff50,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd86271e580,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"last",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"last",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85d99ffb0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"last",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d99cab0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863bd2270,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd85e3affa0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd86271e580,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"delete",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"delete",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85d99c670,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"delete",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d99deb0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863f60eb0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd85e3b8030,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd86271e580,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PaginationEmojis",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055889439dd00,</span>         <span class="pre">),</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fd86271e580,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_validator__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PaginationEmojis",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"first",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"first",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdadc74870,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"first",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdb00ccc30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb31f87b0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdad73b9b0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdb19d23c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"left",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"left",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdadc628f0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"left",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdaffc38f0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb317d870,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdad73b960,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdb19d23c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"right",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"right",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdac36d7f0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"right",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac36fa30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb317d830,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdad73ba00,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdb19d23c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"last",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"last",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdac36d6f0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"last",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac36ff70,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb31d61f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdad73ba50,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdb19d23c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"delete",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"delete",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdac36db30,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"delete",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac36d8f0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb350ceb0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdad73baa0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdb19d23c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PaginationEmojis",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000560b469793c0,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fbdb19d23c0,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PaginationEmojis",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_validator__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaValidator</cite> used to validate instances of the model.</p> </dd></dl> @@ -647,25 +668,11 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b </dd></dl> <dl class="py attribute"> -<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.model_computed_fields"> -<span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.model_computed_fields" title="Link to this definition">¶</a></dt> -<dd><p>A dictionary of computed field names and their corresponding <cite>ComputedFieldInfo</cite> objects.</p> -</dd></dl> - -<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.model_config"> <span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.model_config" title="Link to this definition">¶</a></dt> <dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p> </dd></dl> -<dl class="py attribute"> -<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.model_fields"> -<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'delete':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='<:trashcan:637136429717389331>'),</span> <span class="pre">'first':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⏮'),</span> <span class="pre">'last':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⏭'),</span> <span class="pre">'left':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='⬅'),</span> <span class="pre">'right':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='➡')}</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.model_fields" title="Link to this definition">¶</a></dt> -<dd><p>Metadata about the fields defined on the model, -mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects.</p> -<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p> -</dd></dl> - </dd></dl> </section> @@ -737,10 +744,12 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__class_vars__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__class_vars__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__private_attributes__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_complete__</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_computed_fields__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_computed_fields__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_core_schema__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_custom_init__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_decorators__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_extra__</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_fields__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_fields_set__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_generic_metadata__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_parent_namespace__</span></code></a></li> @@ -749,9 +758,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_serializer__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_validator__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__signature__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__signature__</span></code></a></li> -<li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.model_computed_fields</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.model_config"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.model_config</span></code></a></li> -<li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.model_fields"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.model_fields</span></code></a></li> </ul> </li> </ul> @@ -766,7 +773,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.paste_service.html b/v10.7.0/output/pydis_core.utils.paste_service.html index d0797d62..303e2f4a 100644 --- a/v10.7.0/output/pydis_core.utils.paste_service.html +++ b/v10.7.0/output/pydis_core.utils.paste_service.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>paste_service - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.paste_service.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.paste_service.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.paste_service.html">v11.3.1</a> </li> @@ -460,9 +468,9 @@ <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>content</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – The content of the file.</p></li> -<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – The name of the file to upload. Defaults to <code class="docutils literal notranslate"><span class="pre">""</span></code></p></li> -<li><p><strong>lexer</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – The lexer to use when applying text formatting. Defaults to <code class="docutils literal notranslate"><span class="pre">"python"</span></code></p></li> +<li><p><strong>content</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – The content of the file.</p></li> +<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – The name of the file to upload. Defaults to <code class="docutils literal notranslate"><span class="pre">""</span></code></p></li> +<li><p><strong>lexer</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – The lexer to use when applying text formatting. Defaults to <code class="docutils literal notranslate"><span class="pre">"python"</span></code></p></li> </ul> </dd> </dl> @@ -485,8 +493,14 @@ </dd></dl> <dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.__pydantic_computed_fields__"> +<span class="sig-name descname"><span class="pre">__pydantic_computed_fields__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_computed_fields__" title="Link to this definition">¶</a></dt> +<dd><p>A dictionary of computed field names and their corresponding [<cite>ComputedFieldInfo</cite>][pydantic.fields.ComputedFieldInfo] objects.</p> +</dd></dl> + +<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.__pydantic_core_schema__"> -<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PasteFile'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[functools.partial(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile:94045091357056',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'content':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'lexer':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'python',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'name':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PasteFile',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PasteFile'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.paste_service.PasteFile:94606430026048',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'content':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'lexer':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'python',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'name':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'default':</span> <span class="pre">'',</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'default'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PasteFile',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> <dd><p>The core schema of the model.</p> </dd></dl> @@ -510,6 +524,13 @@ This replaces <cite>Model.__validators__</cite> and <cite>Model.__root_validator </dd></dl> <dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.__pydantic_fields__"> +<span class="sig-name descname"><span class="pre">__pydantic_fields__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'content':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'lexer':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='python'),</span> <span class="pre">'name':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='')}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_fields__" title="Link to this definition">¶</a></dt> +<dd><p>A dictionary of field names and their corresponding [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects. +This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p> +</dd></dl> + +<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.__pydantic_fields_set__"> <span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_fields_set__" title="Link to this definition">¶</a></dt> <dd><p>The names of fields explicitly set during instantiation.</p> @@ -542,13 +563,13 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.__pydantic_serializer__"> -<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000558894436180,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"content":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863a679f0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"lexer":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd86379c370,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd8635044b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"name":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd864956ea0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd8649530c0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">3,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PasteFile",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_serializer__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000560b46a7b940,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"name":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb3b56ea0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdb3b530c0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"content":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb2d6ba30,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"lexer":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb2a45370,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">WithDefault(</span>                                 <span class="pre">WithDefaultSerializer</span> <span class="pre">{</span>                                     <span class="pre">default:</span> <span class="pre">Default(</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdb27b15b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                     <span class="pre">serializer:</span> <span class="pre">Str(</span>                                         <span class="pre">StrSerializer,</span>                                     <span class="pre">),</span>                                 <span class="pre">},</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">3,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PasteFile",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_serializer__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaSerializer</cite> used to dump instances of the model.</p> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.__pydantic_validator__"> -<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PasteFile",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"content",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"content",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85d9965f0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"content",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d9966b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd863a679f0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"name",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"name",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85d996670,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"name",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d996730,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd864956ea0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd8649530c0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd86271e580,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"lexer",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"lexer",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85d9965b0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"lexer",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d996630,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd86379c370,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fd8635044b0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fd86271e580,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PasteFile",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000558894436180,</span>         <span class="pre">),</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fd86271e580,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PasteFile",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_validator__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PasteFile",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"content",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"content",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdac366f30,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"content",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac366e30,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb2d6ba30,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"name",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"name",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdac366df0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"name",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac366eb0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb3b56ea0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdb3b530c0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdb19d23c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"lexer",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"lexer",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdac366d30,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"lexer",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac366e70,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb2a45370,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">WithDefault(</span>                             <span class="pre">WithDefaultValidator</span> <span class="pre">{</span>                                 <span class="pre">default:</span> <span class="pre">Default(</span>                                     <span class="pre">Py(</span>                                         <span class="pre">0x00007fbdb27b15b0,</span>                                     <span class="pre">),</span>                                 <span class="pre">),</span>                                 <span class="pre">on_error:</span> <span class="pre">Raise,</span>                                 <span class="pre">validator:</span> <span class="pre">Str(</span>                                     <span class="pre">StrValidator</span> <span class="pre">{</span>                                         <span class="pre">strict:</span> <span class="pre">false,</span>                                         <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                                     <span class="pre">},</span>                                 <span class="pre">),</span>                                 <span class="pre">validate_default:</span> <span class="pre">false,</span>                                 <span class="pre">copy_default:</span> <span class="pre">false,</span>                                 <span class="pre">name:</span> <span class="pre">"default[str]",</span>                                 <span class="pre">undefined:</span> <span class="pre">Py(</span>                                     <span class="pre">0x00007fbdb19d23c0,</span>                                 <span class="pre">),</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PasteFile",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000560b46a7b940,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fbdb19d23c0,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PasteFile",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_validator__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaValidator</cite> used to validate instances of the model.</p> </dd></dl> @@ -559,25 +580,11 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b </dd></dl> <dl class="py attribute"> -<dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.model_computed_fields"> -<span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.model_computed_fields" title="Link to this definition">¶</a></dt> -<dd><p>A dictionary of computed field names and their corresponding <cite>ComputedFieldInfo</cite> objects.</p> -</dd></dl> - -<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.model_config"> <span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.model_config" title="Link to this definition">¶</a></dt> <dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p> </dd></dl> -<dl class="py attribute"> -<dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteFile.model_fields"> -<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'content':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'lexer':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='python'),</span> <span class="pre">'name':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=False,</span> <span class="pre">default='')}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteFile.model_fields" title="Link to this definition">¶</a></dt> -<dd><p>Metadata about the fields defined on the model, -mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects.</p> -<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p> -</dd></dl> - </dd></dl> <dl class="py class"> @@ -588,8 +595,8 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>link</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – The URL to the saved paste.</p></li> -<li><p><strong>removal</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – The URL to delete the saved paste.</p></li> +<li><p><strong>link</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – The URL to the saved paste.</p></li> +<li><p><strong>removal</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>) – The URL to delete the saved paste.</p></li> </ul> </dd> </dl> @@ -612,8 +619,14 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob </dd></dl> <dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.__pydantic_computed_fields__"> +<span class="sig-name descname"><span class="pre">__pydantic_computed_fields__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_computed_fields__" title="Link to this definition">¶</a></dt> +<dd><p>A dictionary of computed field names and their corresponding [<cite>ComputedFieldInfo</cite>][pydantic.fields.ComputedFieldInfo] objects.</p> +</dd></dl> + +<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.__pydantic_core_schema__"> -<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PasteResponse'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[functools.partial(<function</span> <span class="pre">modify_model_json_schema>,</span> <span class="pre">cls=<class</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse'>,</span> <span class="pre">title=None),</span> <span class="pre"><bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse:94045091381632',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'link':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'removal':</span> <span class="pre">{'metadata':</span> <span class="pre">{'pydantic_js_annotation_functions':</span> <span class="pre">[<function</span> <span class="pre">get_json_schema_update_func.<locals>.json_schema_update_func>],</span> <span class="pre">'pydantic_js_functions':</span> <span class="pre">[]},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PasteResponse',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_core_schema__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[CoreSchema]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'cls':</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse'>,</span> <span class="pre">'config':</span> <span class="pre">{'title':</span> <span class="pre">'PasteResponse'},</span> <span class="pre">'custom_init':</span> <span class="pre">False,</span> <span class="pre">'metadata':</span> <span class="pre">{'pydantic_js_functions':</span> <span class="pre">[<bound</span> <span class="pre">method</span> <span class="pre">BaseModel.__get_pydantic_json_schema__</span> <span class="pre">of</span> <span class="pre"><class</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse'>>]},</span> <span class="pre">'ref':</span> <span class="pre">'pydis_core.utils.paste_service.PasteResponse:94606430020992',</span> <span class="pre">'root_model':</span> <span class="pre">False,</span> <span class="pre">'schema':</span> <span class="pre">{'computed_fields':</span> <span class="pre">[],</span> <span class="pre">'fields':</span> <span class="pre">{'link':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'},</span> <span class="pre">'removal':</span> <span class="pre">{'metadata':</span> <span class="pre">{},</span> <span class="pre">'schema':</span> <span class="pre">{'type':</span> <span class="pre">'str'},</span> <span class="pre">'type':</span> <span class="pre">'model-field'}},</span> <span class="pre">'model_name':</span> <span class="pre">'PasteResponse',</span> <span class="pre">'type':</span> <span class="pre">'model-fields'},</span> <span class="pre">'type':</span> <span class="pre">'model'}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_core_schema__" title="Link to this definition">¶</a></dt> <dd><p>The core schema of the model.</p> </dd></dl> @@ -637,6 +650,13 @@ This replaces <cite>Model.__validators__</cite> and <cite>Model.__root_validator </dd></dl> <dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.__pydantic_fields__"> +<span class="sig-name descname"><span class="pre">__pydantic_fields__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'link':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'removal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_fields__" title="Link to this definition">¶</a></dt> +<dd><p>A dictionary of field names and their corresponding [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects. +This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p> +</dd></dl> + +<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.__pydantic_fields_set__"> <span class="sig-name descname"><span class="pre">__pydantic_fields_set__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">set[str]</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_fields_set__" title="Link to this definition">¶</a></dt> <dd><p>The names of fields explicitly set during instantiation.</p> @@ -669,13 +689,13 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.__pydantic_serializer__"> -<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055889443c180,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"removal":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd85dcdc770,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"link":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd8648ac2a0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">2,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PasteResponse",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_serializer__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_serializer__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaSerializer]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaSerializer(serializer=Model(</span>     <span class="pre">ModelSerializer</span> <span class="pre">{</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000560b46a7a580,</span>         <span class="pre">),</span>         <span class="pre">serializer:</span> <span class="pre">Fields(</span>             <span class="pre">GeneralFieldsSerializer</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">{</span>                     <span class="pre">"link":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb3aac2a0,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                     <span class="pre">"removal":</span> <span class="pre">SerField</span> <span class="pre">{</span>                         <span class="pre">key_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdac681c70,</span>                         <span class="pre">),</span>                         <span class="pre">alias:</span> <span class="pre">None,</span>                         <span class="pre">alias_py:</span> <span class="pre">None,</span>                         <span class="pre">serializer:</span> <span class="pre">Some(</span>                             <span class="pre">Str(</span>                                 <span class="pre">StrSerializer,</span>                             <span class="pre">),</span>                         <span class="pre">),</span>                         <span class="pre">required:</span> <span class="pre">true,</span>                     <span class="pre">},</span>                 <span class="pre">},</span>                 <span class="pre">computed_fields:</span> <span class="pre">Some(</span>                     <span class="pre">ComputedFields(</span>                         <span class="pre">[],</span>                     <span class="pre">),</span>                 <span class="pre">),</span>                 <span class="pre">mode:</span> <span class="pre">SimpleDict,</span>                 <span class="pre">extra_serializer:</span> <span class="pre">None,</span>                 <span class="pre">filter:</span> <span class="pre">SchemaFilter</span> <span class="pre">{</span>                     <span class="pre">include:</span> <span class="pre">None,</span>                     <span class="pre">exclude:</span> <span class="pre">None,</span>                 <span class="pre">},</span>                 <span class="pre">required_fields:</span> <span class="pre">2,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">has_extra:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">name:</span> <span class="pre">"PasteResponse",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[])</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_serializer__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaSerializer</cite> used to dump instances of the model.</p> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.__pydantic_validator__"> -<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PasteResponse",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"link",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"link",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85d9973b0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"link",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d9974b0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd8648ac2a0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"removal",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"removal",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fd85d997370,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"removal",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fd85d9972f0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fd85dcdc770,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PasteResponse",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x000055889443c180,</span>         <span class="pre">),</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fd86271e580,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PasteResponse",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_validator__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__pydantic_validator__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[SchemaValidator</span> <span class="pre">|</span> <span class="pre">PluggableSchemaValidator]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SchemaValidator(title="PasteResponse",</span> <span class="pre">validator=Model(</span>     <span class="pre">ModelValidator</span> <span class="pre">{</span>         <span class="pre">revalidate:</span> <span class="pre">Never,</span>         <span class="pre">validator:</span> <span class="pre">ModelFields(</span>             <span class="pre">ModelFieldsValidator</span> <span class="pre">{</span>                 <span class="pre">fields:</span> <span class="pre">[</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"link",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"link",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdac3677f0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"link",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac3673f0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdb3aac2a0,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                     <span class="pre">Field</span> <span class="pre">{</span>                         <span class="pre">name:</span> <span class="pre">"removal",</span>                         <span class="pre">lookup_key:</span> <span class="pre">Simple</span> <span class="pre">{</span>                             <span class="pre">key:</span> <span class="pre">"removal",</span>                             <span class="pre">py_key:</span> <span class="pre">Py(</span>                                 <span class="pre">0x00007fbdac367bf0,</span>                             <span class="pre">),</span>                             <span class="pre">path:</span> <span class="pre">LookupPath(</span>                                 <span class="pre">[</span>                                     <span class="pre">S(</span>                                         <span class="pre">"removal",</span>                                         <span class="pre">Py(</span>                                             <span class="pre">0x00007fbdac367fb0,</span>                                         <span class="pre">),</span>                                     <span class="pre">),</span>                                 <span class="pre">],</span>                             <span class="pre">),</span>                         <span class="pre">},</span>                         <span class="pre">name_py:</span> <span class="pre">Py(</span>                             <span class="pre">0x00007fbdac681c70,</span>                         <span class="pre">),</span>                         <span class="pre">validator:</span> <span class="pre">Str(</span>                             <span class="pre">StrValidator</span> <span class="pre">{</span>                                 <span class="pre">strict:</span> <span class="pre">false,</span>                                 <span class="pre">coerce_numbers_to_str:</span> <span class="pre">false,</span>                             <span class="pre">},</span>                         <span class="pre">),</span>                         <span class="pre">frozen:</span> <span class="pre">false,</span>                     <span class="pre">},</span>                 <span class="pre">],</span>                 <span class="pre">model_name:</span> <span class="pre">"PasteResponse",</span>                 <span class="pre">extra_behavior:</span> <span class="pre">Ignore,</span>                 <span class="pre">extras_validator:</span> <span class="pre">None,</span>                 <span class="pre">strict:</span> <span class="pre">false,</span>                 <span class="pre">from_attributes:</span> <span class="pre">false,</span>                 <span class="pre">loc_by_alias:</span> <span class="pre">true,</span>             <span class="pre">},</span>         <span class="pre">),</span>         <span class="pre">class:</span> <span class="pre">Py(</span>             <span class="pre">0x0000560b46a7a580,</span>         <span class="pre">),</span>         <span class="pre">generic_origin:</span> <span class="pre">None,</span>         <span class="pre">post_init:</span> <span class="pre">None,</span>         <span class="pre">frozen:</span> <span class="pre">false,</span>         <span class="pre">custom_init:</span> <span class="pre">false,</span>         <span class="pre">root_model:</span> <span class="pre">false,</span>         <span class="pre">undefined:</span> <span class="pre">Py(</span>             <span class="pre">0x00007fbdb19d23c0,</span>         <span class="pre">),</span>         <span class="pre">name:</span> <span class="pre">"PasteResponse",</span>     <span class="pre">},</span> <span class="pre">),</span> <span class="pre">definitions=[],</span> <span class="pre">cache_strings=True)</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_validator__" title="Link to this definition">¶</a></dt> <dd><p>The <cite>pydantic-core</cite> <cite>SchemaValidator</cite> used to validate instances of the model.</p> </dd></dl> @@ -686,45 +706,31 @@ __args__, __origin__, __parameters__ in typing-module generics. May eventually b </dd></dl> <dl class="py attribute"> -<dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.model_computed_fields"> -<span class="sig-name descname"><span class="pre">model_computed_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">ComputedFieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.model_computed_fields" title="Link to this definition">¶</a></dt> -<dd><p>A dictionary of computed field names and their corresponding <cite>ComputedFieldInfo</cite> objects.</p> -</dd></dl> - -<dl class="py attribute"> <dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.model_config"> <span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[ConfigDict]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.model_config" title="Link to this definition">¶</a></dt> <dd><p>Configuration for the model, should be a dictionary conforming to [<cite>ConfigDict</cite>][pydantic.config.ConfigDict].</p> </dd></dl> -<dl class="py attribute"> -<dt class="sig sig-object py" id="pydis_core.utils.paste_service.PasteResponse.model_fields"> -<span class="sig-name descname"><span class="pre">model_fields</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Dict[str,</span> <span class="pre">FieldInfo]]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'link':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True),</span> <span class="pre">'removal':</span> <span class="pre">FieldInfo(annotation=str,</span> <span class="pre">required=True)}</span></em><a class="headerlink" href="#pydis_core.utils.paste_service.PasteResponse.model_fields" title="Link to this definition">¶</a></dt> -<dd><p>Metadata about the fields defined on the model, -mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] objects.</p> -<p>This replaces <cite>Model.__fields__</cite> from Pydantic V1.</p> -</dd></dl> - </dd></dl> <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/07f517225fc59157233f74edb136ee39046fda00/pydis_core/utils/paste_service.py#L55-L57"><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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><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/07f517225fc59157233f74edb136ee39046fda00/pydis_core/utils/paste_service.py#L51-L53"><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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><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/07f517225fc59157233f74edb136ee39046fda00/pydis_core/utils/paste_service.py#L47-L49"><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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><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> @@ -735,15 +741,15 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>files</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>[<a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile" title="pydis_core.utils.paste_service.PasteFile"><code class="xref py py-class docutils literal notranslate"><span class="pre">PasteFile</span></code></a>]</span>) – The files to be uploaded to the paste service.</p></li> -<li><p><strong>http_session</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.10)"><em>aiohttp.ClientSession</em></a>) – The session to use when POSTing the content to the paste service.</p></li> -<li><p><strong>paste_url</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The base url to the paste service.</p></li> -<li><p><strong>max_size</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The max number of bytes to be allowed. Anything larger than <a class="reference internal" href="#pydis_core.utils.paste_service.MAX_PASTE_SIZE" title="pydis_core.utils.paste_service.MAX_PASTE_SIZE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MAX_PASTE_SIZE</span></code></a> will be rejected.</p></li> +<li><p><strong>files</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a>[<a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile" title="pydis_core.utils.paste_service.PasteFile"><code class="xref py py-class docutils literal notranslate"><span class="pre">PasteFile</span></code></a>]</span>) – The files to be uploaded to the paste service.</p></li> +<li><p><strong>http_session</strong> (<a class="reference external" href="https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession" title="(in aiohttp v3.11)"><em>aiohttp.ClientSession</em></a>) – The session to use when POSTing the content to the paste service.</p></li> +<li><p><strong>paste_url</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The base url to the paste service.</p></li> +<li><p><strong>max_size</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></span>) – The max number of bytes to be allowed. Anything larger than <a class="reference internal" href="#pydis_core.utils.paste_service.MAX_PASTE_SIZE" title="pydis_core.utils.paste_service.MAX_PASTE_SIZE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MAX_PASTE_SIZE</span></code></a> will be rejected.</p></li> </ul> </dd> <dt class="field-even">Raises<span class="colon">:</span></dt> <dd class="field-even"><ul class="simple"> -<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><strong>ValueError</strong></a> – <code class="docutils literal notranslate"><span class="pre">max_length</span></code> greater than the maximum allowed by the paste service.</p></li> +<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – <code class="docutils literal notranslate"><span class="pre">max_length</span></code> greater than the maximum allowed by the paste service.</p></li> <li><p><a class="reference internal" href="#pydis_core.utils.paste_service.PasteTooLongError" title="pydis_core.utils.paste_service.PasteTooLongError"><strong>PasteTooLongError</strong></a> – <code class="docutils literal notranslate"><span class="pre">contents</span></code> too long to upload.</p></li> <li><p><a class="reference internal" href="#pydis_core.utils.paste_service.PasteUploadError" title="pydis_core.utils.paste_service.PasteUploadError"><strong>PasteUploadError</strong></a> – Uploading failed.</p></li> </ul> @@ -820,10 +826,12 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__class_vars__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__class_vars__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__private_attributes__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_complete__</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_computed_fields__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_computed_fields__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_core_schema__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_custom_init__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_decorators__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_extra__</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_fields__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_fields__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_fields_set__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_generic_metadata__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_parent_namespace__</span></code></a></li> @@ -832,19 +840,19 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_serializer__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__pydantic_validator__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.__signature__"><code class="docutils literal notranslate"><span class="pre">PasteFile.__signature__</span></code></a></li> -<li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">PasteFile.model_computed_fields</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.model_config"><code class="docutils literal notranslate"><span class="pre">PasteFile.model_config</span></code></a></li> -<li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteFile.model_fields"><code class="docutils literal notranslate"><span class="pre">PasteFile.model_fields</span></code></a></li> </ul> </li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse"><code class="docutils literal notranslate"><span class="pre">PasteResponse</span></code></a><ul> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__class_vars__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__class_vars__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__private_attributes__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__private_attributes__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_complete__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_complete__</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_computed_fields__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_computed_fields__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_core_schema__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_core_schema__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_custom_init__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_custom_init__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_decorators__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_decorators__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_extra__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_extra__</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_fields__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_fields__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_fields_set__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_fields_set__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_generic_metadata__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_generic_metadata__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_parent_namespace__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_parent_namespace__</span></code></a></li> @@ -853,9 +861,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_serializer__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_serializer__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__pydantic_validator__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__pydantic_validator__</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.__signature__"><code class="docutils literal notranslate"><span class="pre">PasteResponse.__signature__</span></code></a></li> -<li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">PasteResponse.model_computed_fields</span></code></a></li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.model_config"><code class="docutils literal notranslate"><span class="pre">PasteResponse.model_config</span></code></a></li> -<li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteResponse.model_fields"><code class="docutils literal notranslate"><span class="pre">PasteResponse.model_fields</span></code></a></li> </ul> </li> <li><a class="reference internal" href="#pydis_core.utils.paste_service.PasteTooLongError"><code class="docutils literal notranslate"><span class="pre">PasteTooLongError</span></code></a></li> @@ -874,7 +880,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo] ob </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.regex.html b/v10.7.0/output/pydis_core.utils.regex.html index c95b5039..cc545a5b 100644 --- a/v10.7.0/output/pydis_core.utils.regex.html +++ b/v10.7.0/output/pydis_core.utils.regex.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>regex - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.regex.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.regex.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.regex.html">v11.3.1</a> </li> @@ -455,7 +463,7 @@ <p class="admonition-title">Warning</p> <p>This regex pattern will capture until a whitespace, if you are to use the ‘invite’ capture group in any HTTP requests or similar. Please ensure you sanitise the output using something -such as <a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">urllib.parse.quote()</span></code></a>.</p> +such as <a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">urllib.parse.quote()</span></code></a>.</p> </div> <dl class="field-list simple"> </dl> @@ -550,7 +558,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=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> diff --git a/v10.7.0/output/pydis_core.utils.scheduling.html b/v10.7.0/output/pydis_core.utils.scheduling.html index 642711d6..bc18d0cf 100644 --- a/v10.7.0/output/pydis_core.utils.scheduling.html +++ b/v10.7.0/output/pydis_core.utils.scheduling.html @@ -5,13 +5,13 @@ <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="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 8.0.2 and Furo 2024.08.06 --> + <link rel="shortcut icon" href="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>scheduling - Pydis Core v10.7.0</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=302659d7" /> - <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/logo.css?v=41ebe54c" /> <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -324,6 +324,14 @@ </li> <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.5.0/output/pydis_core.utils.scheduling.html">v11.5.0</a> + </li> + + <li class="toctree-l2 "> + <a class="version_link reference internal" href="../../v11.4.0/output/pydis_core.utils.scheduling.html">v11.4.0</a> + </li> + + <li class="toctree-l2 "> <a class="version_link reference internal" href="../../v11.3.1/output/pydis_core.utils.scheduling.html">v11.3.1</a> </li> @@ -450,7 +458,7 @@ <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/07f517225fc59157233f74edb136ee39046fda00/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> +<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><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 instance’s log messages from other instances. Using the name of the class or module containing @@ -464,16 +472,16 @@ the same ID used to schedule it.</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/07f517225fc59157233f74edb136ee39046fda00/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> +<dd><p>Return <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.13)"><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> -<dd class="field-odd"><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – The task to look for.</p> +<dd class="field-odd"><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – The task to look for.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p> </dd> <dt class="field-odd">Returns<span class="colon">:</span></dt> -<dd class="field-odd"><p><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 the task was found.</p> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> if the task was found.</p> </dd> </dl> </dd></dl> @@ -484,7 +492,7 @@ the same ID used to schedule it.</p> <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> -<dd class="field-odd"><p><strong>name</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the <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>. Used in logging, and namespacing.</p> +<dd class="field-odd"><p><strong>name</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the <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>. Used in logging, and namespacing.</p> </dd> </dl> </dd></dl> @@ -495,10 +503,10 @@ the same ID used to schedule it.</p> <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> -<dd class="field-odd"><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – The task’s unique ID.</p> +<dd class="field-odd"><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – The task’s unique ID.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -509,7 +517,7 @@ the same ID used to schedule it.</p> <dd><p>Unschedule all known tasks.</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 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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -523,12 +531,12 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – A unique ID to create the task with.</p></li> -<li><p><strong>coroutine</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a></span>) – The function to be called.</p></li> +<li><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – A unique ID to create the task with.</p></li> +<li><p><strong>coroutine</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a></span>) – The function to be called.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -545,13 +553,13 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>time</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></a></span>) – The time to start the task.</p></li> -<li><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – A unique ID to create the task with.</p></li> -<li><p><strong>coroutine</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a></span>) – The function to be called.</p></li> +<li><p><strong>time</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></a></span>) – The time to start the task.</p></li> +<li><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – A unique ID to create the task with.</p></li> +<li><p><strong>coroutine</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a></span>) – The function to be called.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -565,13 +573,13 @@ prevents unawaited coroutine warnings. Don’t pass a coroutine that’ll be re- <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>delay</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></span>) – How long to wait before starting the task.</p></li> -<li><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – A unique ID to create the task with.</p></li> -<li><p><strong>coroutine</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a></span>) – The function to be called.</p></li> +<li><p><strong>delay</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></a></span>) – How long to wait before starting the task.</p></li> +<li><p><strong>task_id</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Hashable</span></code></a></span>) – A unique ID to create the task with.</p></li> +<li><p><strong>coroutine</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a></span>) – The function to be called.</p></li> </ul> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> -<dd class="field-even"><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 class="field-even"><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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p> </dd> </dl> </dd></dl> @@ -581,23 +589,23 @@ 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/07f517225fc59157233f74edb136ee39046fda00/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> +<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.13)"><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> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> -<li><p><strong>coro</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">TASK_RETURN</span></code>)]</span>) – The function to call.</p></li> -<li><p><strong>suppressed_exceptions</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a>[<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>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#Ellipsis" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">...</span></code></a>]</span>) – Exceptions to be handled by the task.</p></li> -<li><p><strong>event_loop</strong> (<a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.AbstractEventLoop" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.AbstractEventLoop</span></code></a>) – The loop to create the task from.</p></li> -<li><p><strong>kwargs</strong> – Passed to <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.create_task" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">asyncio.create_task()</span></code></a>.</p></li> +<li><p><strong>coro</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coroutine</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.TypeVar" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code></a>(<code class="docutils literal notranslate"><span class="pre">TASK_RETURN</span></code>)]</span>) – The function to call.</p></li> +<li><p><strong>suppressed_exceptions</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#Ellipsis" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">...</span></code></a>]</span>) – Exceptions to be handled by the task.</p></li> +<li><p><strong>event_loop</strong> (<a class="reference external" href="https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.AbstractEventLoop" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio.AbstractEventLoop</span></code></a>) – The loop to create the task from.</p></li> +<li><p><strong>kwargs</strong> – Passed to <a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.create_task" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">asyncio.create_task()</span></code></a>.</p></li> </ul> </dd> <dt class="field-even">Returns<span class="colon">:</span></dt> <dd class="field-even"><p>The wrapped task.</p> </dd> <dt class="field-odd">Return type<span class="colon">:</span></dt> -<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.12)">asyncio.Task</a></p> +<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/asyncio-task.html#asyncio.Task" title="(in Python v3.13)">asyncio.Task</a></p> </dd> </dl> </dd></dl> @@ -683,7 +691,7 @@ otherwise the running loop is used.</p> </aside> </div> </div><script src="../_static/documentation_options.js?v=ccd73373"></script> - <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> <script src="../_static/changelog.js?v=11ff7913"></script> |