diff options
Diffstat (limited to 'main/output/pydis_core.utils.pagination.html')
| -rw-r--r-- | main/output/pydis_core.utils.pagination.html | 139 |
1 files changed, 123 insertions, 16 deletions
diff --git a/main/output/pydis_core.utils.pagination.html b/main/output/pydis_core.utils.pagination.html index a8e71de9..589a4ca6 100644 --- a/main/output/pydis_core.utils.pagination.html +++ b/main/output/pydis_core.utils.pagination.html @@ -5,14 +5,14 @@ <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 7.4.7 and Furo 2024.07.18 --> - <title>pagination - Pydis Core Latest (11.3.1)</title> + <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 --> + <title>pagination - Pydis Core Latest (11.4.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=613ab9ff" /> + <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/index.css?v=832e2368" /> <link rel="stylesheet" type="text/css" href="../_static/changelog.css?v=117bb91a" /> + <link rel="stylesheet" type="text/css" href="../_static/index.css?v=832e2368" /> @@ -170,7 +170,7 @@ </label> </div> <div class="header-center"> - <a href="../index.html"><div class="brand">Pydis Core Latest (11.3.1)</div></a> + <a href="../index.html"><div class="brand">Pydis Core Latest (11.4.0)</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> @@ -197,7 +197,7 @@ <img class="sidebar-logo" src="https://raw.githubusercontent.com/python-discord/branding/main/logos/logo_full/logo_full.min.svg" alt="Logo"/> </div> - <span class="sidebar-brand-text">Pydis Core Latest (11.3.1)</span> + <span class="sidebar-brand-text">Pydis Core Latest (11.4.0)</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> @@ -455,14 +455,14 @@ <span id="pagination"></span><h1>pagination<a class="headerlink" href="#module-pydis_core.utils.pagination" title="Link to this heading">¶</a></h1> <dl class="py exception"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.EmptyPaginatorEmbedError"> -<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/aa8f868ec5fb436a5e199ccdb4df25abeb3df108/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.EmptyPaginatorEmbedError" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">EmptyPaginatorEmbedError</span></span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/06b1ada5772490e18a7ab1b96d0582b1222121b4/pydis_core/utils/pagination.py#L26-L28"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.EmptyPaginatorEmbedError" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p> <p>Raised when attempting to paginate with empty contents.</p> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/aa8f868ec5fb436a5e199ccdb4df25abeb3df108/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">LinePaginator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/06b1ada5772490e18a7ab1b96d0582b1222121b4/pydis_core/utils/pagination.py#L30-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Paginator" title="(in discord.py v2.5.0a)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Paginator</span></code></a></p> <p>A class that aids in paginating code blocks for Discord messages.</p> <dl class="field-list simple"> @@ -479,14 +479,14 @@ </dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator.__init__"> -<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/aa8f868ec5fb436a5e199ccdb4df25abeb3df108/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.__init__" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'```'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">linesep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'\\n'</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/06b1ada5772490e18a7ab1b96d0582b1222121b4/pydis_core/utils/pagination.py#L43-L81"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.__init__" title="Link to this definition">¶</a></dt> <dd><p>This function overrides the Paginator.__init__ from inside discord.ext.commands.</p> <p>It overrides in order to allow us to configure the maximum number of lines per page.</p> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator.add_line"> -<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/aa8f868ec5fb436a5e199ccdb4df25abeb3df108/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.add_line" title="Link to this definition">¶</a></dt> +<span class="sig-name descname"><span class="pre">add_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">line</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/06b1ada5772490e18a7ab1b96d0582b1222121b4/pydis_core/utils/pagination.py#L82-L134"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.add_line" title="Link to this definition">¶</a></dt> <dd><p>Adds a line to the current page.</p> <p>If a line on a page exceeds <cite>max_size</cite> characters, then <cite>max_size</cite> will go up to <cite>scale_to_size</cite> for a single line before creating a new page for the overflow words. If it @@ -514,7 +514,7 @@ page at a reasonable size.</p> <dl class="py method"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.LinePaginator.paginate"> -<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restrict_to_user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exception_on_empty_embed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/aa8f868ec5fb436a5e199ccdb4df25abeb3df108/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.paginate" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">async</span><span class="w"> </span><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">paginate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pagination_emojis</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">embed</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_lines</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">500</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scale_to_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">4000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restrict_to_user</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">300</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">footer_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exception_on_empty_embed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_roles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/06b1ada5772490e18a7ab1b96d0582b1222121b4/pydis_core/utils/pagination.py#L189-L398"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.LinePaginator.paginate" title="Link to this definition">¶</a></dt> <dd><p>Use a paginator and set of reactions to provide pagination over a set of lines.</p> <p>The reactions are used to switch page, or to finish with pagination.</p> <p>When used, this will send a message using <cite>ctx.send()</cite> and apply a set of reactions to it. These reactions may @@ -558,12 +558,104 @@ to any user with a moderation role.</p> <dl class="py class"> <dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis"> -<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PaginationEmojis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/aa8f868ec5fb436a5e199ccdb4df25abeb3df108/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis" title="Link to this definition">¶</a></dt> +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">PaginationEmojis</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/python-discord/bot-core/blob/06b1ada5772490e18a7ab1b96d0582b1222121b4/pydis_core/utils/pagination.py#L16-L24"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis" title="Link to this definition">¶</a></dt> <dd><p>Bases: <a class="reference external" href="https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel" title="(in Pydantic v0.0.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></a></p> <p>The emojis that will be used for pagination.</p> <dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__class_vars__"> +<span class="sig-name descname"><span class="pre">__class_vars__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[set[str]]</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.__class_vars__" title="Link to this definition">¶</a></dt> +<dd><p>The names of the class variables defined on the model.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__private_attributes__"> +<span class="sig-name descname"><span class="pre">__private_attributes__</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">ModelPrivateAttr]]</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.__private_attributes__" title="Link to this definition">¶</a></dt> +<dd><p>Metadata about the private attributes of the model.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_complete__"> +<span class="sig-name descname"><span class="pre">__pydantic_complete__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_complete__" title="Link to this definition">¶</a></dt> +<dd><p>Whether model building is completed, or if there are still undefined fields.</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:94590386861776',</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> +<dd><p>The core schema of the model.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_custom_init__"> +<span class="sig-name descname"><span class="pre">__pydantic_custom_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[bool]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">False</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_custom_init__" title="Link to this definition">¶</a></dt> +<dd><p>Whether the model has a custom <cite>__init__</cite> method.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_decorators__"> +<span class="sig-name descname"><span class="pre">__pydantic_decorators__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_decorators.DecoratorInfos]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DecoratorInfos(validators={},</span> <span class="pre">field_validators={},</span> <span class="pre">root_validators={},</span> <span class="pre">field_serializers={},</span> <span class="pre">model_serializers={},</span> <span class="pre">model_validators={},</span> <span class="pre">computed_fields={})</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_decorators__" title="Link to this definition">¶</a></dt> +<dd><p>Metadata containing the decorators defined on the model. +This replaces <cite>Model.__validators__</cite> and <cite>Model.__root_validators__</cite> from Pydantic V1.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_extra__"> +<span class="sig-name descname"><span class="pre">__pydantic_extra__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_extra__" title="Link to this definition">¶</a></dt> +<dd><p>A dictionary containing extra values, if [<cite>extra</cite>][pydantic.config.ConfigDict.extra] is set to <cite>‘allow’</cite>.</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> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_generic_metadata__"> +<span class="sig-name descname"><span class="pre">__pydantic_generic_metadata__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[_generics.PydanticGenericMetadata]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'args':</span> <span class="pre">(),</span> <span class="pre">'origin':</span> <span class="pre">None,</span> <span class="pre">'parameters':</span> <span class="pre">()}</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_generic_metadata__" title="Link to this definition">¶</a></dt> +<dd><p>Metadata for generic models; contains data used for a similar purpose to +__args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_parent_namespace__"> +<span class="sig-name descname"><span class="pre">__pydantic_parent_namespace__</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">Any]</span> <span class="pre">|</span> <span class="pre">None]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_parent_namespace__" title="Link to this definition">¶</a></dt> +<dd><p>Parent namespace of the model, used for automatic rebuilding of models.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_post_init__"> +<span class="sig-name descname"><span class="pre">__pydantic_post_init__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[None</span> <span class="pre">|</span> <span class="pre">Literal['model_post_init']]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_post_init__" title="Link to this definition">¶</a></dt> +<dd><p>The name of the post-init method for the model, if defined.</p> +</dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__pydantic_private__"> +<span class="sig-name descname"><span class="pre">__pydantic_private__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">Any]</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_private__" title="Link to this definition">¶</a></dt> +<dd><p>Values of private attributes set on the model instance.</p> +</dd></dl> + +<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">0x000056078a6876d0,</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">0x00007f14f1179730,</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">0x00007f14ed71e150,</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">0x00007f14f1560eb0,</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">0x00007f14ed71e290,</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">0x00007f14f11796f0,</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">0x00007f14ed71e1f0,</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">0x00007f14f11f48b0,</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">0x00007f14ed71e1a0,</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">0x00007f14f11d2270,</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">0x00007f14ed71e240,</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">0x00007f14ed9c4730,</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">0x00007f14edbbacf0,</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">0x00007f14f11f48b0,</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">0x00007f14ed71e1a0,</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">0x00007f14efa1df60,</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">0x00007f14ec606270,</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">0x00007f14ec604470,</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">0x00007f14f1179730,</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">0x00007f14ed71e150,</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">0x00007f14efa1df60,</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">0x00007f14ec607f30,</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">0x00007f14ec607e70,</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">0x00007f14f11796f0,</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">0x00007f14ed71e1f0,</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">0x00007f14efa1df60,</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">0x00007f14ec605ef0,</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">0x00007f14ec6047f0,</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">0x00007f14f11d2270,</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">0x00007f14ed71e240,</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">0x00007f14efa1df60,</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">0x00007f14ec604b30,</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">0x00007f14ec607bf0,</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">0x00007f14f1560eb0,</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">0x00007f14ed71e290,</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">0x00007f14efa1df60,</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">0x000056078a6876d0,</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">0x00007f14efa1df60,</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> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="pydis_core.utils.pagination.PaginationEmojis.__signature__"> +<span class="sig-name descname"><span class="pre">__signature__</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar[Signature]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre"><Signature</span> <span class="pre">(*,</span> <span class="pre">first:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'⏮',</span> <span class="pre">left:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'⬅',</span> <span class="pre">right:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'➡',</span> <span class="pre">last:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'⏭',</span> <span class="pre">delete:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'<:trashcan:637136429717389331>')</span> <span class="pre">-></span> <span class="pre">None></span></em><a class="headerlink" href="#pydis_core.utils.pagination.PaginationEmojis.__signature__" title="Link to this definition">¶</a></dt> +<dd><p>The synthesized <cite>__init__</cite> [<cite>Signature</cite>][inspect.Signature] of the model.</p> +</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> +<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> @@ -575,9 +667,9 @@ to any user with a moderation role.</p> <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> +<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].</p> +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> @@ -649,6 +741,21 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</ </ul> </li> <li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis</span></code></a><ul> +<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_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_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> +<li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_post_init__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_post_init__</span></code></a></li> +<li><a class="reference internal" href="#pydis_core.utils.pagination.PaginationEmojis.__pydantic_private__"><code class="docutils literal notranslate"><span class="pre">PaginationEmojis.__pydantic_private__</span></code></a></li> +<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> @@ -665,7 +772,7 @@ mapping of field names to [<cite>FieldInfo</cite>][pydantic.fields.FieldInfo].</ </aside> </div> -</div><script src="../_static/documentation_options.js?v=f82eed50"></script> +</div><script src="../_static/documentation_options.js?v=d20d9887"></script> <script src="../_static/doctools.js?v=9a2dae69"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/scripts/furo.js?v=5fa4622c"></script> |